blob: dd2def9a315ae8d6e89e946cb8f3a6efd50c07de [file] [log] [blame]
adminb0dd10f2006-08-25 17:25:49 +00001<!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>
36<td><h1>Code Igniter User Guide Version 1.4.0</h1></td>
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<!-- START BREADCRUMB -->
44<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
45<tr>
46<td id="breadcrumb">
47<a href="http://www.codeigniter.com/">Code Igniter Home</a> &nbsp;&#8250;&nbsp;
48<a href="../../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
49<a href="index.html">Database Library</a> &nbsp;&#8250;&nbsp;
50Field Names
51</td>
52<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>
53</tr>
54</table>
55<!-- END BREADCRUMB -->
56
57
58<br clear="all" />
59
60
61<!-- START CONTENT -->
62<div id="content">
63
64
65<h1>Field Data</h1>
66
67
68<h2>Retrieving Field Names</h2>
69<p>Sometimes it's helpful to gather the field names.</p>
70
71<h2>$this->db->field_names();</h2>
72<p>Returns an array containing the field names. You must supply the table name to the function:</p>
73
74<code>
75$fields = $this->db->field_names('table_name');<br /><br />
76
77foreach ($fields as $field)<br />
78{<br />
79&nbsp;&nbsp;&nbsp;echo $field;<br />
80}
81</code>
82
83
84
85<h2>Retrieving Field MetaData</h2>
86<p>Sometimes it's helpful to gather the field names or other metadata, like the column type, max length, etc.</p>
87
88<h2>$this->db->field_data();</h2>
89<p>Returns an array of objects containing field information.</p>
90
91<p class="important">Note: Not all databases provide meta-data.</p>
92
93<p>Usage example:</p>
94
95<code>
96$fields = $this->db->field_data('table_name');<br /><br />
97
98foreach ($fields as $field)<br />
99{<br />
100&nbsp;&nbsp;&nbsp;echo $field->name;<br />
101&nbsp;&nbsp;&nbsp;echo $field->type;<br />
102&nbsp;&nbsp;&nbsp;echo $field->max_length;<br />
103&nbsp;&nbsp;&nbsp;echo $field->primary_key;<br />
104}
105</code>
106
107<p>If you have run a query already you can use the result oject instead of supplying the table name:</p>
108
109<code>
110$query = $this->db->query("YOUR QUERY");<br />
111$fields = $query->field_data();
112</code>
113
114
115<p>The following data is available from this function if supported by your database:</p>
116
117<ul>
118<li>name - column name</li>
119<li>max_length - maximum length of the column</li>
120<li>primary_key - 1 if the column is a primary key</li>
121<li>type - the type of the column</li>
122</ul>
123
124
125
126
127
128</div>
129<!-- END CONTENT -->
130
131
132<div id="footer">
133<p>
134Previous Topic:&nbsp;&nbsp;<a href="results.html">Query Results</a>
135&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
136<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
137<a href="../../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
138Next Topic:&nbsp;&nbsp;<a href="table_data.html">Table MetaData</a>
139<p>
140<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>
141</div>
142
143</body>
144</html>