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
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
|
<!DOCTYPE html>
<html lang="en" data-bs-theme="light">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="../../img/favicon.ico">
<title>Firebird - SOCI (4.1.2)</title>
<link href="../../css/bootstrap.min.css" rel="stylesheet">
<link href="../../css/fontawesome.min.css" rel="stylesheet">
<link href="../../css/brands.min.css" rel="stylesheet">
<link href="../../css/solid.min.css" rel="stylesheet">
<link href="../../css/v4-font-face.min.css" rel="stylesheet">
<link href="../../css/base.css" rel="stylesheet">
<link id="hljs-light" rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" >
<link id="hljs-dark" rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github-dark.min.css" disabled>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
<script>hljs.highlightAll();</script>
</head>
<body>
<div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary">
<div class="container">
<a class="navbar-brand" href="../..">SOCI (4.1.2)</a>
<!-- Expander button -->
<button type="button" class="navbar-toggler" data-bs-toggle="collapse" data-bs-target="#navbar-collapse" aria-controls="navbar-collapse" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<!-- Expanded navigation -->
<div id="navbar-collapse" class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav">
<li class="nav-item">
<a href="../.." class="nav-link">Home</a>
</li>
<li class="nav-item dropdown">
<a href="#" class="nav-link dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false">Overview</a>
<ul class="dropdown-menu">
<li>
<a href="../../quickstart/" class="dropdown-item">Getting Started</a>
</li>
<li>
<a href="../../installation/" class="dropdown-item">Installation</a>
</li>
<li>
<a href="../../structure/" class="dropdown-item">Library Structure</a>
</li>
<li>
<a href="../../license/" class="dropdown-item">License</a>
</li>
<li>
<a href="../../faq/" class="dropdown-item">FAQ</a>
</li>
</ul>
</li>
<li class="nav-item dropdown">
<a href="#" class="nav-link dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false">User Guide</a>
<ul class="dropdown-menu">
<li>
<a href="../../connections/" class="dropdown-item">Connections</a>
</li>
<li>
<a href="../../queries/" class="dropdown-item">Queries</a>
</li>
<li>
<a href="../../binding/" class="dropdown-item">Data Binding</a>
</li>
<li>
<a href="../../indicators/" class="dropdown-item">Data Indicators</a>
</li>
<li>
<a href="../../types/" class="dropdown-item">Data Types</a>
</li>
<li>
<a href="../../lobs/" class="dropdown-item">LOBs</a>
</li>
<li>
<a href="../../statements/" class="dropdown-item">Statements</a>
</li>
<li>
<a href="../../transactions/" class="dropdown-item">Transactions</a>
</li>
<li>
<a href="../../procedures/" class="dropdown-item">Procedures</a>
</li>
<li>
<a href="../../errors/" class="dropdown-item">Errors</a>
</li>
<li>
<a href="../../logging/" class="dropdown-item">Logging</a>
</li>
<li>
<a href="../../interfaces/" class="dropdown-item">Interfaces</a>
</li>
</ul>
</li>
<li class="nav-item dropdown">
<a href="#" class="nav-link dropdown-toggle active" aria-current="page" role="button" data-bs-toggle="dropdown" aria-expanded="false">Backends</a>
<ul class="dropdown-menu">
<li>
<a href="../" class="dropdown-item">Features</a>
</li>
<li>
<a href="../db2/" class="dropdown-item">DB2</a>
</li>
<li>
<a href="./" class="dropdown-item active" aria-current="page">Firebird</a>
</li>
<li>
<a href="../mysql/" class="dropdown-item">MySQL</a>
</li>
<li>
<a href="../odbc/" class="dropdown-item">ODBC</a>
</li>
<li>
<a href="../oracle/" class="dropdown-item">Oracle</a>
</li>
<li>
<a href="../postgresql/" class="dropdown-item">PostgreSQL</a>
</li>
<li>
<a href="../sqlite3/" class="dropdown-item">SQLite3</a>
</li>
</ul>
</li>
<li class="nav-item dropdown">
<a href="#" class="nav-link dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false">Miscellaneous</a>
<ul class="dropdown-menu">
<li>
<a href="../../beyond/" class="dropdown-item">Beyond SQL</a>
</li>
<li>
<a href="../../multithreading/" class="dropdown-item">Multi-threading</a>
</li>
<li>
<a href="../../boost/" class="dropdown-item">Boost</a>
</li>
<li>
<a href="../../utilities/" class="dropdown-item">Utilities</a>
</li>
<li>
<a href="../../vagrant/" class="dropdown-item">Vagrant</a>
</li>
</ul>
</li>
<li class="nav-item dropdown">
<a href="#" class="nav-link dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false">API</a>
<ul class="dropdown-menu">
<li>
<a href="../../api/client/" class="dropdown-item">Client API</a>
</li>
<li>
<a href="../../api/backend/" class="dropdown-item">Backend API</a>
</li>
<li class="dropdown-submenu">
<a href="#" class="dropdown-item">Ada</a>
<ul class="dropdown-menu">
<li>
<a href="../../languages/ada/" class="dropdown-item">Ada Bindings</a>
</li>
<li>
<a href="../../languages/ada/concepts/" class="dropdown-item">Ada Concepts</a>
</li>
<li>
<a href="../../languages/ada/idioms/" class="dropdown-item">Ada Idioms</a>
</li>
<li>
<a href="../../languages/ada/reference/" class="dropdown-item">Ada API Reference</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<ul class="nav navbar-nav ms-md-auto">
<li class="nav-item">
<a href="#" class="nav-link" data-bs-toggle="modal" data-bs-target="#mkdocs_search_modal">
<i class="fa fa-search"></i> Search
</a>
</li>
<li class="nav-item">
<a rel="prev" href="../db2/" class="nav-link">
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
<li class="nav-item">
<a rel="next" href="../mysql/" class="nav-link">
Next <i class="fa fa-arrow-right"></i>
</a>
</li>
<li class="nav-item">
<a href="https://github.com/SOCI/soci/edit/master/docs/backends/firebird.md" class="nav-link"><i class="fa-brands fa-github"></i> Edit on GitHub</a>
</li>
</ul>
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="col-md-3"><div class="navbar-expand-md bs-sidebar hidden-print affix" role="complementary">
<div class="navbar-header">
<button type="button" class="navbar-toggler collapsed" data-bs-toggle="collapse" data-bs-target="#toc-collapse" title="Table of Contents">
<span class="fa fa-angle-down"></span>
</button>
</div>
<div id="toc-collapse" class="navbar-collapse collapse card bg-body-tertiary">
<ul class="nav flex-column">
<li class="nav-item" data-bs-level="1"><a href="#firebird-backend-reference" class="nav-link">Firebird Backend Reference</a>
<ul class="nav flex-column">
<li class="nav-item" data-bs-level="2"><a href="#prerequisites" class="nav-link">Prerequisites</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-bs-level="2"><a href="#connecting-to-the-database" class="nav-link">Connecting to the Database</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-bs-level="2"><a href="#soci-feature-support" class="nav-link">SOCI Feature Support</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-bs-level="2"><a href="#native-api-access" class="nav-link">Native API Access</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-bs-level="2"><a href="#backend-specific-extensions" class="nav-link">Backend-specific extensions</a>
<ul class="nav flex-column">
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div></div>
<div class="col-md-9" role="main">
<h1 id="firebird-backend-reference">Firebird Backend Reference</h1>
<p>SOCI backend for accessing Firebird database.</p>
<h2 id="prerequisites">Prerequisites</h2>
<h3 id="supported-versions">Supported Versions</h3>
<p>The SOCI Firebird backend supports versions of Firebird from 1.5 to 2.5 and can be used with
either the client-server or embedded Firebird libraries.
The former is the default, to select the latter set <code>SOCI_FIREBIRD_EMBEDDED</code> CMake option to <code>ON</code>
value when building.</p>
<h3 id="tested-platforms">Tested Platforms</h3>
<table>
<thead>
<tr>
<th>Firebird</th>
<th>OS</th>
<th>Compiler</th>
</tr>
</thead>
<tbody>
<tr>
<td>1.5.2.4731</td>
<td>SunOS 5.10</td>
<td>g++ 3.4.3</td>
</tr>
<tr>
<td>1.5.2.4731</td>
<td>Windows XP</td>
<td>Visual C++ 8.0</td>
</tr>
<tr>
<td>1.5.3.4870</td>
<td>Windows XP</td>
<td>Visual C++ 8.0 Professional</td>
</tr>
<tr>
<td>2.5.2.26540</td>
<td>Debian GNU/Linux 7</td>
<td>g++ 4.7.2</td>
</tr>
<tr>
<td>2.5.8.27089</td>
<td>macOS High Sierra 10.13.5</td>
<td>AppleClang 9.1.0.9020039</td>
</tr>
</tbody>
</table>
<h3 id="required-client-libraries">Required Client Libraries</h3>
<p>The Firebird backend requires Firebird's <code>libfbclient</code> client library.
For example, on Ubuntu Linux, for example, <code>firebird-dev</code> package and its dependencies are required.</p>
<h2 id="connecting-to-the-database">Connecting to the Database</h2>
<p>To establish a connection to a Firebird database, create a Session object using the firebird
backend factory together with a connection string:</p>
<pre><code class="language-cpp">BackEndFactory const &backEnd = firebird;
session sql(backEnd, "service=/usr/local/firbird/db/test.fdb user=SYSDBA password=masterkey");
</code></pre>
<p>or simply:</p>
<pre><code class="language-cpp">session sql(firebird, "service=/usr/local/firbird/db/test.fdb user=SYSDBA password=masterkey");
</code></pre>
<p>The set of parameters used in the connection string for Firebird is:</p>
<ul>
<li>service</li>
<li>user</li>
<li>password</li>
<li>role</li>
<li>charset</li>
</ul>
<p>The following parameters have to be provided as part of the connection string : <em>service</em>, <em>user</em>,
<em>password</em>. Role and charset parameters are optional.</p>
<p>Once you have created a <code>session</code> object as shown above, you can use it to access the database, for example:</p>
<pre><code class="language-cpp">int count;
sql << "select count(*) from user_tables", into(count);
</code></pre>
<p>(See the <a href="../../connections/">connection</a> and <a href="../../binding/">data binding</a> documentation
for general information on using the <code>session</code> class.)</p>
<h2 id="soci-feature-support">SOCI Feature Support</h2>
<h3 id="dynamic-binding">Dynamic Binding</h3>
<p>The Firebird backend supports the use of the SOCI <code>row</code> class, which facilitates retrieval of data whose
type is not known at compile time.</p>
<p>When calling <code>row::get<T>()</code>, the type you should pass as T depends upon the underlying database type.
For the Firebird backend, this type mapping is:</p>
<table>
<thead>
<tr>
<th>Firebird Data Type</th>
<th>SOCI Data Type (<code>data_type</code>)</th>
<th><code>row::get<T></code> specializations</th>
</tr>
</thead>
<tbody>
<tr>
<td>numeric, decimal (where scale > 0)</td>
<td>dt_double</td>
<td>double</td>
</tr>
<tr>
<td>numeric, decimal [^1] (where scale = 0)</td>
<td>dt_integer, dt_double</td>
<td>int, double</td>
</tr>
<tr>
<td>double precision, float</td>
<td>dt_double</td>
<td>double</td>
</tr>
<tr>
<td>smallint, integer</td>
<td>dt_integer</td>
<td>int</td>
</tr>
<tr>
<td>char, varchar</td>
<td>dt_string</td>
<td>std::string</td>
</tr>
<tr>
<td>date, time, timestamp</td>
<td>dt_date</td>
<td>std::tm</td>
</tr>
</tbody>
</table>
<table>
<thead>
<tr>
<th>Firebird Data Type</th>
<th>SOCI Data Type (<code>db_type</code>)</th>
<th><code>row::get<T></code> specializations</th>
</tr>
</thead>
<tbody>
<tr>
<td>numeric, decimal (where scale > 0)</td>
<td>db_double</td>
<td>double</td>
</tr>
<tr>
<td>numeric, decimal [^1] (where scale = 0)</td>
<td>db_int16/db_int32/db_int64, db_double</td>
<td>int16_t/int32_t/int64_t, double</td>
</tr>
<tr>
<td>double precision, float</td>
<td>db_double</td>
<td>double</td>
</tr>
<tr>
<td>smallint</td>
<td>db_int16</td>
<td>int16_t</td>
</tr>
<tr>
<td>integer</td>
<td>db_int32</td>
<td>int32_t</td>
</tr>
<tr>
<td>bigint</td>
<td>db_int64</td>
<td>int64_t</td>
</tr>
<tr>
<td>char, varchar</td>
<td>db_string</td>
<td>std::string</td>
</tr>
<tr>
<td>date, time, timestamp</td>
<td>db_date</td>
<td>std::tm</td>
</tr>
</tbody>
</table>
<p>[^1] There is also 64bit integer type for larger values which is
currently not supported.</p>
<p>(See the <a href="../../types/#dynamic-binding">dynamic resultset binding</a> documentation for general information
on using the <code>Row</code> class.)</p>
<h3 id="binding-by-name">Binding by Name</h3>
<p>In addition to <a href="../../binding/#binding-by-position">binding by position</a>, the Firebird backend supports
<a href="../../binding/#binding-by-name">binding by name</a>, via an overload of the <code>use()</code> function:</p>
<pre><code class="language-cpp">int id = 7;
sql << "select name from person where id = :id", use(id, "id")
</code></pre>
<p>It should be noted that parameter binding by name is supported only by means of emulation,
since the underlying API used by the backend doesn't provide this feature.</p>
<h3 id="bulk-operations">Bulk Operations</h3>
<p>The Firebird backend has full support for SOCI <a href="../../binding/#bulk-operations">bulk operations</a> interface.
This feature is also supported by emulation.</p>
<h3 id="transactions">Transactions</h3>
<p><a href="../../transactions/">Transactions</a> are also fully supported by the Firebird backend.
In fact, an implicit transaction is always started when using this backend if one hadn't been
started by explicitly calling <code>begin()</code> before. The current transaction is automatically
committed in <code>session</code> destructor.</p>
<h3 id="blob-data-type">BLOB Data Type</h3>
<p>The Firebird backend supports working with data stored in columns of type Blob,
via SOCI <a href="../../lobs/">BLOB</a> class.</p>
<p>It should by noted, that entire Blob data is fetched from database to allow random read and write access.
This is because Firebird itself allows only writing to a new Blob or reading from existing one -
modifications of existing Blob means creating a new one.
Firebird backend hides those details from user.</p>
<h3 id="rowid-data-type">RowID Data Type</h3>
<p>This feature is not supported by Firebird backend.</p>
<h3 id="nested-statements">Nested Statements</h3>
<p>This feature is not supported by Firebird backend.</p>
<h3 id="stored-procedures">Stored Procedures</h3>
<p>Firebird stored procedures can be executed by using SOCI <a href="../../procedures/">Procedure</a> class.</p>
<h2 id="native-api-access">Native API Access</h2>
<p>SOCI provides access to underlying datbabase APIs via several <code>get_backend()</code> functions,
as described in the <a href="../../beyond/">Beyond SOCI</a> documentation.</p>
<p>The Firebird backend provides the following concrete classes for navite API access:</p>
<table>
<thead>
<tr>
<th>Accessor Function</th>
<th>Concrete Class</th>
</tr>
</thead>
<tbody>
<tr>
<td>session_backend * session::get_backend()</td>
<td>firebird_session_backend</td>
</tr>
<tr>
<td>statement_backend * statement::get_backend()</td>
<td>firebird_statement_backend</td>
</tr>
<tr>
<td>blob_backend * blob::get_backend()</td>
<td>firebird_blob_backend</td>
</tr>
<tr>
<td>rowid_backend * rowid::get_backend()</td>
<td></td>
</tr>
</tbody>
</table>
<h2 id="backend-specific-extensions">Backend-specific extensions</h2>
<h3 id="firebird_soci_error">firebird_soci_error</h3>
<p>The Firebird backend can throw instances of class <code>firebird_soci_error</code>, which is publicly derived
from <code>soci_error</code> and has an additional public <code>status_</code> member containing the Firebird status vector.</p></div>
</div>
</div>
<footer class="col-md-12">
<hr>
<p>Copyright © 2017-2025 <a href="https://soci.sourceforge.net/people.html">SOCI Team</a>.</p>
<p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>
<script src="../../js/bootstrap.bundle.min.js"></script>
<script>
var base_url = "../..",
shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
</script>
<script src="../../js/base.js"></script>
<script src="../../search/main.js"></script>
<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true">
<div class="modal-dialog modal-lg">
<div class="modal-content">
<div class="modal-header">
<h4 class="modal-title" id="searchModalLabel">Search</h4>
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
</div>
<div class="modal-body">
<p>From here you can search these documents. Enter your search terms below.</p>
<form>
<div class="form-group">
<input type="search" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
</div>
</form>
<div id="mkdocs-search-results" data-no-results-text="No results found"></div>
</div>
<div class="modal-footer">
</div>
</div>
</div>
</div><div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
</div>
<div class="modal-body">
<table class="table">
<thead>
<tr>
<th style="width: 20%;">Keys</th>
<th>Action</th>
</tr>
</thead>
<tbody>
<tr>
<td class="help shortcut"><kbd>?</kbd></td>
<td>Open this help</td>
</tr>
<tr>
<td class="next shortcut"><kbd>n</kbd></td>
<td>Next page</td>
</tr>
<tr>
<td class="prev shortcut"><kbd>p</kbd></td>
<td>Previous page</td>
</tr>
<tr>
<td class="search shortcut"><kbd>s</kbd></td>
<td>Search</td>
</tr>
</tbody>
</table>
</div>
<div class="modal-footer">
</div>
</div>
</div>
</div>
</body>
</html>
|
