Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / a898fb5e85d3f927c69e84ee2e9a82aeb542e177 / . / user_guide / database / configuration.html
blob: 8e6fe1f4287f9b6194b69d6ec02149a11228e978 [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 Jones8917af72010-03-05 12:41:45 -0600[diff] [blame]31<td><h1>CodeIgniter User Guide Version 2.0.0</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.).
64The config file is located at:</p>
65
66<p><kbd>application/config/database.php</kbd></p>
67
68<p>The config settings are stored in a multi-dimensional array with this prototype:</p>
69
70<code>$db['default']['hostname'] = "localhost";<br />
71$db['default']['username'] = "root";<br />
72$db['default']['password'] = "";<br />
73$db['default']['database'] = "database_name";<br />
74$db['default']['dbdriver'] = "mysql";<br />
75$db['default']['dbprefix'] = "";<br />
76$db['default']['pconnect'] = TRUE;<br />
77$db['default']['db_debug'] = FALSE;<br />
78$db['default']['cache_on'] = FALSE;<br />
79$db['default']['cachedir'] = &quot;&quot;;<br />
80$db['default']['char_set'] = "utf8";<br />
Derek Jonesad1171a2010-03-10 14:18:38 -0600[diff] [blame]81$db['default']['dbcollat'] = "utf8_general_ci";<br />
82$db['default']['swap_pre'] = "";<br />
83$db['default']['autoinit'] = TRUE;<br />
84$db['default']['stricton'] = FALSE;</code>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]85
86<p>The reason we use a multi-dimensional array rather than a more simple one is to permit you to optionally store
87multiple sets of connection values. If, for example, you run multiple environments (development, production, test, etc.)
88under a single installation, you can set up a connection group for each, then switch between groups as needed.
89For example, to set up a "test" environment you would do this:</p>
90
91<code>$db['test']['hostname'] = "localhost";<br />
92$db['test']['username'] = "root";<br />
93$db['test']['password'] = "";<br />
94$db['test']['database'] = "database_name";<br />
95$db['test']['dbdriver'] = "mysql";<br />
96$db['test']['dbprefix'] = "";<br />
97$db['test']['pconnect'] = TRUE;<br />
98$db['test']['db_debug'] = FALSE;<br />
99$db['test']['cache_on'] = FALSE;<br />
100$db['test']['cachedir'] = &quot;&quot;;<br />
101$db['test']['char_set'] = "utf8";<br />
Derek Jonesad1171a2010-03-10 14:18:38 -0600[diff] [blame]102$db['test']['dbcollat'] = "utf8_general_ci";<br />
103$db['test']['swap_pre'] = "";<br />
104$db['test']['autoinit'] = TRUE;<br />
105$db['test']['stricton'] = FALSE;</code>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]106
107
108<p>Then, to globally tell the system to use that group you would set this variable located in the config file:</p>
109
110<code>$active_group = "test";</code>
111
112<p>Note: The name "test" is arbitrary. It can be anything you want. By default we've used the word "default"
113for the primary connection, but it too can be renamed to something more relevant to your project.</p>
114
115<h3>Active Record</h3>
116
117<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>
118
119<code>$active_record = TRUE;</code>
120
121<p class="important"><strong>Note:</strong> that some CodeIgniter classes such as Sessions require Active Records be enabled to access certain functionality.</p>
122
123<h3>Explanation of Values:</h3>
124
125<ul>
126<li><strong>hostname</strong> - The hostname of your database server. Often this is "localhost".</li>
127<li><strong>username</strong> - The username used to connect to the database.</li>
128<li><strong>password</strong> - The password used to connect to the database.</li>
129<li><strong>database</strong> - The name of the database you want to connect to.</li>
130<li><strong>dbdriver</strong> - The database type. ie: mysql, postgres, odbc, etc. Must be specified in lower case.</li>
131<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>
132<li><strong>pconnect</strong> - TRUE/FALSE (boolean) - Whether to use a persistent connection.</li>
133<li><strong>db_debug</strong> - TRUE/FALSE (boolean) - Whether database errors should be displayed.</li>
134<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>
135<li><strong>cachedir</strong> - The absolute server path to your database query cache directory.</li>
136<li><strong>char_set</strong> - The character set used in communicating with the database.</li>
137<li><strong>dbcollat</strong> - The character collation used in communicating with the database.</li>
Derek Jonesad1171a2010-03-10 14:18:38 -0600[diff] [blame]138<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>
139<li><strong>autoinit</strong> - Whether or not to automatically initialize the database.</li>
140<li><strong>stricton</strong> - TRUE/FALSE (boolean) - Whether to force "Strict Mode" connections, good for ensuring strict SQL while developing an application.</li>
Derek Allard127a1d92010-07-05 07:54:08 -0400[diff] [blame]141<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]142</ul>
143
144<p class="important"><strong>Note:</strong> Depending on what database platform you are using (MySQL, Postgres, etc.)
145not all values will be needed. For example, when using SQLite you will not need to supply a username or password, and
146the database name will be the path to your database file. The information above assumes you are using MySQL.</p>
147
148
149
150</div>
151<!-- END CONTENT -->
152
153
154<div id="footer">
155<p>
156Previous Topic:&nbsp;&nbsp;<a href="examples.html">Quick Start: Usage Examples</a>
157&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
158<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
159<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
160Next Topic:&nbsp;&nbsp;<a href="connecting.html">Connecting to your Database</a>
161</p>
Derek Jones898949f2011-01-28 07:42:16 -0600[diff] [blame]162<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]163</div>
164
165</body>
Derek Allardf2931e32008-01-15 14:12:30 +0000[diff] [blame]166</html>