Debian Codegraph @

www/c3ref/table_column_metadata.html

raw
1 <!DOCTYPE html>
2 <html><head>
3 <meta name="viewport" content="width=device-width, initial-scale=1.0">
4 <meta http-equiv="content-type" content="text/html; charset=UTF-8">
5 <link href="../sqlite.css" rel="stylesheet">
6 <title>Extract Metadata About A Column Of A Table</title>
7 <!-- path=../ -->
8 </head>
9 <body>
10 <div class=nosearch>
11 <a href="../index.html">
12 <img class="logo" src="../images/sqlite370_banner.svg" alt="SQLite" border="0">
13 </a>
14 <div><!-- IE hack to prevent disappearing logo --></div>
15 <div class="tagline desktoponly">
16 Small. Fast. Reliable.<br>Choose any three.
17 </div>
18 <div class="menu mainmenu">
19 <ul>
20 <li><a href="../index.html">Home</a>
21 <li class='mobileonly'><a href="javascript:void(0)" onclick='toggle_div("submenu")'>Menu</a>
22 <li class='wideonly'><a href='../about.html'>About</a>
23 <li class='desktoponly'><a href="../docs.html">Documentation</a>
24 <li class='desktoponly'><a href="../download.html">Download</a>
25 <li class='wideonly'><a href='../copyright.html'>License</a>
26 <li class='desktoponly'><a href="../support.html">Support</a>
27 <li class='desktoponly'><a href="../prosupport.html">Purchase</a>
28 <li class='search' id='search_menubutton'>
29 <a href="javascript:void(0)" onclick='toggle_search()'>Search</a>
30 </ul>
31 </div>
32 <div class="menu submenu" id="submenu">
33 <ul>
34 <li><a href='../about.html'>About</a>
35 <li><a href='../docs.html'>Documentation</a>
36 <li><a href='../download.html'>Download</a>
37 <li><a href='../support.html'>Support</a>
38 <li><a href='../prosupport.html'>Purchase</a>
39 </ul>
40 </div>
41 <div class="searchmenu" id="searchmenu">
42 <form method="GET" action="../search">
43 <select name="s" id="searchtype">
44 <option value="d">Search Documentation</option>
45 <option value="c">Search Changelog</option>
46 </select>
47 <input type="text" name="q" id="searchbox" value="">
48 <input type="submit" value="Go">
49 </form>
50 </div>
51 </div>
52 <script>
53 function toggle_div(nm) {
54 var w = document.getElementById(nm);
55 if( w.style.display=="block" ){
56 w.style.display = "none";
57 }else{
58 w.style.display = "block";
59 }
60 }
61 function toggle_search() {
62 var w = document.getElementById("searchmenu");
63 if( w.style.display=="block" ){
64 w.style.display = "none";
65 } else {
66 w.style.display = "block";
67 setTimeout(function(){
68 document.getElementById("searchbox").focus()
69 }, 30);
70 }
71 }
72 function div_off(nm){document.getElementById(nm).style.display="none";}
73 window.onbeforeunload = function(e){div_off("submenu");}
74 /* Disable the Search feature if we are not operating from CGI, since */
75 /* Search is accomplished using CGI and will not work without it. */
76 if( !location.origin || !location.origin.match || !location.origin.match(/http/) ){
77 document.getElementById("search_menubutton").style.display = "none";
78 }
79 /* Used by the Hide/Show button beside syntax diagrams, to toggle the */
80 function hideorshow(btn,obj){
81 var x = document.getElementById(obj);
82 var b = document.getElementById(btn);
83 if( x.style.display!='none' ){
84 x.style.display = 'none';
85 b.innerHTML='show';
86 }else{
87 x.style.display = '';
88 b.innerHTML='hide';
89 }
90 return false;
91 }
92 var antiRobot = 0;
93 function antiRobotGo(){
94 if( antiRobot!=3 ) return;
95 antiRobot = 7;
96 var j = document.getElementById("mtimelink");
97 if(j && j.hasAttribute("data-href")) j.href=j.getAttribute("data-href");
98 }
99 function antiRobotDefense(){
100 document.body.onmousedown=function(){
101 antiRobot |= 2;
102 antiRobotGo();
103 document.body.onmousedown=null;
104 }
105 document.body.onmousemove=function(){
106 antiRobot |= 2;
107 antiRobotGo();
108 document.body.onmousemove=null;
109 }
110 setTimeout(function(){
111 antiRobot |= 1;
112 antiRobotGo();
113 }, 100)
114 antiRobotGo();
115 }
116 antiRobotDefense();
117 </script>
118 <!-- keywords: sqlite3_table_column_metadata -->
119 <div class=nosearch>
120 <a href="../c3ref/intro.html"><h2>SQLite C Interface</h2></a>
121 <h2>Extract Metadata About A Column Of A Table</h2>
122 </div>
123 <blockquote><pre>
124 int sqlite3_table_column_metadata(
125 sqlite3 *db, /* Connection handle */
126 const char *zDbName, /* Database name or NULL */
127 const char *zTableName, /* Table name */
128 const char *zColumnName, /* Column name */
129 char const **pzDataType, /* OUTPUT: Declared data type */
130 char const **pzCollSeq, /* OUTPUT: Collation sequence name */
131 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
132 int *pPrimaryKey, /* OUTPUT: True if column part of PK */
133 int *pAutoinc /* OUTPUT: True if column is auto-increment */
134 );
135 </pre></blockquote>
136 <p>
137 The sqlite3_table_column_metadata(X,D,T,C,....) routine returns
138 information about column C of table T in database D
139 on <a href="../c3ref/sqlite3.html">database connection</a> X. The sqlite3_table_column_metadata()
140 interface returns SQLITE_OK and fills in the non-NULL pointers in
141 the final five arguments with appropriate values if the specified
142 column exists. The sqlite3_table_column_metadata() interface returns
143 SQLITE_ERROR if the specified column does not exist.
144 If the column-name parameter to sqlite3_table_column_metadata() is a
145 NULL pointer, then this routine simply checks for the existence of the
146 table and returns SQLITE_OK if the table exists and SQLITE_ERROR if it
147 does not. If the table name parameter T in a call to
148 sqlite3_table_column_metadata(X,D,T,C,...) is NULL then the result is
149 undefined behavior.</p>
150
151 <p>The column is identified by the second, third and fourth parameters to
152 this function. The second parameter is either the name of the database
153 (i.e. "main", "temp", or an attached database) containing the specified
154 table or NULL. If it is NULL, then all attached databases are searched
155 for the table using the same algorithm used by the database engine to
156 resolve unqualified table references.</p>
157
158 <p>The third and fourth parameters to this function are the table and column
159 name of the desired column, respectively.</p>
160
161 <p>Metadata is returned by writing to the memory locations passed as the 5th
162 and subsequent parameters to this function. Any of these arguments may be
163 NULL, in which case the corresponding element of metadata is omitted.</p>
164
165 <p><blockquote>
166 <table border="1">
167 <tr><th> Parameter <th> Output<br>Type <th> Description</p>
168
169 <p><tr><td> 5th <td> const char* <td> Data type
170 <tr><td> 6th <td> const char* <td> Name of default collation sequence
171 <tr><td> 7th <td> int <td> True if column has a NOT NULL constraint
172 <tr><td> 8th <td> int <td> True if column is part of the PRIMARY KEY
173 <tr><td> 9th <td> int <td> True if column is <a href="../autoinc.html">AUTOINCREMENT</a>
174 </table>
175 </blockquote></p>
176
177 <p>The memory pointed to by the character pointers returned for the
178 declaration type and collation sequence is valid until the next
179 call to any SQLite API function.</p>
180
181 <p>If the specified table is actually a view, an <a href="../rescode.html">error code</a> is returned.</p>
182
183 <p>If the specified column is "rowid", "oid" or "_rowid_" and the table
184 is not a <a href="../withoutrowid.html">WITHOUT ROWID</a> table and an
185 <a href="../lang_createtable.html#rowid">INTEGER PRIMARY KEY</a> column has been explicitly declared, then the output
186 parameters are set for the explicitly declared column. If there is no
187 <a href="../lang_createtable.html#rowid">INTEGER PRIMARY KEY</a> column, then the outputs
188 for the <a href="../lang_createtable.html#rowid">rowid</a> are set as follows:</p>
189
190 <p><pre>
191 data type: "INTEGER"
192 collation sequence: "BINARY"
193 not null: 0
194 primary key: 1
195 auto increment: 0
196 </pre></p>
197
198 <p>This function causes all database schemas to be read from disk and
199 parsed, if that has not already been done, and returns an error if
200 any errors are encountered while loading the schema.
201 </p><p>See also lists of
202 <a href="../c3ref/objlist.html">Objects</a>,
203 <a href="../c3ref/constlist.html">Constants</a>, and
204 <a href="../c3ref/funclist.html">Functions</a>.</p>
205