Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / dcafe89f348697d273e21a2d451a99ba8c6ec68f / . / user_guide / database / connecting.html
blob: 61b51286b172d5ee78fcba8f139854e20a3f4a41 [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
5<title>Code Igniter User Guide</title>
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
10<script type="text/javascript" src="../scripts/nav.js"></script>
11<script type="text/javascript" src="../scripts/prototype.lite.js"></script>
12<script type="text/javascript" src="../scripts/moo.fx.js"></script>
13<script type="text/javascript">
14window.onload = function() {
15 myHeight = new fx.Height('nav', {duration: 400});
16 myHeight.hide();
17}
18</script>
19
20<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
21<meta http-equiv='expires' content='-1' />
22<meta http-equiv= 'pragma' content='no-cache' />
23<meta name='robots' content='all' />
24<meta name='author' content='Rick Ellis' />
25<meta name='description' content='Code Igniter User Guide' />
26
27</head>
28<body>
29
30<!-- START NAVIGATION -->
31<div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div>
32<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>
33<div id="masthead">
34<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
35<tr>
admin41a16852006-09-26 18:17:19 +0000[diff] [blame]36<td><h1>Code Igniter User Guide Version 1.5.0</h1></td>
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]37<td id="breadcrumb_right"><a href="../toc.html">Full Table of Contents</a></td>
38</tr>
39</table>
40</div>
41<!-- END NAVIGATION -->
42
43
44<!-- START BREADCRUMB -->
45<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
46<tr>
47<td id="breadcrumb">
48<a href="http://www.codeigniter.com/">Code Igniter Home</a> &nbsp;&#8250;&nbsp;
49<a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
50<a href="index.html">Database Library</a> &nbsp;&#8250;&nbsp;
51Connecting
52</td>
53<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="www.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>
54</tr>
55</table>
56<!-- END BREADCRUMB -->
57
58
59<br clear="all" />
60
61
62<!-- START CONTENT -->
63<div id="content">
64
65
66<h1>Connecting to your Database</h1>
67
68<p>There are two ways to connect to a database:</p>
69
70<h2>Automatically Connecting</h2>
71
72<p>The "auto connect" feature will load and instantiate the database class with every page load.
73To enable "auto connecting", add the word <var>database</var> to the core array, as indicated in the following file:</p>
74
75<p><kbd>application/config/autoload.php</kbd></p>
76
77<h2>Manually Connecting</h2>
78
79<p>If only some of your pages require database connectivity you can manually connect to your database by adding this
80line of code in any function where it is needed, or in your class constructor to make the database
81available globally in that class.</p>
82
83<code>$this->load->database();</code>
84
85<p class="important">If the above function does <strong>not</strong> contain any information in the first parameter it will connect
86to the group specified in your database config file. For most people, this is the preferred method of use.</p>
87
88
89<p>The first parameter of this function can <strong>optionally</strong> be used to specify a particular database group
90from your config file, or you can even submit connection values for a database that is not specified in your config file.
91Examples:</p>
92
93<p>To choose a specific group from your config file you can do this:</p>
94
95<code>$this->load->database('<samp>group_name</samp>');</code>
96
97<p>Where <samp>group_name</samp> is the name of the connection group from your config file.</p>
98
99
100<p>To connect manually to a desired database you can pass an array of values:</p>
101
102<code>$config['hostname'] = "localhost";<br />
103$config['username'] = "myusername";<br />
104$config['password'] = "mypassword";<br />
105$config['database'] = "mydatabase";<br />
106$config['dbdriver'] = "mysql";<br />
107$config['dbprefix'] = "";<br />
108$config['pconnect'] = FALSE;<br />
109$config['db_debug'] = TRUE;<br />
110$config['active_r'] = TRUE;<br />
111<br />
112$this->load->database(<samp>$config</samp>);</code>
113
114<p>For information on each of these values please see the <a href="configuration.html">configuration page</a>.
115
116<p>Or you can submit your database values as a Data Source Name. DSNs must have this prototype:
117
118<code>$dsn = 'dbdriver://username:password@hostname/database';<br />
119<br />
120$this->load->database('<samp>$dsn</samp>');</code>
121
122<p>Note that if you use a DSN you will not be able to specify some of the default values like you can if you use a connection array.</p>
123
124
125
126
127<h2>Connecting to Multiple Databases</h2>
128
129<p>If you need to connect to more than one database simultaneously you can do so as follows:</p>
130
131
132<code>$DB1 = $this->load->database('group_one', TRUE);<br />
133$DB2 = $this->load->database('group_two', TRUE);
134</code>
135
136<p>Note: Change the words "group_one" and "group_two" to the specific group names you are connecting to (or
137you can pass the connection values as indicated above).</p>
138
139<p>By setting the second parameter to TRUE (boolean) the function will return the database object.</p>
140
141<div class="important">
142<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>
143
144<p>$this->db->query();<br />$this->db->result();<br /> etc...</p>
145
146<p>You will instead use:</p>
147
148<p>$DB1->query();<br />$DB1->result();<br /> etc...</p>
149
150</div>
151
152
153
154
155
156</div>
157<!-- END CONTENT -->
158
159
160<div id="footer">
161<p>
162Previous Topic:&nbsp;&nbsp;<a href="configuration.html">Database Configuration</a>
163&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
164<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
165<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
166Next Topic:&nbsp;&nbsp;<a href="queries.html">Queries</a>
167<p>
168<p><a href="http://www.codeigniter.com">Code Igniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006 &nbsp;&middot;&nbsp; <a href="http://www.pmachine.com">pMachine, Inc.</a></p>
169</div>
170
171</body>
172</html>