libgda-5.0-doc 5.2.4-3 / usr / share / gtk-doc / html / libgda-5.0 / connection.html

This file is indexed.

/usr/share/gtk-doc/html/libgda-5.0/connection.html is in libgda-5.0-doc 5.2.4-3.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Connections &amp; commands: GNOME Data Access 5 manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GNOME Data Access 5 manual">
<link rel="up" href="part_libgda_api.html" title="Part II. API reference">
<link rel="prev" href="libgda-5.0-Configuration.html" title="Configuration">
<link rel="next" href="GdaConnection.html" title="GdaConnection">
<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts"></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="part_libgda_api.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libgda-5.0-Configuration.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GdaConnection.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="chapter">
<div class="titlepage"><div><div><h2 class="title">
<a name="connection"></a>Connections &amp; commands</h2></div></div></div>
<div class="toc"><dl class="toc">
<dt>
<span class="refentrytitle"><a href="GdaConnection.html">GdaConnection</a></span><span class="refpurpose"> — A connection to a database</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GdaSqlParser.html">GdaSqlParser</a></span><span class="refpurpose"> — SQL parser</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GdaSqlBuilder.html">GdaSqlBuilder</a></span><span class="refpurpose"> — Factory object for statements</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GdaStatement.html">GdaStatement</a></span><span class="refpurpose"> — Single SQL statement</span>
</dt>
<dt>
<span class="refentrytitle"><a href="libgda-5.0-GdaRepetitiveStatement.html">GdaRepetitiveStatement</a></span><span class="refpurpose"> — Execute the same statement several times with different values</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GdaBatch.html">GdaBatch</a></span><span class="refpurpose"> — Multiple SQL statements grouped together.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GdaHolder.html">GdaHolder</a></span><span class="refpurpose"> — Container for a single <span class="type">GValue</span></span>
</dt>
<dt>
<span class="refentrytitle"><a href="GdaSet.html">GdaSet</a></span><span class="refpurpose"> — Container for several values</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GdaConnectionEvent.html">GdaConnectionEvent</a></span><span class="refpurpose"> — Any event which has occurred on a <span class="type">GdaConnection</span></span>
</dt>
<dt>
<span class="refentrytitle"><a href="GdaTransactionStatus.html">GdaTransactionStatus</a></span><span class="refpurpose"> — Keeps track of the transaction status of a connection</span>
</dt>
<dt>
<span class="refentrytitle"><a href="libgda-5.0-GdaXaTransaction.html">GdaXaTransaction</a></span><span class="refpurpose"> — Distributed transaction manager</span>
</dt>
<dt><span class="sect1"><a href="connection.html#GdaConnectionMetaTypeHead">Description of the data model returned by gda_connection_get_meta_store_data()</a></span></dt>
<dd><dl>
<dt><span class="sect2"><a href="connection.html#GdaConnectionMetaTypeGDA_CONNECTION_META_NAMESPACES">GDA_CONNECTION_META_NAMESPACES</a></span></dt>
<dt><span class="sect2"><a href="connection.html#GdaConnectionMetaTypeGDA_CONNECTION_META_TYPES">GDA_CONNECTION_META_TYPES</a></span></dt>
<dt><span class="sect2"><a href="connection.html#GdaConnectionMetaTypeGDA_CONNECTION_META_TABLES">GDA_CONNECTION_META_TABLES</a></span></dt>
<dt><span class="sect2"><a href="connection.html#GdaConnectionMetaTypeGDA_CONNECTION_META_VIEWS">GDA_CONNECTION_META_VIEWS</a></span></dt>
<dt><span class="sect2"><a href="connection.html#GdaConnectionMetaTypeGDA_CONNECTION_META_FIELDS">GDA_CONNECTION_META_FIELDS</a></span></dt>
<dt><span class="sect2"><a href="connection.html#GdaConnectionMetaTypeGDA_CONNECTION_META_INDEXES">GDA_CONNECTION_META_INDEXES</a></span></dt>
</dl></dd>
</dl></div>
<p>
	The <span class="application">Libgda</span> library allows several connections to databases to be opened at once.
	Once a connection (manipulated through the <a class="link" href="GdaConnection.html" title="GdaConnection">GdaConnection</a> object)
	has been created and is opened, it is able to proceed <a class="link" href="GdaStatement.html" title="GdaStatement">GdaStatement</a> statements.
      </p>
<p>
	Each <a class="link" href="GdaStatement.html" title="GdaStatement">GdaStatement</a> can only hold one SQL statement (such as SELECT, INSERT,
	CREATE TABLE, BEGIN, etc); statements can be grouped together into  <a class="link" href="GdaBatch.html" title="GdaBatch">GdaBatch</a> batches
	objects. There are two ways for creating a <a class="link" href="GdaStatement.html" title="GdaStatement">GdaStatement</a> object:
	</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
<p>
	       either by passing an SQL string to a parser (a <a class="link" href="GdaSqlParser.html" title="GdaSqlParser">GdaSqlParser</a>).
	     </p>
<p>
	       <span class="application">Libgda</span> unifies the way variables (also known as "placeholders") are defined (because each database type
	       has its own syntax for doing so); consult the <a class="link" href="GdaSqlParser.html" title="GdaSqlParser">GdaSqlParser</a> object's
	       documentation for a description of this syntax.
	     </p>
</li>
<li class="listitem"><p>by building it from its structure: see the 
	       <a class="link" href="libgda-5.0-GdaSqlStatement.html#GdaSqlStatement" title="GdaSqlStatement">GdaSqlStatement</a> for reference.
	       However keep in mind that this API is meant to be used primarily by database
	       provider's implementations and for <span class="application">Libgda</span>'s internal usage. A more user friendly
	       API will be added in the future.
	   </p></li>
</ul></div>
<p>

      </p>
<p>
	The following schema illustrates how a statement is created and executed:
	</p>
<div class="mediaobject"><img src="GdaStatement.png" alt="Statement execution illustrated"></div>
<p>
      </p>
<p>

      </p>
<p>
	As each database implements its own SQL variant (all variants more or less close to the SQL92 or SQL99 standards), the
	<span class="application">Libgda</span> library allows one to use either a generic SQL parser, or a parser provided by each database adapter (database
	provider), through the <a class="link" href="GdaConnection.html#gda-connection-create-parser" title="gda_connection_create_parser ()">gda_connection_create_parser()</a> method.
      </p>
<p>
	The following schema illustrates how a statement is executed:
	</p>
<div class="mediaobject"><img src="howto-exec.png" alt="Statement execution illustrated"></div>
<p>
      </p>
<div class="sect1">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="GdaConnectionMetaTypeHead"></a>Description of the data model returned by gda_connection_get_meta_store_data()</h2></div></div></div>
<p>
    The <a class="link" href="GdaConnection.html#gda-connection-get-meta-store-data" title="gda_connection_get_meta_store_data ()">gda_connection_get_meta_store_data()</a> method allows
    one to get the meta-data information about a database such as its structure (schema). The following table describes
    the actual data retrieved by each <a class="link" href="GdaConnection.html#GdaConnectionMetaType" title="enum GdaConnectionMetaType">GdaConnectionMetaType</a> type of request.
  </p>
<div class="sect2">
<div class="titlepage"><div><div><h3 class="title">
<a name="GdaConnectionMetaTypeGDA_CONNECTION_META_NAMESPACES"></a>GDA_CONNECTION_META_NAMESPACES</h3></div></div></div>
<p>Lists the namespaces (also known as "schemas" by PostgreSQL).
    </p>
<p>Optional filter:
      </p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>"name" (G_TYPE_STRING): the name of the namespace</p></li></ul></div>
<p>
    </p>
<p>Columns of the returned data model:
      </p>
<div class="table">
<a name="id-1.3.6.17.3.4.1"></a><p class="title"><b>Table 4. </b></p>
<div class="table-contents"><table class="table" border="1">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th align="justify">Column #</th>
<th align="justify">Type</th>
<th align="justify">Description</th>
</tr></thead>
<tbody>
<tr>
<td align="justify">0</td>
<td align="justify">G_TYPE_STRING</td>
<td align="justify">Namespace name</td>
</tr>
<tr>
<td align="justify">1</td>
<td align="justify">G_TYPE_STRING</td>
<td align="justify">Namespace owner</td>
</tr>
<tr>
<td align="justify">2</td>
<td align="justify">G_TYPE_BOOLEAN</td>
<td align="justify">TRUE if this namespace is reserved for internal use by the database</td>
</tr>
</tbody>
</table></div>
</div>
<p><br class="table-break">
    </p>
</div>
<div class="sect2">
<div class="titlepage"><div><div><h3 class="title">
<a name="GdaConnectionMetaTypeGDA_CONNECTION_META_TYPES"></a>GDA_CONNECTION_META_TYPES</h3></div></div></div>
<p>Lists all the data types
    </p>
<p>Optional filter:
      </p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>"name" (G_TYPE_STRING): a type name</p></li></ul></div>
<p>
    </p>
<p>Columns of the returned data model:
      </p>
<div class="table">
<a name="id-1.3.6.17.4.4.1"></a><p class="title"><b>Table 5. </b></p>
<div class="table-contents"><table class="table" border="1">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th align="justify">Column #</th>
<th align="justify">Type</th>
<th align="justify">Description</th>
</tr></thead>
<tbody>
<tr>
<td align="justify">0</td>
<td align="justify">G_TYPE_STRING</td>
<td align="justify">Type name</td>
</tr>
<tr>
<td align="justify">1</td>
<td align="justify">G_TYPE_STRING</td>
<td align="justify">Type's associated GType type</td>
</tr>
<tr>
<td align="justify">2</td>
<td align="justify">G_TYPE_STRING</td>
<td align="justify">Type's comments</td>
</tr>
<tr>
<td align="justify">3</td>
<td align="justify">G_TYPE_STRING</td>
<td align="justify">Synonyms (separated by commas)</td>
</tr>
</tbody>
</table></div>
</div>
<p><br class="table-break">
    </p>
</div>
<div class="sect2">
<div class="titlepage"><div><div><h3 class="title">
<a name="GdaConnectionMetaTypeGDA_CONNECTION_META_TABLES"></a>GDA_CONNECTION_META_TABLES</h3></div></div></div>
<p>Lists the tables which are "visible" without having to specify a schema name.
    </p>
<p>Optional filter:
      </p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>"name" (G_TYPE_STRING): the name of the table</p></li></ul></div>
<p>
    </p>
<p>Columns of the returned data model:
      </p>
<div class="table">
<a name="id-1.3.6.17.5.4.1"></a><p class="title"><b>Table 6. </b></p>
<div class="table-contents"><table class="table" border="1">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th align="justify">Column #</th>
<th align="justify">Type</th>
<th align="justify">Description</th>
</tr></thead>
<tbody>
<tr>
<td align="justify">0</td>
<td align="justify">G_TYPE_STRING</td>
<td align="justify">Table's name</td>
</tr>
<tr>
<td align="justify">1</td>
<td align="justify">G_TYPE_STRING</td>
<td align="justify">Namespace in which the table is</td>
</tr>
<tr>
<td align="justify">2</td>
<td align="justify">G_TYPE_STRING</td>
<td align="justify">Table's complete name (ie. schema name + table name)</td>
</tr>
<tr>
<td align="justify">3</td>
<td align="justify">G_TYPE_STRING</td>
<td align="justify">Table owner</td>
</tr>
<tr>
<td align="justify">4</td>
<td align="justify">G_TYPE_STRING</td>
<td align="justify">Table's associated comments</td>
</tr>
</tbody>
</table></div>
</div>
<p><br class="table-break">
    </p>
</div>
<div class="sect2">
<div class="titlepage"><div><div><h3 class="title">
<a name="GdaConnectionMetaTypeGDA_CONNECTION_META_VIEWS"></a>GDA_CONNECTION_META_VIEWS</h3></div></div></div>
<p>Lists the views.
    </p>
<p>Optional filter:
      </p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>"name" (G_TYPE_STRING): the name of the view</p></li></ul></div>
<p>
    </p>
<p>Columns of the returned data model:
      </p>
<div class="table">
<a name="id-1.3.6.17.6.4.1"></a><p class="title"><b>Table 7. </b></p>
<div class="table-contents"><table class="table" border="1">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th align="justify">Column #</th>
<th align="justify">Type</th>
<th align="justify">Description</th>
</tr></thead>
<tbody>
<tr>
<td align="justify">0</td>
<td align="justify">G_TYPE_STRING</td>
<td align="justify">View's name</td>
</tr>
<tr>
<td align="justify">1</td>
<td align="justify">G_TYPE_STRING</td>
<td align="justify">Namespace in which the view is</td>
</tr>
<tr>
<td align="justify">2</td>
<td align="justify">G_TYPE_STRING</td>
<td align="justify">View's complete name (if the view is not in the default namespace)</td>
</tr>
<tr>
<td align="justify">3</td>
<td align="justify">G_TYPE_STRING</td>
<td align="justify">View owner</td>
</tr>
<tr>
<td align="justify">4</td>
<td align="justify">G_TYPE_STRING</td>
<td align="justify">View's associated comments</td>
</tr>
</tbody>
</table></div>
</div>
<p><br class="table-break">
    </p>
</div>
<div class="sect2">
<div class="titlepage"><div><div><h3 class="title">
<a name="GdaConnectionMetaTypeGDA_CONNECTION_META_FIELDS"></a>GDA_CONNECTION_META_FIELDS</h3></div></div></div>
<p>Lists a table or view's fields
    </p>
<p>Mandatory filter:
      </p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>"name" (G_TYPE_STRING): the name of the table or view</p></li></ul></div>
<p>
    </p>
<p>Optional filter:
      </p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>"field_name" (G_TYPE_STRING): the name of a field</p></li></ul></div>
<p>
    </p>
<p>Columns of the returned data model:
      </p>
<div class="table">
<a name="id-1.3.6.17.7.5.1"></a><p class="title"><b>Table 8. </b></p>
<div class="table-contents"><table class="table" border="1">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th align="justify">Column #</th>
<th align="justify">Type</th>
<th align="justify">Description</th>
</tr></thead>
<tbody>
<tr>
<td align="justify">0</td>
<td align="justify">G_TYPE_STRING</td>
<td align="justify">Field's name</td>
</tr>
<tr>
<td align="justify">1</td>
<td align="justify">G_TYPE_STRING</td>
<td align="justify">Field's data type</td>
</tr>
<tr>
<td align="justify">2</td>
<td align="justify">G_TYPE_STRING</td>
<td align="justify">Field's GType type</td>
</tr>
<tr>
<td align="justify">3</td>
<td align="justify">G_TYPE_INT</td>
<td align="justify">Field's size</td>
</tr>
<tr>
<td align="justify">4</td>
<td align="justify">G_TYPE_INT</td>
<td align="justify">Field's scale</td>
</tr>
<tr>
<td align="justify">5</td>
<td align="justify">G_TYPE_BOOLEAN</td>
<td align="justify">TRUE if the field does not have a NOT NULL constraint</td>
</tr>
<tr>
<td align="justify">6</td>
<td align="justify">G_TYPE_STRING</td>
<td align="justify">Field's default value</td>
</tr>
<tr>
<td align="justify">7</td>
<td align="justify">G_TYPE_STRING</td>
<td align="justify">Extra attributes for the field as a comma separated values list of keywords (AUTO_INCREMENT)</td>
</tr>
</tbody>
</table></div>
</div>
<p><br class="table-break">
    </p>
</div>
<div class="sect2">
<div class="titlepage"><div><div><h3 class="title">
<a name="GdaConnectionMetaTypeGDA_CONNECTION_META_INDEXES"></a>GDA_CONNECTION_META_INDEXES</h3></div></div></div>
<p>Lists a table's associated indexes
    </p>
<p>Mandatory filter:
      </p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>"name" (G_TYPE_STRING): the name of the table</p></li></ul></div>
<p>
    </p>
<p>Optional filter:
      </p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>"index_name" (G_TYPE_STRING): the name of an index</p></li></ul></div>
<p>
    </p>
<p>Columns of the returned data model:
      </p>
<div class="table">
<a name="id-1.3.6.17.8.5.1"></a><p class="title"><b>Table 9. </b></p>
<div class="table-contents"><table class="table" border="1">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th align="justify">Column #</th>
<th align="justify">Type</th>
<th align="justify">Description</th>
</tr></thead>
<tbody>
<tr>
<td align="justify">0</td>
<td align="justify">G_TYPE_STRING</td>
<td align="justify">Table's name</td>
</tr>
<tr>
<td align="justify">1</td>
<td align="justify">G_TYPE_STRING</td>
<td align="justify">Namespace in which the table is</td>
</tr>
<tr>
<td align="justify">2</td>
<td align="justify">G_TYPE_STRING</td>
<td align="justify">Index's name</td>
</tr>
<tr>
<td align="justify">3</td>
<td align="justify">G_TYPE_STRING</td>
<td align="justify">Column's name involved in the index</td>
</tr>
<tr>
<td align="justify">4</td>
<td align="justify">G_TYPE_INT</td>
<td align="justify">Sequence order</td>
</tr>
<tr>
<td align="justify">5</td>
<td align="justify">G_TYPE_STRING</td>
<td align="justify">Index's type</td>
</tr>
</tbody>
</table></div>
</div>
<p><br class="table-break">
    </p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.