Debian Codegraph @

doc/programmers-guide/reference-database.html

raw
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <HTML
3 ><HEAD
4 ><TITLE
5 >SQL and Database Infrastructure</TITLE
6 ><META
7 NAME="GENERATOR"
8 CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
9 REL="HOME"
10 TITLE="Database Independent Abstraction Layer for C"
11 HREF="index.html"><LINK
12 REL="UP"
13 TITLE="libdbi API Reference"
14 HREF="reference.html"><LINK
15 REL="PREVIOUS"
16 TITLE="Connection Infrastructure"
17 HREF="reference-conn.html"><LINK
18 REL="NEXT"
19 TITLE="Managing Queries"
20 HREF="reference-query.html"></HEAD
21 ><BODY
22 CLASS="SECTION"
23 BGCOLOR="#FFFFFF"
24 TEXT="#000000"
25 LINK="#0000FF"
26 VLINK="#840084"
27 ALINK="#0000FF"
28 ><DIV
29 CLASS="NAVHEADER"
30 ><TABLE
31 SUMMARY="Header navigation table"
32 WIDTH="100%"
33 BORDER="0"
34 CELLPADDING="0"
35 CELLSPACING="0"
36 ><TR
37 ><TH
38 COLSPAN="3"
39 ALIGN="center"
40 >Database Independent Abstraction Layer for C: libdbi Programmer's Guide</TH
41 ></TR
42 ><TR
43 ><TD
44 WIDTH="10%"
45 ALIGN="left"
46 VALIGN="bottom"
47 ><A
48 HREF="reference-conn.html"
49 ACCESSKEY="P"
50 >Prev</A
51 ></TD
52 ><TD
53 WIDTH="80%"
54 ALIGN="center"
55 VALIGN="bottom"
56 >Chapter 7. libdbi API Reference</TD
57 ><TD
58 WIDTH="10%"
59 ALIGN="right"
60 VALIGN="bottom"
61 ><A
62 HREF="reference-query.html"
63 ACCESSKEY="N"
64 >Next</A
65 ></TD
66 ></TR
67 ></TABLE
68 ><HR
69 ALIGN="LEFT"
70 WIDTH="100%"></DIV
71 ><DIV
72 CLASS="SECTION"
73 ><H1
74 CLASS="SECTION"
75 ><A
76 NAME="REFERENCE-DATABASE"
77 >7.4. SQL and Database Infrastructure</A
78 ></H1
79 ><DIV
80 CLASS="SECTION"
81 ><H2
82 CLASS="SECTION"
83 ><A
84 NAME="DBI-CONN-CONNECT"
85 >7.4.1. dbi_conn_connect</A
86 ></H2
87 ><DIV
88 CLASS="FUNCSYNOPSIS"
89 ><P
90 ></P
91 ><A
92 NAME="AEN1791"
93 ></A
94 ><P
95 ><CODE
96 ><CODE
97 CLASS="FUNCDEF"
98 >int <B
99 CLASS="FSFUNC"
100 >dbi_conn_connect</B
101 ></CODE
102 >(dbi_conn <VAR
103 CLASS="PDPARAM"
104 >Conn</VAR
105 >);</CODE
106 ></P
107 ><P
108 ></P
109 ></DIV
110 ><P
111 >Connects to the database using the options (host, username, password, port, (etc.) set with <A
112 HREF="reference-conn.html#DBI-CONN-SET-OPTION"
113 >dbi_conn_set_option</A
114 > and related functions. See the documentation for each specific database driver for the options it recognizes and requires.</P
115 ><P
116 ></P
117 ><DIV
118 CLASS="VARIABLELIST"
119 ><DL
120 ><DT
121 >Arguments</DT
122 ><DD
123 ><P
124 ><TT
125 CLASS="LITERAL"
126 >Conn</TT
127 >: The target connection.</P
128 ></DD
129 ><DT
130 >Returns</DT
131 ><DD
132 ><P
133 >0 (zero) on success, less than zero on failure. In the latter case, the <A
134 HREF="errornumbers.html"
135 >error number</A
136 > may be DBI_ERROR_NOMEM, DBI_ERROR_NOCONN, or one of the driver-specific values.</P
137 ></DD
138 ></DL
139 ></DIV
140 ></DIV
141 ><DIV
142 CLASS="SECTION"
143 ><H2
144 CLASS="SECTION"
145 ><A
146 NAME="DBI-CONN-GET-DB-LIST"
147 >7.4.2. dbi_conn_get_db_list</A
148 ></H2
149 ><DIV
150 CLASS="FUNCSYNOPSIS"
151 ><P
152 ></P
153 ><A
154 NAME="AEN1812"
155 ></A
156 ><P
157 ><CODE
158 ><CODE
159 CLASS="FUNCDEF"
160 >dbi_result <B
161 CLASS="FSFUNC"
162 >dbi_conn_get_db_list</B
163 ></CODE
164 >(dbi_conn <VAR
165 CLASS="PDPARAM"
166 >Conn</VAR
167 >, const char *<VAR
168 CLASS="PDPARAM"
169 >pattern</VAR
170 >);</CODE
171 ></P
172 ><P
173 ></P
174 ></DIV
175 ><P
176 >Queries the list of available databases on the server.</P
177 ><P
178 ></P
179 ><DIV
180 CLASS="VARIABLELIST"
181 ><DL
182 ><DT
183 >Arguments</DT
184 ><DD
185 ><P
186 ><TT
187 CLASS="LITERAL"
188 >Conn</TT
189 >: The target connection.</P
190 ><P
191 ><TT
192 CLASS="LITERAL"
193 >pattern</TT
194 >: A string pattern (SQL regular expression) that each name must match, or NULL to show all available databases.</P
195 ></DD
196 ><DT
197 >Returns</DT
198 ><DD
199 ><P
200 >A query result object, which will contain database names in the first field (for use with the by-index field functions). In case of an error, the function returns NULL and sets the <A
201 HREF="errornumbers.html"
202 >error number</A
203 > to a database engine-specific nonzero value.</P
204 ></DD
205 ></DL
206 ></DIV
207 ></DIV
208 ><DIV
209 CLASS="SECTION"
210 ><H2
211 CLASS="SECTION"
212 ><A
213 NAME="DBI-CONN-GET-TABLE-LIST"
214 >7.4.3. dbi_conn_get_table_list</A
215 ></H2
216 ><DIV
217 CLASS="FUNCSYNOPSIS"
218 ><P
219 ></P
220 ><A
221 NAME="AEN1836"
222 ></A
223 ><P
224 ><CODE
225 ><CODE
226 CLASS="FUNCDEF"
227 >dbi_result <B
228 CLASS="FSFUNC"
229 >dbi_conn_get_table_list</B
230 ></CODE
231 >(dbi_conn <VAR
232 CLASS="PDPARAM"
233 >Conn</VAR
234 >, const char *<VAR
235 CLASS="PDPARAM"
236 >db</VAR
237 >, const char *<VAR
238 CLASS="PDPARAM"
239 >pattern</VAR
240 >);</CODE
241 ></P
242 ><P
243 ></P
244 ></DIV
245 ><P
246 >Queries the list of available tables in a particular database.</P
247 ><P
248 ></P
249 ><DIV
250 CLASS="VARIABLELIST"
251 ><DL
252 ><DT
253 >Arguments</DT
254 ><DD
255 ><P
256 ><TT
257 CLASS="LITERAL"
258 >Conn</TT
259 >: The target connection.</P
260 ><P
261 ><TT
262 CLASS="LITERAL"
263 >db</TT
264 >: The target database name.</P
265 ><P
266 ><TT
267 CLASS="LITERAL"
268 >pattern</TT
269 >: A string pattern (SQL regular expression) that each name must match, or NULL to show all available tables.</P
270 ></DD
271 ><DT
272 >Returns</DT
273 ><DD
274 ><P
275 >A query result object, which will contain table names in the first field (for use with the by-index field functions). In case of an error, the function returns NULL and sets the <A
276 HREF="errornumbers.html"
277 >error number</A
278 > to a database engine-specific nonzero value.</P
279 ></DD
280 ></DL
281 ></DIV
282 ></DIV
283 ><DIV
284 CLASS="SECTION"
285 ><H2
286 CLASS="SECTION"
287 ><A
288 NAME="DBI-CONN-SELECT-DB"
289 >7.4.4. dbi_conn_select_db</A
290 ></H2
291 ><DIV
292 CLASS="FUNCSYNOPSIS"
293 ><P
294 ></P
295 ><A
296 NAME="AEN1864"
297 ></A
298 ><P
299 ><CODE
300 ><CODE
301 CLASS="FUNCDEF"
302 >int <B
303 CLASS="FSFUNC"
304 >dbi_conn_select_db</B
305 ></CODE
306 >(dbi_conn <VAR
307 CLASS="PDPARAM"
308 >Conn</VAR
309 >, const char *<VAR
310 CLASS="PDPARAM"
311 >db</VAR
312 >);</CODE
313 ></P
314 ><P
315 ></P
316 ></DIV
317 ><P
318 >Switches to a different database on the server.</P
319 ><P
320 ></P
321 ><DIV
322 CLASS="VARIABLELIST"
323 ><DL
324 ><DT
325 >Arguments</DT
326 ><DD
327 ><P
328 ><TT
329 CLASS="LITERAL"
330 >Conn</TT
331 >: The target connection.</P
332 ><P
333 ><TT
334 CLASS="LITERAL"
335 >db</TT
336 >: The target database name.</P
337 ></DD
338 ><DT
339 >Returns</DT
340 ><DD
341 ><P
342 >-1 on failure, zero on success. In case of an error, the <A
343 HREF="errornumbers.html"
344 >error number</A
345 > may be DBI_ERROR_UNSUPPORTED or a database engine-specific nonzero value.</P
346 ></DD
347 ></DL
348 ></DIV
349 ></DIV
350 ></DIV
351 ><DIV
352 CLASS="NAVFOOTER"
353 ><HR
354 ALIGN="LEFT"
355 WIDTH="100%"><TABLE
356 SUMMARY="Footer navigation table"
357 WIDTH="100%"
358 BORDER="0"
359 CELLPADDING="0"
360 CELLSPACING="0"
361 ><TR
362 ><TD
363 WIDTH="33%"
364 ALIGN="left"
365 VALIGN="top"
366 ><A
367 HREF="reference-conn.html"
368 ACCESSKEY="P"
369 >Prev</A
370 ></TD
371 ><TD
372 WIDTH="34%"
373 ALIGN="center"
374 VALIGN="top"
375 ><A
376 HREF="index.html"
377 ACCESSKEY="H"
378 >Home</A
379 ></TD
380 ><TD
381 WIDTH="33%"
382 ALIGN="right"
383 VALIGN="top"
384 ><A
385 HREF="reference-query.html"
386 ACCESSKEY="N"
387 >Next</A
388 ></TD
389 ></TR
390 ><TR
391 ><TD
392 WIDTH="33%"
393 ALIGN="left"
394 VALIGN="top"
395 >Connection Infrastructure</TD
396 ><TD
397 WIDTH="34%"
398 ALIGN="center"
399 VALIGN="top"
400 ><A
401 HREF="reference.html"
402 ACCESSKEY="U"
403 >Up</A
404 ></TD
405 ><TD
406 WIDTH="33%"
407 ALIGN="right"
408 VALIGN="top"
409 >Managing Queries</TD
410 ></TR
411 ></TABLE
412 ></DIV
413 ></BODY
414 ></HTML
415 >