Qore Programming Language - C/C++ Library  0.8.13
DBI.h
Go to the documentation of this file.
1 /* -*- mode: c++; indent-tabs-mode: nil -*- */
2 /*
3  DBI.h
4 
5  Qore Programming Language
6 
7  Copyright (C) 2003 - 2017 Qore Technologies, s.r.o.
8 
9  Permission is hereby granted, free of charge, to any person obtaining a
10  copy of this software and associated documentation files (the "Software"),
11  to deal in the Software without restriction, including without limitation
12  the rights to use, copy, modify, merge, publish, distribute, sublicense,
13  and/or sell copies of the Software, and to permit persons to whom the
14  Software is furnished to do so, subject to the following conditions:
15 
16  The above copyright notice and this permission notice shall be included in
17  all copies or substantial portions of the Software.
18 
19  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
24  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25  DEALINGS IN THE SOFTWARE.
26 
27  Note that the Qore library is released under a choice of three open-source
28  licenses: MIT (as above), LGPL 2+, or GPL 2+; see README-LICENSE for more
29  information.
30 */
31 
32 #ifndef _QORE_DBI_H
33 #define _QORE_DBI_H
34 
36 
37 // DBI Driver capabilities
38 #define DBI_CAP_NONE 0
39 #define DBI_CAP_TIME_ZONE_SUPPORT (1 << 0)
40 #define DBI_CAP_CHARSET_SUPPORT (1 << 1)
41 #define DBI_CAP_TRANSACTION_MANAGEMENT (1 << 2)
42 #define DBI_CAP_STORED_PROCEDURES (1 << 3)
43 #define DBI_CAP_LOB_SUPPORT (1 << 4)
44 #define DBI_CAP_BIND_BY_VALUE (1 << 5)
45 #define DBI_CAP_BIND_BY_PLACEHOLDER (1 << 6)
46 #define DBI_CAP_HAS_EXECRAW (1 << 7)
47 #define DBI_CAP_HAS_STATEMENT (1 << 8)
48 #define DBI_CAP_HAS_SELECT_ROW (1 << 9)
49 #define DBI_CAP_HAS_NUMBER_SUPPORT (1 << 10)
50 #define DBI_CAP_HAS_OPTION_SUPPORT (1 << 11)
51 #define DBI_CAP_SERVER_TIME_ZONE (1 << 12)
52 #define DBI_CAP_AUTORECONNECT (1 << 13)
53 #define DBI_CAP_EVENTS (1 << 14)
54 #define DBI_CAP_HAS_DESCRIBE (1 << 15)
55 #define DBI_CAP_HAS_ARRAY_BIND (1 << 16)
56 #define DBI_CAP_HAS_RESULTSET_OUTPUT (1 << 17)
57 
58 #define BN_PLACEHOLDER 0
59 #define BN_VALUE 1
60 
61 #define DBI_DEFAULT_STR_LEN 512
62 
63 // DBI method codes
64 #define QDBI_METHOD_OPEN 1
65 #define QDBI_METHOD_CLOSE 2
66 #define QDBI_METHOD_SELECT 3
67 #define QDBI_METHOD_SELECT_ROWS 4
68 #define QDBI_METHOD_EXEC 5
69 #define QDBI_METHOD_COMMIT 6
70 #define QDBI_METHOD_ROLLBACK 7
71 #define QDBI_METHOD_BEGIN_TRANSACTION 8
72 #define QDBI_METHOD_ABORT_TRANSACTION_START 9
73 #define QDBI_METHOD_GET_SERVER_VERSION 10
74 #define QDBI_METHOD_GET_CLIENT_VERSION 11
75 #define QDBI_METHOD_EXECRAW 12
76 #define QDBI_METHOD_STMT_PREPARE 13
77 #define QDBI_METHOD_STMT_PREPARE_RAW 14
78 #define QDBI_METHOD_STMT_BIND 15
79 #define QDBI_METHOD_STMT_BIND_PLACEHOLDERS 16
80 #define QDBI_METHOD_STMT_BIND_VALUES 17
81 #define QDBI_METHOD_STMT_EXEC 18
82 #define QDBI_METHOD_STMT_FETCH_ROW 19
83 #define QDBI_METHOD_STMT_FETCH_ROWS 20
84 #define QDBI_METHOD_STMT_FETCH_COLUMNS 21
85 #define QDBI_METHOD_STMT_NEXT 22
86 #define QDBI_METHOD_STMT_CLOSE 23
87 #define QDBI_METHOD_STMT_AFFECTED_ROWS 24
88 #define QDBI_METHOD_STMT_GET_OUTPUT 25
89 #define QDBI_METHOD_STMT_GET_OUTPUT_ROWS 26
90 #define QDBI_METHOD_STMT_DEFINE 27
91 #define QDBI_METHOD_SELECT_ROW 28
92 #define QDBI_METHOD_OPT_SET 29
93 #define QDBI_METHOD_OPT_GET 30
94 #define QDBI_METHOD_STMT_DESCRIBE 31
95 #define QDBI_METHOD_DESCRIBE 32
96 #define QDBI_METHOD_STMT_FREE 33
97 
98 #define QDBI_VALID_CODES 33
99 
100 /* DBI EVENT Types
101  all DBI events must have the following keys:
102  - user: db username (if available)
103  - db: db name (if available)
104  - eventtype: integer event code
105 */
106 // warning events have the following additional keys: warning, desc, [info]
107 #define QDBI_EVENT_WARNING 1
108 
109 class Datasource;
110 class ExceptionSink;
111 class QoreString;
112 class QoreListNode;
113 class AbstractQoreNode;
114 class QoreHashNode;
115 class QoreNamespace;
116 class SQLStatement;
117 
118 // DBI method signatures - note that only get_client_version uses a "const Datasource"
119 // the others do not so that automatic reconnects can be supported (which will normally
120 // require writing to the Datasource)
121 
123 
127 typedef int (*q_dbi_open_t)(Datasource* ds, ExceptionSink* xsink);
128 
130 
134 typedef int (*q_dbi_close_t)(Datasource* ds);
135 
137 
144 typedef AbstractQoreNode* (*q_dbi_select_t)(Datasource* ds, const QoreString* str, const QoreListNode* args, ExceptionSink* xsink);
145 
147 
154 typedef AbstractQoreNode* (*q_dbi_select_rows_t)(Datasource* ds, const QoreString* str, const QoreListNode* args, ExceptionSink* xsink);
155 
157 
165 typedef QoreHashNode* (*q_dbi_select_row_t)(Datasource* ds, const QoreString* str, const QoreListNode* args, ExceptionSink* xsink);
166 
168 
175 typedef AbstractQoreNode* (*q_dbi_exec_t)(Datasource* ds, const QoreString* str, const QoreListNode* args, ExceptionSink* xsink);
176 
178 
184 typedef AbstractQoreNode* (*q_dbi_execraw_t)(Datasource* ds, const QoreString* str, ExceptionSink* xsink);
185 
187 
192 typedef int (*q_dbi_commit_t)(Datasource* ds, ExceptionSink* xsink);
193 
195 
200 typedef int (*q_dbi_rollback_t)(Datasource* ds, ExceptionSink* xsink);
201 
203 
209 
211 
219 
221 
226 typedef AbstractQoreNode* (*q_dbi_get_server_version_t)(Datasource* ds, ExceptionSink* xsink);
227 
229 
234 typedef AbstractQoreNode* (*q_dbi_get_client_version_t)(const Datasource* ds, ExceptionSink* xsink);
235 
236 // FIXME: document
238 
240 typedef int (*q_dbi_stmt_prepare_t)(SQLStatement* stmt, const QoreString& str, const QoreListNode* args, ExceptionSink* xsink);
241 
243 
245 typedef int (*q_dbi_stmt_prepare_raw_t)(SQLStatement* stmt, const QoreString& str, ExceptionSink* xsink);
246 
248 
250 typedef int (*q_dbi_stmt_bind_t)(SQLStatement* stmt, const QoreListNode& l, ExceptionSink* xsink);
251 
253 
255 typedef int (*q_dbi_stmt_exec_t)(SQLStatement* stmt, ExceptionSink* xsink);
256 
258 
261 
263 
265 typedef QoreHashNode* (*q_dbi_stmt_get_output_t)(SQLStatement* stmt, ExceptionSink* xsink);
266 
268 
270 typedef QoreHashNode* (*q_dbi_stmt_get_output_rows_t)(SQLStatement* stmt, ExceptionSink* xsink);
271 
272 typedef int (*q_dbi_stmt_define_t)(SQLStatement* stmt, ExceptionSink* xsink);
273 typedef QoreHashNode* (*q_dbi_stmt_fetch_row_t)(SQLStatement* stmt, ExceptionSink* xsink);
274 typedef QoreHashNode* (*q_dbi_stmt_fetch_columns_t)(SQLStatement* stmt, int rows, ExceptionSink* xsink);
275 typedef QoreListNode* (*q_dbi_stmt_fetch_rows_t)(SQLStatement* stmt, int rows, ExceptionSink* xsink);
276 typedef bool (*q_dbi_stmt_next_t)(SQLStatement* stmt, ExceptionSink* xsink);
277 typedef int (*q_dbi_stmt_close_t)(SQLStatement* stmt, ExceptionSink* xsink);
278 
279 typedef int (*q_dbi_option_set_t)(Datasource* ds, const char* opt, const AbstractQoreNode* val, ExceptionSink* xsink);
280 typedef AbstractQoreNode* (*q_dbi_option_get_t)(const Datasource* ds, const char* opt);
281 
283 
290 typedef QoreHashNode* (*q_dbi_describe_t)(Datasource* ds, const QoreString* str, const QoreListNode* args, ExceptionSink* xsink);
291 
292 #define DBI_OPT_NUMBER_OPT "optimal-numbers"
293 #define DBI_OPT_NUMBER_STRING "string-numbers"
294 #define DBI_OPT_NUMBER_NUMERIC "numeric-numbers"
295 #define DBI_OPT_TIMEZONE "timezone"
296 
297 
301  friend struct qore_dbi_mlist_private;
302 
303 private:
304  struct qore_dbi_mlist_private* priv; // private implementation
305 
306  // not implemented
308  DLLLOCAL qore_dbi_method_list& operator=(const qore_dbi_method_list&);
309 
310 public:
311  DLLEXPORT qore_dbi_method_list();
312  DLLEXPORT ~qore_dbi_method_list();
313 
314  // covers open, commit, rollback, and begin transaction
315  DLLEXPORT void add(int code, q_dbi_open_t method);
316  // for close
317  DLLEXPORT void add(int code, q_dbi_close_t method);
318  // covers select, select_rows, select, and exec
319  DLLEXPORT void add(int code, q_dbi_select_t method);
320  // covers select_row
321  DLLEXPORT void add(int code, q_dbi_select_row_t method);
322  // covers execRaw
323  DLLEXPORT void add(int code, q_dbi_execraw_t method);
324  // covers get_server_version
325  DLLEXPORT void add(int code, q_dbi_get_server_version_t method);
326  // covers get_client_version
327  DLLEXPORT void add(int code, q_dbi_get_client_version_t method);
328 
329  // covers prepare
330  DLLEXPORT void add(int code, q_dbi_stmt_prepare_t method);
331  // covers prepare_raw
332  DLLEXPORT void add(int code, q_dbi_stmt_prepare_raw_t method);
333  // covers bind, bind_placeholders, bind_values
334  DLLEXPORT void add(int code, q_dbi_stmt_bind_t method);
335  // covers exec, close, affected_rows, and define
336  DLLEXPORT void add(int code, q_dbi_stmt_exec_t method);
337  // covers fetch_row, get_output, and get_output_rows
338  DLLEXPORT void add(int code, q_dbi_stmt_fetch_row_t method);
339  // covers fetch_columns
340  DLLEXPORT void add(int code, q_dbi_stmt_fetch_columns_t method);
341  // covers fetch_rows
342  DLLEXPORT void add(int code, q_dbi_stmt_fetch_rows_t method);
343  // covers next
344  DLLEXPORT void add(int code, q_dbi_stmt_next_t method);
345 
346  // covers set option
347  DLLEXPORT void add(int code, q_dbi_option_set_t method);
348  // covers get option
349  DLLEXPORT void add(int code, q_dbi_option_get_t method);
350 
351  // for registering valid options
352  DLLEXPORT void registerOption(const char* name, const char* desc, const QoreTypeInfo* type = 0);
353 };
354 
356 
361 class DBIDriver {
362  friend struct qore_dbi_private;
363 
364 private:
366  struct qore_dbi_private* priv;
367 
369  DLLLOCAL DBIDriver(const DBIDriver&);
371  DLLLOCAL DBIDriver& operator=(const DBIDriver&);
372 
373 public:
375 
378  DLLEXPORT const char* getName() const;
379 
381  DLLEXPORT bool hasStatementAPI() const;
382 
384 
390  DLLEXPORT QoreHashNode* getOptionHash() const;
391 
392  DLLLOCAL DBIDriver(struct qore_dbi_private* p);
393  DLLLOCAL ~DBIDriver();
394 };
395 
396 struct qore_dbi_dlist_private;
397 
399 
404 private:
406  struct qore_dbi_dlist_private *priv;
407 
408  DLLLOCAL DBIDriver* find_intern(const char* name) const;
409 
410 public:
412 
419  DLLEXPORT DBIDriver* registerDriver(const char* name, const qore_dbi_method_list &methods, int caps);
420 
422 
429  DLLEXPORT DBIDriver* find(const char* name) const;
430 
432 
440  DLLEXPORT DBIDriver* find(const char* name, ExceptionSink* xsink) const;
441 
442  DLLLOCAL DBIDriverList();
443  DLLLOCAL ~DBIDriverList();
444  DLLLOCAL QoreListNode* getDriverList() const;
445 };
446 
448 DLLEXPORT extern DBIDriverList DBI;
449 
451 DLLEXPORT QoreHashNode* parseDatasource(const char* ds, ExceptionSink* xsink);
452 
454 DLLEXPORT void DBI_concat_numeric(QoreString* str, const AbstractQoreNode* v);
455 
457 
460 DLLEXPORT int DBI_concat_string(QoreString* str, const AbstractQoreNode* v, ExceptionSink* xsink);
461 
462 #endif // _QORE_DBI_H
AbstractQoreNode *(* q_dbi_execraw_t)(Datasource *ds, const QoreString *str, ExceptionSink *xsink)
signature for the DBI "execRawSQL" method - must be defined in each DBI driver
Definition: DBI.h:184
int(* q_dbi_abort_transaction_start_t)(Datasource *ds, ExceptionSink *xsink)
signature for the rollback method to be executed when the first statement in an explicit transaction ...
Definition: DBI.h:218
int(* q_dbi_close_t)(Datasource *ds)
signature for the DBI "close" method - must be defined in each DBI driver
Definition: DBI.h:134
This is the hash or associative list container type in Qore, dynamically allocated only...
Definition: QoreHashNode.h:50
int(* q_dbi_stmt_bind_t)(SQLStatement *stmt, const QoreListNode &l, ExceptionSink *xsink)
bind input values and optionally describe output parameters
Definition: DBI.h:250
QoreHashNode *(* q_dbi_select_row_t)(Datasource *ds, const QoreString *str, const QoreListNode *args, ExceptionSink *xsink)
signature for the DBI "selectRow" method - must be defined in each DBI driver
Definition: DBI.h:165
AbstractQoreNode *(* q_dbi_get_client_version_t)(const Datasource *ds, ExceptionSink *xsink)
signature for the "get_client_version" method
Definition: DBI.h:234
int(* q_dbi_begin_transaction_t)(Datasource *ds, ExceptionSink *xsink)
signature for the DBI "begin_transaction" method, should only be defined for drivers needing this to ...
Definition: DBI.h:208
int(* q_dbi_stmt_prepare_raw_t)(SQLStatement *stmt, const QoreString &str, ExceptionSink *xsink)
prepare statement with no bind parsing
Definition: DBI.h:245
The base class for all value and parse types in Qore expression trees.
Definition: AbstractQoreNode.h:54
contains constants, classes, and subnamespaces in QoreProgram objects
Definition: QoreNamespace.h:63
this class provides the internal link to the database driver for Qore&#39;s DBI layer ...
Definition: DBI.h:361
int(* q_dbi_open_t)(Datasource *ds, ExceptionSink *xsink)
signature for the DBI "open" method - must be defined in each DBI driver
Definition: DBI.h:127
AbstractQoreNode *(* q_dbi_select_t)(Datasource *ds, const QoreString *str, const QoreListNode *args, ExceptionSink *xsink)
signature for the DBI "select" method - must be defined in each DBI driver
Definition: DBI.h:144
Qore&#39;s string type supported by the QoreEncoding class.
Definition: QoreString.h:82
This is the list container type in Qore, dynamically allocated only, reference counted.
Definition: QoreListNode.h:52
DLLEXPORT DBIDriverList DBI
list of DBI drivers currently reigsted by the Qore library
the base class for accessing databases in Qore through a Qore DBI driver
Definition: Datasource.h:55
this is the data structure Qore DBI drivers will use to pass the supported DBI methods ...
Definition: DBI.h:300
This is the public class for DBI drivers supporting Qore&#39;s new prepared statement API...
Definition: SQLStatement.h:38
int(* q_dbi_stmt_exec_t)(SQLStatement *stmt, ExceptionSink *xsink)
execute statement
Definition: DBI.h:255
container for holding Qore-language exception information and also for registering a "thread_exit" ca...
Definition: ExceptionSink.h:47
int(* q_dbi_rollback_t)(Datasource *ds, ExceptionSink *xsink)
signature for the DBI "rollback" method - must be defined in each DBI driver
Definition: DBI.h:200
int(* q_dbi_stmt_prepare_t)(SQLStatement *stmt, const QoreString &str, const QoreListNode *args, ExceptionSink *xsink)
prepare statement and process placeholder specifications and bind parameters
Definition: DBI.h:240
int(* q_dbi_commit_t)(Datasource *ds, ExceptionSink *xsink)
signature for the DBI "commit" method - must be defined in each DBI driver
Definition: DBI.h:192
this class is used to register and find DBI drivers loaded in qore
Definition: DBI.h:403
AbstractQoreNode *(* q_dbi_get_server_version_t)(Datasource *ds, ExceptionSink *xsink)
signature for the "get_server_version" method
Definition: DBI.h:226
int(* q_dbi_stmt_affected_rows_t)(SQLStatement *stmt, ExceptionSink *xsink)
get number of affected rows
Definition: DBI.h:260
DLLEXPORT QoreHashNode * parseDatasource(const char *ds, ExceptionSink *xsink)
parses a datasource string and returns a hash of the component parts
DLLEXPORT void DBI_concat_numeric(QoreString *str, const AbstractQoreNode *v)
concatenates a numeric value to the QoreString from the QoreNode
DLLEXPORT int DBI_concat_string(QoreString *str, const AbstractQoreNode *v, ExceptionSink *xsink)
concatenates a string value to the QoreString from the AbstractQoreNode