Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / ab4f61bacfa022c0c7238e9661ad9cb2ac440d95 / . / user_guide / database / fields.html
blob: ecb6fcb45c63c0310d182d9f61670d8e31c103a7 [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>
36<td><h1>Code Igniter User Guide Version 1.4.1</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>
adminab4f61b2006-09-25 22:12:32 +0000[diff] [blame^]69<p>Sometimes it's helpful to gather the field names for a particular table or with a paritcular query result.</p>
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]70
71<h2>$this->db->field_names();</h2>
adminab4f61b2006-09-25 22:12:32 +0000[diff] [blame^]72<p>Returns an array containing the field names. This query can be called two ways:</p>
73
74
75<p>1. You can supply the table name and call it from the <dfn>$this->db-></dfn> object:</p>
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]76
77<code>
78$fields = $this->db->field_names('table_name');<br /><br />
79
80foreach ($fields as $field)<br />
81{<br />
82&nbsp;&nbsp;&nbsp;echo $field;<br />
83}
84</code>
85
adminab4f61b2006-09-25 22:12:32 +0000[diff] [blame^]86<p>2. You can gather the feild names associated with any query you run by calling the function
87from your query result object:</p>
88
89<code>
90$query = $this->db->query('SELECT * FROM some_table');
91<br /><br />
92
93foreach ($query->field_names() as $field)<br />
94{<br />
95&nbsp;&nbsp;&nbsp;echo $field;<br />
96}
97</code>
98
99
100
adminfb28bb82006-09-24 17:59:33 +0000[diff] [blame]101
102
103<h2>Retrieving Field MetaData</h2>
104<p>Sometimes it's helpful to gather the field names or other metadata, like the column type, max length, etc.</p>
105
106<h2>$this->db->field_data();</h2>
107<p>Returns an array of objects containing field information.</p>
108
109<p class="important">Note: Not all databases provide meta-data.</p>
110
111<p>Usage example:</p>
112
113<code>
114$fields = $this->db->field_data('table_name');<br /><br />
115
116foreach ($fields as $field)<br />
117{<br />
118&nbsp;&nbsp;&nbsp;echo $field->name;<br />
119&nbsp;&nbsp;&nbsp;echo $field->type;<br />
120&nbsp;&nbsp;&nbsp;echo $field->max_length;<br />
121&nbsp;&nbsp;&nbsp;echo $field->primary_key;<br />
122}
123</code>
124
125<p>If you have run a query already you can use the result oject instead of supplying the table name:</p>
126
127<code>
128$query = $this->db->query("YOUR QUERY");<br />
129$fields = $query->field_data();
130</code>
131
132
133<p>The following data is available from this function if supported by your database:</p>
134
135<ul>
136<li>name - column name</li>
137<li>max_length - maximum length of the column</li>
138<li>primary_key - 1 if the column is a primary key</li>
139<li>type - the type of the column</li>
140</ul>
141
142
143
144
145
146</div>
147<!-- END CONTENT -->
148
149
150<div id="footer">
151<p>
152Previous Topic:&nbsp;&nbsp;<a href="results.html">Query Results</a>
153&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
154<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
155<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
156Next Topic:&nbsp;&nbsp;<a href="table_data.html">Table MetaData</a>
157<p>
158<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>
159</div>
160
161</body>
162</html>