Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / 6599b9a5dc699da2e7d2a69b070d203f99d80b6a / . / user_guide / database / connecting.html
blob: 8ece6dcef94c046b4f0e3af04f08c58dd1bf454c [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">
Derek Allardafd99ac2008-01-19 19:59:14 +0000[diff] [blame]2<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]3<head>
4
Derek Allard8039d4c2008-05-31 02:47:56 +0000[diff] [blame]5<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
Derek Jonesfd93d222008-05-06 15:18:50 +0000[diff] [blame]6<title>Connecting to your Database : CodeIgniter User Guide</title>
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]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
admin17a890d2006-09-27 20:42:42 +0000[diff] [blame]11<script type="text/javascript" src="../nav/nav.js"></script>
admin2296fc32006-09-27 21:07:02 +0000[diff] [blame]12<script type="text/javascript" src="../nav/prototype.lite.js"></script>
admin17a890d2006-09-27 20:42:42 +0000[diff] [blame]13<script type="text/javascript" src="../nav/moo.fx.js"></script>
Derek Allardb3412372007-10-25 12:15:16 +0000[diff] [blame]14<script type="text/javascript" src="../nav/user_guide_menu.js"></script>
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]15
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]16<meta http-equiv='expires' content='-1' />
17<meta http-equiv= 'pragma' content='no-cache' />
18<meta name='robots' content='all' />
Derek Allard3d879d52008-01-18 19:41:32 +0000[diff] [blame]19<meta name='author' content='ExpressionEngine Dev Team' />
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>
Rick Ellis7cdef032008-08-26 18:44:54 +0000[diff] [blame]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>
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]28<div id="masthead">
29<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
30<tr>
Rick Ellis25949532008-08-26 19:48:08 +0000[diff] [blame]31<td><h1>CodeIgniter User Guide Version 1.7</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 Jones7a9193a2008-01-21 18:39:20 +0000[diff] [blame]43<a href="http://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;
46Connecting
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>Connecting to your Database</h1>
62
63<p>There are two ways to connect to a database:</p>
64
65<h2>Automatically Connecting</h2>
66
admine334c472006-10-21 19:44:22 +0000[diff] [blame]67<p>The "auto connect" feature will load and instantiate the database class with every page load.
Derek Allard44bd10f2008-03-25 22:27:37 +0000[diff] [blame]68To enable "auto connecting", add the word <var>database</var> to the library array, as indicated in the following file:</p>
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]69
70<p><kbd>application/config/autoload.php</kbd></p>
71
72<h2>Manually Connecting</h2>
73
admine334c472006-10-21 19:44:22 +0000[diff] [blame]74<p>If only some of your pages require database connectivity you can manually connect to your database by adding this
75line of code in any function where it is needed, or in your class constructor to make the database
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]76available globally in that class.</p>
77
78<code>$this->load->database();</code>
79
admine334c472006-10-21 19:44:22 +0000[diff] [blame]80<p class="important">If the above function does <strong>not</strong> contain any information in the first parameter it will connect
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]81to the group specified in your database config file. For most people, this is the preferred method of use.</p>
82
Rick Ellis9ba21892008-10-19 01:02:33 +0000[diff] [blame]83<h3>Available Parameters</h3>
84
85<ol>
86 <li>The database connection values, passed either as an array or a DSN string.</li>
87 <li>TRUE/FALSE (boolean). Whether to return the connection ID (see Connecting to Multiple Databases below).</li>
88 <li>TRUE/FALSE (boolean). Whether to enable the Active Record class. Set to FALSE by default.</li>
89</ol>
90
91
92<h3>Manuallly Connecting to a Database</h3>
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]93
94<p>The first parameter of this function can <strong>optionally</strong> be used to specify a particular database group
95from your config file, or you can even submit connection values for a database that is not specified in your config file.
96Examples:</p>
97
98<p>To choose a specific group from your config file you can do this:</p>
99
100<code>$this->load->database('<samp>group_name</samp>');</code>
101
102<p>Where <samp>group_name</samp> is the name of the connection group from your config file.</p>
103
104
105<p>To connect manually to a desired database you can pass an array of values:</p>
106
107<code>$config['hostname'] = "localhost";<br />
108$config['username'] = "myusername";<br />
109$config['password'] = "mypassword";<br />
110$config['database'] = "mydatabase";<br />
111$config['dbdriver'] = "mysql";<br />
112$config['dbprefix'] = "";<br />
113$config['pconnect'] = FALSE;<br />
114$config['db_debug'] = TRUE;<br />
Derek Jones25b24d22008-03-11 16:20:29 +0000[diff] [blame]115$config['cache_on'] = FALSE;<br />
116$config['cachedir'] = "";<br />
117$config['char_set'] = "utf8";<br />
118$config['dbcollat'] = "utf8_general_ci";<br />
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]119<br />
120$this->load->database(<samp>$config</samp>);</code>
121
Derek Allardc6441282007-07-04 23:54:32 +0000[diff] [blame]122<p>For information on each of these values please see the <a href="configuration.html">configuration page</a>.</p>
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]123
Derek Allardc6441282007-07-04 23:54:32 +0000[diff] [blame]124<p>Or you can submit your database values as a Data Source Name. DSNs must have this prototype:</p>
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]125
126<code>$dsn = 'dbdriver://username:password@hostname/database';<br />
127<br />
Derek Allard3af44c02008-04-10 11:21:21 +0000[diff] [blame]128$this->load->database(<samp>$dsn</samp>);</code>
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]129
Derek Jones97bc0102008-05-14 15:01:50 +0000[diff] [blame]130<p>To override default config values when connecting with a DSN string, add the config variables as a query string.</p>
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]131
Derek Jones97bc0102008-05-14 15:01:50 +0000[diff] [blame]132<code>$dsn = 'dbdriver://username:password@hostname/database?char_set=utf8&amp;dbcollat=utf8_general_ci&amp;cache_on=true&amp;cachedir=/path/to/cache';<br />
133<br />
134$this->load->database(<samp>$dsn</samp>);</code>
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]135
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]136<h2>Connecting to Multiple Databases</h2>
137
138<p>If you need to connect to more than one database simultaneously you can do so as follows:</p>
139
140
141<code>$DB1 = $this->load->database('group_one', TRUE);<br />
142$DB2 = $this->load->database('group_two', TRUE);
143</code>
144
admine334c472006-10-21 19:44:22 +0000[diff] [blame]145<p>Note: Change the words "group_one" and "group_two" to the specific group names you are connecting to (or
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]146you can pass the connection values as indicated above).</p>
147
148<p>By setting the second parameter to TRUE (boolean) the function will return the database object.</p>
149
150<div class="important">
151<p>When you connect this way, you will use your object name to issue commands rather than the syntax used throughout this guide. In other words, rather than issuing commands with:</p>
152
153<p>$this->db->query();<br />$this->db->result();<br /> etc...</p>
154
155<p>You will instead use:</p>
156
157<p>$DB1->query();<br />$DB1->result();<br /> etc...</p>
158
159</div>
160
161
162
163
164
165</div>
166<!-- END CONTENT -->
167
168
169<div id="footer">
170<p>
171Previous Topic:&nbsp;&nbsp;<a href="configuration.html">Database Configuration</a>
172&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
173<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
174<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
175Next Topic:&nbsp;&nbsp;<a href="queries.html">Queries</a>
Derek Allardc6441282007-07-04 23:54:32 +0000[diff] [blame]176</p>
Derek Jones07870432008-02-13 03:49:26 +0000[diff] [blame]177<p><a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006-2008 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]178</div>
179
180</body>
181</html>