Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / b8c038a3e7742f32915d7f1ab69627075e8d0c39 / . / user_guide / database / configuration.html
blob: bbdd0a3c02427d23812331a7192d8d208e623c4d [file] [log] [blame]
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
3<head>
4
5<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6<title>Database Configuration : CodeIgniter User Guide</title>
7
8<style type='text/css' media='all'>@import url('../userguide.css');</style>
9<link rel='stylesheet' type='text/css' media='all' href='../userguide.css' />
10
11<script type="text/javascript" src="../nav/nav.js"></script>
12<script type="text/javascript" src="../nav/prototype.lite.js"></script>
13<script type="text/javascript" src="../nav/moo.fx.js"></script>
14<script type="text/javascript" src="../nav/user_guide_menu.js"></script>
15
16<meta http-equiv='expires' content='-1' />
17<meta http-equiv= 'pragma' content='no-cache' />
18<meta name='robots' content='all' />
19<meta name='author' content='ExpressionEngine Dev Team' />
20<meta name='description' content='CodeIgniter User Guide' />
21
22</head>
23<body>
24
25<!-- START NAVIGATION -->
26<div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div>
27<div id="nav2"><a name="top"></a><a href="javascript:void(0);" onclick="myHeight.toggle();"><img src="../images/nav_toggle_darker.jpg" width="154" height="43" border="0" title="Toggle Table of Contents" alt="Toggle Table of Contents" /></a></div>
28<div id="masthead">
29<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
30<tr>
Derek Jonesb8c038a2011-08-20 08:57:14 -0500[diff] [blame^]31<td><h1>CodeIgniter User Guide Version 2.0.3</h1></td>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]32<td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
33</tr>
34</table>
35</div>
36<!-- END NAVIGATION -->
37
38
39<!-- START BREADCRUMB -->
40<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
41<tr>
42<td id="breadcrumb">
43<a href="http://codeigniter.com/">CodeIgniter Home</a> &nbsp;&#8250;&nbsp;
44<a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
45<a href="index.html">Database Library</a> &nbsp;&#8250;&nbsp;
46Configuration
47</td>
48<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="codeigniter.com/user_guide/" />Search User Guide&nbsp; <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" />&nbsp;<input type="submit" class="submit" name="sa" value="Go" /></form></td>
49</tr>
50</table>
51<!-- END BREADCRUMB -->
52
53
54<br clear="all" />
55
56
57<!-- START CONTENT -->
58<div id="content">
59
60
61<h1>Database Configuration</h1>
62
63<p>CodeIgniter has a config file that lets you store your database connection values (username, password, database name, etc.).
joelcox42aa95b2011-01-16 18:16:21 +0100[diff] [blame]64The config file is located at <samp>application/config/database.php</samp>. You can also set database connection values for specific <a href="../libraries/config.html">environments</a> by placing <strong>database.php</strong> it the respective environment config folder.</p>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]65
66<p>The config settings are stored in a multi-dimensional array with this prototype:</p>
67
68<code>$db['default']['hostname'] = "localhost";<br />
69$db['default']['username'] = "root";<br />
70$db['default']['password'] = "";<br />
71$db['default']['database'] = "database_name";<br />
72$db['default']['dbdriver'] = "mysql";<br />
73$db['default']['dbprefix'] = "";<br />
74$db['default']['pconnect'] = TRUE;<br />
75$db['default']['db_debug'] = FALSE;<br />
76$db['default']['cache_on'] = FALSE;<br />
Derek Jones4b9c6292011-07-01 17:40:48 -0500[diff] [blame]77$db['default']['cachedir'] = &quot;&quot;;<br />
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]78$db['default']['char_set'] = "utf8";<br />
Derek Jonesad1171a2010-03-10 14:18:38 -0600[diff] [blame]79$db['default']['dbcollat'] = "utf8_general_ci";<br />
80$db['default']['swap_pre'] = "";<br />
81$db['default']['autoinit'] = TRUE;<br />
82$db['default']['stricton'] = FALSE;</code>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]83
84<p>The reason we use a multi-dimensional array rather than a more simple one is to permit you to optionally store
Derek Jones4b9c6292011-07-01 17:40:48 -0500[diff] [blame]85multiple sets of connection values. If, for example, you run multiple environments (development, production, test, etc.)
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]86under a single installation, you can set up a connection group for each, then switch between groups as needed.
87For example, to set up a "test" environment you would do this:</p>
88
89<code>$db['test']['hostname'] = "localhost";<br />
90$db['test']['username'] = "root";<br />
91$db['test']['password'] = "";<br />
92$db['test']['database'] = "database_name";<br />
93$db['test']['dbdriver'] = "mysql";<br />
94$db['test']['dbprefix'] = "";<br />
95$db['test']['pconnect'] = TRUE;<br />
96$db['test']['db_debug'] = FALSE;<br />
97$db['test']['cache_on'] = FALSE;<br />
Derek Jones4b9c6292011-07-01 17:40:48 -0500[diff] [blame]98$db['test']['cachedir'] = &quot;&quot;;<br />
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]99$db['test']['char_set'] = "utf8";<br />
Derek Jonesad1171a2010-03-10 14:18:38 -0600[diff] [blame]100$db['test']['dbcollat'] = "utf8_general_ci";<br />
101$db['test']['swap_pre'] = "";<br />
102$db['test']['autoinit'] = TRUE;<br />
103$db['test']['stricton'] = FALSE;</code>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]104
105
106<p>Then, to globally tell the system to use that group you would set this variable located in the config file:</p>
107
108<code>$active_group = "test";</code>
109
Derek Jones4b9c6292011-07-01 17:40:48 -0500[diff] [blame]110<p>Note: The name "test" is arbitrary. It can be anything you want. By default we've used the word "default"
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]111for the primary connection, but it too can be renamed to something more relevant to your project.</p>
112
113<h3>Active Record</h3>
114
115<p>The <a href="active_record.html">Active Record Class</a> is globally enabled or disabled by setting the $active_record variable in the database configuration file to TRUE/FALSE (boolean). If you are not using the active record class, setting it to FALSE will utilize fewer resources when the database classes are initialized.</p>
116
117<code>$active_record = TRUE;</code>
118
119<p class="important"><strong>Note:</strong> that some CodeIgniter classes such as Sessions require Active Records be enabled to access certain functionality.</p>
120
121<h3>Explanation of Values:</h3>
122
123<ul>
124<li><strong>hostname</strong> - The hostname of your database server. Often this is "localhost".</li>
125<li><strong>username</strong> - The username used to connect to the database.</li>
126<li><strong>password</strong> - The password used to connect to the database.</li>
127<li><strong>database</strong> - The name of the database you want to connect to.</li>
128<li><strong>dbdriver</strong> - The database type. ie: mysql, postgres, odbc, etc. Must be specified in lower case.</li>
Derek Jones4b9c6292011-07-01 17:40:48 -0500[diff] [blame]129<li><strong>dbprefix</strong> - An optional table prefix which will added to the table name when running <a href="active_record.html">Active Record</a> queries. This permits multiple CodeIgniter installations to share one database.</li>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]130<li><strong>pconnect</strong> - TRUE/FALSE (boolean) - Whether to use a persistent connection.</li>
131<li><strong>db_debug</strong> - TRUE/FALSE (boolean) - Whether database errors should be displayed.</li>
132<li><strong>cache_on</strong> - TRUE/FALSE (boolean) - Whether database query caching is enabled, see also <a href="caching.html">Database Caching Class</a>.</li>
133<li><strong>cachedir</strong> - The absolute server path to your database query cache directory.</li>
134<li><strong>char_set</strong> - The character set used in communicating with the database.</li>
Derek Jones4b9c6292011-07-01 17:40:48 -0500[diff] [blame]135<li><strong>dbcollat</strong> - The character collation used in communicating with the database. <p class="important"><strong>Note:</strong> For MySQL and MySQLi databases, this setting is only used as a backup if your server is running PHP &lt; 5.2.3 or MySQL &lt; 5.0.7. There is an incompatibility in PHP with mysql_real_escape_string() which can make your site vulnerable to SQL injection if you are using a multi-byte character set and are running versions lower than these. Sites using Latin-1 or UTF-8 database character set and collation are unaffected.</p></li>
136<li><strong>swap_pre</strong> - A default table prefix that should be swapped with <var>dbprefix</var>. This is useful for distributed applications where you might run manually written queries, and need the prefix to still be customizable by the end user.</li>
katzgrau5fd02672011-02-02 16:33:05 -0500[diff] [blame]137<li><strong>autoinit</strong> - Whether or not to automatically connect to the database when the library loads. If set to false, the connection will take place prior to executing the first query.</li>
Derek Jonesad1171a2010-03-10 14:18:38 -0600[diff] [blame]138<li><strong>stricton</strong> - TRUE/FALSE (boolean) - Whether to force "Strict Mode" connections, good for ensuring strict SQL while developing an application.</li>
Derek Jones4b9c6292011-07-01 17:40:48 -0500[diff] [blame]139<li><strong>port</strong> - The database port number. To use this value you have to add a line to the database config array.<code>$db['default']['port'] = 5432;</code>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]140</ul>
141
142<p class="important"><strong>Note:</strong> Depending on what database platform you are using (MySQL, Postgres, etc.)
Derek Jones4b9c6292011-07-01 17:40:48 -0500[diff] [blame]143not all values will be needed. For example, when using SQLite you will not need to supply a username or password, and
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]144the database name will be the path to your database file. The information above assumes you are using MySQL.</p>
145
146
147
148</div>
149<!-- END CONTENT -->
150
151
152<div id="footer">
153<p>
154Previous Topic:&nbsp;&nbsp;<a href="examples.html">Quick Start: Usage Examples</a>
155&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
156<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
157<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
158Next Topic:&nbsp;&nbsp;<a href="connecting.html">Connecting to your Database</a>
159</p>
Derek Jones700205a2011-01-28 07:44:28 -0600[diff] [blame]160<p><a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006 - 2011 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">EllisLab, Inc.</a></p>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]161</div>
162
163</body>
Derek Allardf2931e32008-01-15 14:12:30 +0000[diff] [blame]164</html>