Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / b341237fb71f29c7aa591c924742b4693f132593 / . / user_guide / database / configuration.html
blob: 9c679c9679bd462395543e6a631712fae122cd88 [file] [log] [blame]
adminfb28bb82006-09-24 17:59:33 +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>
3<head>
4
Derek Allard404e35d2007-08-07 01:00:45 +0000[diff] [blame]5<title>CodeIgniter User Guide : Database Configuration</title>
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]6
7<style type='text/css' media='all'>@import url('../userguide.css');</style>
8<link rel='stylesheet' type='text/css' media='all' href='../userguide.css' />
9
admin17a890d2006-09-27 20:42:42 +0000[diff] [blame]10<script type="text/javascript" src="../nav/nav.js"></script>
admin2296fc32006-09-27 21:07:02 +0000[diff] [blame]11<script type="text/javascript" src="../nav/prototype.lite.js"></script>
admin17a890d2006-09-27 20:42:42 +0000[diff] [blame]12<script type="text/javascript" src="../nav/moo.fx.js"></script>
Derek Allardb3412372007-10-25 12:15:16 +0000[diff] [blame^]13<script type="text/javascript" src="../nav/user_guide_menu.js"></script>
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]14
15<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
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='Rick Ellis' />
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]20<meta name='description' content='CodeIgniter User Guide' />
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]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.jpg" width="153" height="44" 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 Allard60ca9b72007-07-12 19:53:27 +0000[diff] [blame]31<td><h1>CodeIgniter User Guide Version 1.5.4</h1></td>
adminc0d5d522006-10-30 19:40:35 +0000[diff] [blame]32<td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]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">
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]43<a href="http://www.codeigniter.com/">CodeIgniter Home</a> &nbsp;&#8250;&nbsp;
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]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>
Derek Allardbc030912007-06-24 18:25:29 +0000[diff] [blame]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>
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]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
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]63<p>CodeIgniter has a config file that lets you store your database connection values (username, password, database name, etc.).
Derek Allardc6441282007-07-04 23:54:32 +0000[diff] [blame]64The config file is located at:</p>
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]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']['active_r'] = TRUE;</code>
79
admine334c472006-10-21 19:44:22 +0000[diff] [blame]80<p>The reason we use a multi-dimensional array rather than a more simple one is to permit you to optionally store
81multiple sets of connection values. If, for example, you run multiple environments (development, production, test, etc.)
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]82under a single installation, you can set up a connection group for each, then switch between groups as needed.
83For example, to set up a "test" environment you would do this:</p>
84
85<code>$db['test']['hostname'] = "localhost";<br />
86$db['test']['username'] = "root";<br />
87$db['test']['password'] = "";<br />
88$db['test']['database'] = "database_name";<br />
89$db['test']['dbdriver'] = "mysql";<br />
90$db['test']['dbprefix'] = "";<br />
91$db['test']['pconnect'] = TRUE;<br />
92$db['test']['db_debug'] = FALSE;<br />
93$db['test']['active_r'] = TRUE;</code>
94
admine334c472006-10-21 19:44:22 +0000[diff] [blame]95
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]96<p>Then, to globally tell the system to use that group you would set this variable located in the config file:</p>
97
98<code>$active_group = "test";</code>
99
100<p>Note: The name "test" is arbitrary. It can be anything you want. By default we've used the word "default"
101for the primary connection, but it too can be renamed to something more relevant to your project.</p>
102
103<h3>Explanation of Values:</h3>
104
105<ul>
admine334c472006-10-21 19:44:22 +0000[diff] [blame]106<li><strong>hostname</strong> - The hostname of your database server. Often this is "localhost".</li>
107<li><strong>username</strong> - The username used to connect to the database.</li>
108<li><strong>password</strong> - The password used to connect to the database.</li>
109<li><strong>database</strong> - The name of the database you want to connect to.</li>
110<li><strong>dbdriver</strong> - The database type. ie: mysql, postgre, obdc, etc. Must be specified in lower case.</li>
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]111<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>
admine334c472006-10-21 19:44:22 +0000[diff] [blame]112<li><strong>pconnect</strong> - TRUE/FALSE (boolean) - Whether to use a persistent connection.</li>
113<li><strong>db_debug</strong> - TRUE/FALSE (boolean) - Whether database errors should be displayed.</li>
114<li><strong>active_r</strong> - TRUE/FALSE (boolean) - Whether to load the <a href="active_record.html">Active Record Class</a>. If you are not using the active record class you can have it omitted when the database classes are initialized in order to utilize less resources.</li>
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]115<li><strong>port</strong> - The database port number. Currently only used with the Postgre driver.</li>
116</ul>
117
118<p class="important"><strong>Note:</strong> Depending on what database platform you are using (MySQL, Postgre, etc.)
119not all values will be needed. For example, when using SQLite you will not need to supply a username or password, and
120the database name will be the path to your database file. The information above assumes you are using MySQL.</p>
121
122
123
124</div>
125<!-- END CONTENT -->
126
127
128<div id="footer">
129<p>
130Previous Topic:&nbsp;&nbsp;<a href="examples.html">Quck Start: Usage Examples</a>
131&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
132<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
133<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
134Next Topic:&nbsp;&nbsp;<a href="connecting.html">Connecting to your Database</a>
Derek Allardc6441282007-07-04 23:54:32 +0000[diff] [blame]135</p>
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]136<p><a href="http://www.codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2007 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]137</div>
138
139</body>
140</html>