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)
57 #define BN_PLACEHOLDER 0
60 #define DBI_DEFAULT_STR_LEN 512
63 #define QDBI_METHOD_OPEN 1
64 #define QDBI_METHOD_CLOSE 2
65 #define QDBI_METHOD_SELECT 3
66 #define QDBI_METHOD_SELECT_ROWS 4
67 #define QDBI_METHOD_EXEC 5
68 #define QDBI_METHOD_COMMIT 6
69 #define QDBI_METHOD_ROLLBACK 7
70 #define QDBI_METHOD_BEGIN_TRANSACTION 8
71 #define QDBI_METHOD_ABORT_TRANSACTION_START 9
72 #define QDBI_METHOD_GET_SERVER_VERSION 10
73 #define QDBI_METHOD_GET_CLIENT_VERSION 11
74 #define QDBI_METHOD_EXECRAW 12
75 #define QDBI_METHOD_STMT_PREPARE 13
76 #define QDBI_METHOD_STMT_PREPARE_RAW 14
77 #define QDBI_METHOD_STMT_BIND 15
78 #define QDBI_METHOD_STMT_BIND_PLACEHOLDERS 16
79 #define QDBI_METHOD_STMT_BIND_VALUES 17
80 #define QDBI_METHOD_STMT_EXEC 18
81 #define QDBI_METHOD_STMT_FETCH_ROW 19
82 #define QDBI_METHOD_STMT_FETCH_ROWS 20
83 #define QDBI_METHOD_STMT_FETCH_COLUMNS 21
84 #define QDBI_METHOD_STMT_NEXT 22
85 #define QDBI_METHOD_STMT_CLOSE 23
86 #define QDBI_METHOD_STMT_AFFECTED_ROWS 24
87 #define QDBI_METHOD_STMT_GET_OUTPUT 25
88 #define QDBI_METHOD_STMT_GET_OUTPUT_ROWS 26
89 #define QDBI_METHOD_STMT_DEFINE 27
90 #define QDBI_METHOD_SELECT_ROW 28
91 #define QDBI_METHOD_OPT_SET 29
92 #define QDBI_METHOD_OPT_GET 30
93 #define QDBI_METHOD_STMT_DESCRIBE 31
94 #define QDBI_METHOD_DESCRIBE 32
96 #define QDBI_VALID_CODES 32
105 #define QDBI_EVENT_WARNING 1
290 #define DBI_OPT_NUMBER_OPT "optimal-numbers"
291 #define DBI_OPT_NUMBER_STRING "string-numbers"
292 #define DBI_OPT_NUMBER_NUMERIC "numeric-numbers"
293 #define DBI_OPT_TIMEZONE "timezone"
299 friend struct qore_dbi_mlist_private;
302 struct qore_dbi_mlist_private* priv;
306 DLLLOCAL qore_dbi_method_list& operator=(
const qore_dbi_method_list&);
309 DLLEXPORT qore_dbi_method_list();
310 DLLEXPORT ~qore_dbi_method_list();
336 DLLEXPORT
void add(
int code, q_dbi_stmt_fetch_row_t method);
338 DLLEXPORT
void add(
int code, q_dbi_stmt_fetch_columns_t method);
340 DLLEXPORT
void add(
int code, q_dbi_stmt_fetch_rows_t method);
342 DLLEXPORT
void add(
int code, q_dbi_stmt_next_t method);
345 DLLEXPORT
void add(
int code, q_dbi_option_set_t method);
347 DLLEXPORT
void add(
int code, q_dbi_option_get_t method);
350 DLLEXPORT
void registerOption(
const char* name,
const char* desc,
const QoreTypeInfo* type = 0);
360 friend struct qore_dbi_private;
364 struct qore_dbi_private* priv;
369 DLLLOCAL DBIDriver& operator=(
const DBIDriver&);
376 DLLEXPORT
const char*
getName()
const;
390 DLLLOCAL DBIDriver(
struct qore_dbi_private* p);
391 DLLLOCAL ~DBIDriver();
394 struct qore_dbi_dlist_private;
404 struct qore_dbi_dlist_private *priv;
406 DLLLOCAL
DBIDriver* find_intern(
const char* name)
const;
441 DLLLOCAL ~DBIDriverList();
460 #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:182
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:216
int(* q_dbi_close_t)(Datasource *ds)
signature for the DBI "close" method - must be defined in each DBI driver
Definition: DBI.h:132
This is the hash or associative list container type in Qore, dynamically allocated only...
Definition: QoreHashNode.h:49
int(* q_dbi_stmt_bind_t)(SQLStatement *stmt, const QoreListNode &l, ExceptionSink *xsink)
bind input values and optionally describe output parameters
Definition: DBI.h:248
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:163
AbstractQoreNode *(* q_dbi_get_client_version_t)(const Datasource *ds, ExceptionSink *xsink)
signature for the "get_client_version" method
Definition: DBI.h:232
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:206
int(* q_dbi_stmt_prepare_raw_t)(SQLStatement *stmt, const QoreString &str, ExceptionSink *xsink)
prepare statement with no bind parsing
Definition: DBI.h:243
The base class for all value and parse types in Qore expression trees.
Definition: AbstractQoreNode.h:55
contains constants, classes, and subnamespaces in QoreProgram objects
Definition: QoreNamespace.h:58
this class provides the internal link to the database driver for Qore's DBI layer ...
Definition: DBI.h:359
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:125
DLLEXPORT bool hasStatementAPI() const
returns true if the driver supports the statement API
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:142
DLLEXPORT QoreHashNode * getOptionHash() const
returns the valid options for this driver with descriptions
Qore'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:54
DLLEXPORT const char * getName() const
this is the only public exported function available in this class
this is the data structure Qore DBI drivers will use to pass the supported DBI methods ...
Definition: DBI.h:298
This is the public class for DBI drivers supporting Qore's new prepared statement API...
Definition: SQLStatement.h:40
int(* q_dbi_stmt_exec_t)(SQLStatement *stmt, ExceptionSink *xsink)
execute statement
Definition: DBI.h:253
container for holding Qore-language exception information and also for registering a "thread_exit" ca...
Definition: ExceptionSink.h:43
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:198
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:238
DLLEXPORT DBIDriver * registerDriver(const char *name, const qore_dbi_method_list &methods, int caps)
registers a new DBI driver
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:190
this class is used to register and find DBI drivers loaded in qore
Definition: DBI.h:401
AbstractQoreNode *(* q_dbi_get_server_version_t)(Datasource *ds, ExceptionSink *xsink)
signature for the "get_server_version" method
Definition: DBI.h:224
int(* q_dbi_stmt_affected_rows_t)(SQLStatement *stmt, ExceptionSink *xsink)
get number of affected rows
Definition: DBI.h:258
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 DBIDriver * find(const char *name) const
finds a driver, will try to load the driver using the ModuleManager if no such driver is already pres...
DLLEXPORT int DBI_concat_string(QoreString *str, const AbstractQoreNode *v, ExceptionSink *xsink)
concatenates a string value to the QoreString from the AbstractQoreNode