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
|
<!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>Errors - 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 active" aria-current="page" 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="./" class="dropdown-item active" aria-current="page">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" role="button" data-bs-toggle="dropdown" aria-expanded="false">Backends</a>
<ul class="dropdown-menu">
<li>
<a href="../backends/" class="dropdown-item">Features</a>
</li>
<li>
<a href="../backends/db2/" class="dropdown-item">DB2</a>
</li>
<li>
<a href="../backends/firebird/" class="dropdown-item">Firebird</a>
</li>
<li>
<a href="../backends/mysql/" class="dropdown-item">MySQL</a>
</li>
<li>
<a href="../backends/odbc/" class="dropdown-item">ODBC</a>
</li>
<li>
<a href="../backends/oracle/" class="dropdown-item">Oracle</a>
</li>
<li>
<a href="../backends/postgresql/" class="dropdown-item">PostgreSQL</a>
</li>
<li>
<a href="../backends/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="../procedures/" class="nav-link">
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
<li class="nav-item">
<a rel="next" href="../logging/" 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/errors.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="#errors" class="nav-link">Errors</a>
<ul class="nav flex-column">
<li class="nav-item" data-bs-level="2"><a href="#backend-specific-errors" class="nav-link">Backend-specific errors</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-bs-level="2"><a href="#firebird" class="nav-link">Firebird</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-bs-level="2"><a href="#mysql" class="nav-link">MySQL</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-bs-level="2"><a href="#odbc" class="nav-link">ODBC</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-bs-level="2"><a href="#oracle" class="nav-link">Oracle</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-bs-level="2"><a href="#postgresql" class="nav-link">PostgreSQL</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-bs-level="2"><a href="#sqlite" class="nav-link">SQLite</a>
<ul class="nav flex-column">
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div></div>
<div class="col-md-9" role="main">
<h1 id="errors">Errors</h1>
<p>All DB-related errors manifest themselves as exceptions of type <code>soci_error</code>, which is derived from <code>std::runtime_error</code>.
This allows to handle database errors within the standard exception framework:</p>
<pre><code class="language-cpp">int main()
{
try
{
// regular code
}
catch (std::exception const & e)
{
cerr << "Bang! " << e.what() << endl;
}
}
</code></pre>
<p>The <code>soci_error</code> class exposes the following public functions:</p>
<p>The <code>get_error_message() const</code> function returns <code>std::string</code> with a brief error message, without any additional information that can be present in the full error message returned by <code>what()</code>.</p>
<p>The <code>get_error_category() const</code> function returns one of the <code>error_category</code> enumeration values, which allows the user to portably react to some subset of common errors.
For example, <code>connection_error</code> or <code>constraint_violation</code> have meanings that are common across different database backends, even though the actual mechanics might differ.
Please note that error categories are not universally supported and there is no claim that all possible errors that are reported by the database server are covered or interpreted. If the error category is not recognized by the backend, it defaults to <code>unknown</code>.</p>
<h2 id="backend-specific-errors">Backend-specific errors</h2>
<p>Some errors originate in SOCI itself, while others are thrown by the database-specific backend and may contain extra information about the error provided by the database itself. <code>soci_error</code> provides <code>get_backend_name()</code> function which returns a non-empty string with the name of the backend that threw the error to distinguish such errors from the errors generated by SOCI itself, for which this function returns an empty string.</p>
<p>For the backend-specific errors, either <code>get_backend_error_code()</code>, returning backend-specific integer error code, or <code>get_sqlstate()</code>, returning a 5 character string describing the error in more details, can be used to identify the error more precisely. <code>get_backend_error_code()</code> returns 0 if integer error codes are not supported by the backend and <code>get_sqlstate()</code> returns an empty string if the backend doesn't provide <code>SQLSTATE</code>, please see the backend-specific sections below for more details.</p>
<p>These functions can be used without including the backend-specific headers, but this means that the backend name string must be checked manually, instead of relying on catching the correct exception class. Here is an example of doing it:</p>
<pre><code class="language-cpp">#include <soci/soci.h>
#include <iostream>
using namespace std;
int main()
{
try
{
// code using SOCI
}
catch (soci::exception const & e)
{
std::string const backend = e.get_backend_name();
if ( backend == "postgresql" )
{
if ( e.get_sqlstate() == "54001" )
{
// Handle PostgreSQL "Statement too complex" error.
}
}
else if ( backend == "sqlite3" )
{
if ( e.get_backend_error_code() == 18 /* SQLITE_TOOBIG */ )
{
// Handle SQLite "Statement too long" error.
}
}
else
{
cerr << "Some other error: " << e.what() << endl;
}
}
}
</code></pre>
<h2 id="firebird">Firebird</h2>
<p>The Firebird backend can throw instances of the <code>firebird_soci_error</code>, which is publicly derived from <code>soci_error</code> and overrides <code>get_backend_error_code()</code> to return the first Firebird status code, if available, or 0 otherwise. This exception class also has a public member field <code>status_</code> which is a vector containing all status codes associated with the error:</p>
<pre><code class="language-cpp">#include <soci/soci.h>
#include <soci/firebird/soci-firebird.h>
int main()
{
try
{
// regular code
}
catch (soci::firebird_soci_error const & e)
{
cerr << "Firebird error: " << e.get_backend_error_code()
<< " " << e.what() << endl;
// If necessary, e.status_ vector may be examined for additional status codes.
}
catch (soci::exception const & e)
{
cerr << "Some other error: " << e.what() << endl;
}
}
</code></pre>
<h2 id="mysql">MySQL</h2>
<p>The MySQL backend can throw instances of the <code>mysql_soci_error</code>, which is publicly derived from <code>soci_error</code> and overrides <code>get_backend_error_code()</code> to return the MySQL error code (as returned by <code>mysql_errno()</code>):</p>
<pre><code class="language-cpp">#include <soci/soci.h>
#include <soci/mysql/soci-mysql.h>
int main()
{
try
{
// regular code
}
catch (soci::mysql_soci_error const & e)
{
cerr << "MySQL error: " << e.get_backend_error_code()
<< " " << e.what() << endl;
}
catch (soci::exception const & e)
{
cerr << "Some other error: " << e.what() << endl;
}
}
</code></pre>
<h2 id="odbc">ODBC</h2>
<p>The ODBC backend can throw instances of the <code>odbc_soci_error</code>, which is publicly derived from <code>soci_error</code> and overrides both <code>get_backend_error_code()</code> and <code>get_sqlstate()</code> to return the numeric ODBC error and <code>SQLSTATE</code> associated with it, respectively:</p>
<pre><code class="language-cpp">#include <soci/soci.h>
#include <soci/odbc/soci-odbc.h>
int main()
{
try
{
// regular code
}
catch (soci::odbc_soci_error const & e)
{
cerr << "ODBC error: " << e.get_backend_error_code()
<< " " << e.get_sqlstate() << " " << e.what() << endl;
}
catch (soci::exception const & e)
{
cerr << "Some other error: " << e.what() << endl;
}
}
</code></pre>
<h2 id="oracle">Oracle</h2>
<p>The Oracle backend can throw the instances of the <code>oracle_soci_error</code>, which is publicly derived from <code>soci_error</code> and overrides <code>get_backend_error_code()</code> to return the Oracle error code:</p>
<pre><code class="language-cpp">#include <soci/soci.h>
#include <soci/oracle/soci-oracle.h>
int main()
{
try
{
// regular code
}
catch (soci::oracle_soci_error const & e)
{
cerr << "Oracle error: " << e.get_backend_error_code()
<< " " << e.what() << endl;
}
catch (soci::exception const & e)
{
cerr << "Some other error: " << e.what() << endl;
}
}
</code></pre>
<h2 id="postgresql">PostgreSQL</h2>
<p>The PostgreSQL backend can throw the instances of the <code>postgresql_soci_error</code>, which is publicly derived from <code>soci_error</code> and overrides <code>get_sqlstate()</code> member function to return PostgreSQL native error code, which is a 5 character <code>SQLSTATE</code> string.</p>
<pre><code class="language-cpp">#include <soci/soci.h>
#include <soci/postgresql/soci-postgresql.h>
int main()
{
try
{
// regular code
}
catch (soci::postgresql_soci_error const & e)
{
cerr << "PostgreSQL error: " << e.get_sqlstate()
<< " " << e.what() << endl;
}
catch (soci::exception const & e)
{
cerr << "Some other error: " << e.what() << endl;
}
}
</code></pre>
<h2 id="sqlite">SQLite</h2>
<p>The SQLite backend can throw the instances of the <code>sqlite3_soci_error</code>, which is publicly derived from <code>soci_error</code> and overrides <code>get_backend_error_code()</code> to return the (possibly extended) SQLite result code:</p>
<pre><code class="language-cpp">#include <soci/soci.h>
#include <soci/sqlite3/soci-sqlite3.h>
int main()
{
try
{
// regular code
}
catch (soci::sqlite3_soci_error const & e)
{
cerr << "SQLite error: " << e.get_backend_error_code()
<< " " << e.what() << endl;
}
catch (soci::exception const & e)
{
cerr << "Some other error: " << e.what() << endl;
}
}
</code></pre></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>
|
