Qore Programming Language Reference Manual 1.19.5
Loading...
Searching...
No Matches
QC_Datasource.dox.h
1
2namespace Qore {
4namespace SQL {
6
107
108public:
110
125
126public:
128
131
132public:
134
143nothing close();
144
145public:
147
156nothing commit();
157
158public:
160
192 constructor(string driver, *string user, *string pass, *string db, *string encoding, *string host, *softint port, *hash<auto> options, *Qore::Thread::Queue queue, auto arg);
193
194public:
196
213 constructor(string desc, *Qore::Thread::Queue queue, auto arg);
214
215public:
217
254 constructor(hash<auto> opts, *Qore::Thread::Queue queue, auto arg);
255
256public:
258
264
265public:
267
282
283public:
285
310*hash<auto> describe(string sql, ...);
311
312public:
314
323
324public:
326
347auto exec(string sql, ...);
348
349public:
351
376auto execRaw(string sql);
377
378public:
380
391
392public:
394
407
408public:
410
422list<auto> getCapabilityList();
423
424public:
426
436
437public:
439
454hash<auto> getConfigHash();
455
456public:
458
474
475public:
477
489*string getDBCharset();
490
491public:
493
506
507public:
509
519*string getDBName();
520
521public:
523
536
537public:
539
557
558public:
560
570*string getHostName();
571
572public:
574
587
588public:
590
601
602public:
604
616auto getOption(string opt);
617
618public:
620
634hash<auto> getOptionHash();
635
636public:
638
648*string getPassword();
649
650public:
652
662*int getPort();
663
664public:
666
676
677public:
679
691
692public:
694
705
706public:
708
718*string getUserName();
719
720public:
722
733
734public:
736
747nothing open();
748
749public:
751
760nothing reset();
761
762public:
764
773nothing rollback();
774
775public:
777
810auto select(string sql, ...);
811
812public:
814
835*hash<auto> selectRow(string sql, ...);
836
837public:
839
865auto selectRows(string sql, ...);
866
867public:
869
876nothing setAutoCommit(bool ac = True);
877
878public:
880
891nothing setDBCharset(string encoding);
892
893public:
895
904nothing setDBEncoding(string encoding);
905
906public:
908
917nothing setDBName(string db);
918
919public:
921
928nothing setEventQueue(Qore::Thread::Queue queue, auto arg);
929
930public:
932
941nothing setHostName(string host);
942
943public:
945
956 setOption(string opt, auto val);
957
958public:
960
969nothing setPassword(string pass);
970
971public:
973
982nothing setPort(softint port = 0);
983
984public:
986
993nothing setTransactionLockTimeout(timeout timeout_ms = 0);
994
995public:
997
1006nothing setUserName(string user);
1007
1008public:
1010
1028
1029public:
1031
1054auto vexec(string sql, *softlist<auto> vargs);
1055
1056public:
1058
1088auto vselect(string sql, *softlist<auto> vargs);
1089
1090public:
1092
1114*hash<auto> vselectRow(string sql, *softlist<auto> vargs);
1115
1116public:
1118
1146auto vselectRows(string sql, *softlist<auto> vargs);
1147};
1152
1154 const DSDB2 = "db2";
1156 const DSFreeTDS = "freetds";
1158 const DSJDBC = "jdbc";
1160 const DSMSSQL = "freetds";
1162 const DSMySQL = "mysql";
1164 const DSOracle = "oracle";
1166 const DSPGSQL = "pgsql";
1168 const DSSQLite3 = "sqlite3";
1170 const DSSybase = "sybase";
1172
1177
1199
1217}
1218}
This class defines an abstract interface for database access, inherited by both the Datasource and Da...
Definition: QC_AbstractDatasource.dox.h:10
This class defines an abstract interface for the SQLStatement class.
Definition: QC_AbstractSQLStatement.dox.h:11
This class provides the Qore interface to databases.
Definition: QC_Datasource.dox.h:106
auto getClientVersion()
Retrieves the driver-specific client library version information; this method may not be implemented ...
auto select(string sql,...)
Executes an SQL select statement on the server and returns the result as a hash (column names) of lis...
*string getUserName()
Returns the username parameter as a string or NOTHING if none is set.
*hash< auto > selectRow(string sql,...)
Executes an SQL select statement on the server and returns the first row as a hash (the column values...
*string getHostName()
Returns the hostname parameter as a string or NOTHING if none is set.
string getDriverRealName()
Returns the real DB driver name if supported by the driver, otherwise the Qore driver name.
copy()
Creates a new Datasource object with the same driver as the original and copies of all the connection...
nothing setPassword(string pass)
Sets the password parameter for the time a connection to the server is established.
auto exec(string sql,...)
Grabs the transaction lock (if autocommit is disabled) and executes an SQL command on the server and ...
hash< auto > getConfigHash()
Returns a datasource hash describing the configuration of the current object.
nothing setHostName(string host)
Sets the hostname to use for the next connection to the server.
constructor(string driver, *string user, *string pass, *string db, *string encoding, *string host, *softint port, *hash< auto > options, *Qore::Thread::Queue queue, auto arg)
Creates the Datasource object; attempts to load a DBI driver if the driver is not already present in ...
auto getOption(string opt)
Returns the current value for the given option.
auto getServerVersion()
Returns the driver-specific server version data for the current connection.
AbstractSQLStatement getSQLStatement()
Returns an AbstractSQLStatement object based on the current database connection object.
nothing beginTransaction()
Manually grabs the transaction lock.
auto selectRows(string sql,...)
Executes an SQL select statement on the server and returns the result as a list (rows) of hashes (the...
destructor()
Closes the datasource if it's open (if any operations are in progress, will block until the operation...
bool getAutoCommit()
Returns the autocommit status for the object.
nothing reset()
Closes and reopens the Datasource.
auto execRaw(string sql)
Grabs the transaction lock (if autocommit is disabled) and executes an SQL command on the server and ...
nothing close()
Closes the connection to the database; if any actions are in progress on the database,...
bool currentThreadInTransaction()
Returns True if the current thread is in a transaction (i.e. holds the transaction lock),...
nothing setAutoCommit(bool ac=True)
Turns autocommit on or off for this object.
constructor(hash< auto > opts, *Qore::Thread::Queue queue, auto arg)
Creates a Datasource object from a hash argument giving parameters for the constructor.
nothing setDBEncoding(string encoding)
Sets the database-specific character encoding name for the next connection to the server.
string getConfigString()
Returns a string giving the configuration of the current object in a format that can be parsed by par...
string getOSCharset()
Returns the Qore character encoding name for the current connection as a string or "(unknown)" if non...
nothing setUserName(string user)
Sets the username parameter for the time a connection to the server is established.
list< auto > getCapabilityList()
Returns a list of strings giving the capabilities of the current DBI driver.
auto vselectRows(string sql, *softlist< auto > vargs)
Executes a select statement on the server and returns the results in a list (rows) of hashes (column ...
nothing setPort(softint port=0)
Sets the port number to use for the connection.
*string getDBName()
Returns the database name parameter as a string or NOTHING if none is set.
nothing open()
Opens a connection to the datasouce, using the connection parameters already set; an exception is thr...
nothing setDBCharset(string encoding)
Sets the database-specific character encoding name for the next connection to the server.
int getTransactionLockTimeout()
Retrieves the transaction lock timeout value as an integer in milliseconds.
*string getOSEncoding()
Returns the Qore character encoding name for the current connection as a string or NOTHING if none is...
nothing setDBName(string db)
Sets the database name parameter for the time a connection to the server is established.
*hash< auto > vselectRow(string sql, *softlist< auto > vargs)
Executes a select statement on the server and returns the first row as a hash (column names and value...
nothing commit()
Commits the current transaction and releases the transaction lock.
nothing clearEventQueue()
Clears the queue object for DBI events on the datasource.
nothing rollback()
Rolls the current transaction back and releases the transaction lock.
*string getDBCharset()
Retrieves the database-specific charset set encoding for the current connection.
auto vselect(string sql, *softlist< auto > vargs)
Executes a select statement on the server and returns the results in a hash (column names) of lists (...
constructor(string desc, *Qore::Thread::Queue queue, auto arg)
Creates a Datasource object from a single string giving all parameters that can be parsed by parse_da...
nothing setEventQueue(Qore::Thread::Queue queue, auto arg)
Sets a queue object for DBI events on the datasource.
setOption(string opt, auto val)
sets an option for the datasource
*int getPort()
Gets the port number that will be used for the next connection to the server.
*hash< auto > describe(string sql,...)
Executes an SQL select statement on the server and returns a description of the result set as a hash.
int getCapabilities()
Returns an integer bitfield of DBI driver capabilities.
*string getPassword()
Returns the password parameter as a string or NOTHING if none is set.
auto vexec(string sql, *softlist< auto > vargs)
Grabs the transaction lock (if autocommit is disabled) and executes SQL code on the DB connection,...
nothing setTransactionLockTimeout(timeout timeout_ms=0)
Sets the transaction lock timeout value in milliseconds; set to 0 for no timeout.
hash< auto > getOptionHash()
returns the valid options for the driver associated with the Datasource with descriptions and current...
bool inTransaction()
Returns True if a transaction is currently in progress, False if not.
*string getDBEncoding()
Retrieves the database-specific charset set encoding for the current connection.
int transactionTid()
Returns the TID of the thread holding the transaction lock or -1 if it's not currently held.
string getDriverName()
Returns the name of the driver used for the object.
The Serializable class can be used to mark a class as being serializable.
Definition: QC_Serializable.dox.h:96
Queue objects provide a blocking, thread-safe message-passing object to Qore programs
Definition: QC_Queue.dox.h:22
const True
logical True
Definition: qc_qore.dox.h:98
const DSMySQL
for the "mysql" driver
Definition: QC_Datasource.dox.h:1162
const DSDB2
for the "db2" driver
Definition: QC_Datasource.dox.h:1154
const DSJDBC
for the "jdbc" driver
Definition: QC_Datasource.dox.h:1158
const DSSQLite3
for the "sqlite3" driver
Definition: QC_Datasource.dox.h:1168
const DSSybase
for the "sybase" driver
Definition: QC_Datasource.dox.h:1170
const DSFreeTDS
for the "freetds" driver
Definition: QC_Datasource.dox.h:1156
const DSMSSQL
another constant for the "freetds" driver
Definition: QC_Datasource.dox.h:1160
const DSPGSQL
for the "pgsql" driver
Definition: QC_Datasource.dox.h:1166
const DSOracle
for the "oracle" driver
Definition: QC_Datasource.dox.h:1164
const DBI_CAP_BIND_BY_VALUE
Indicates that the DBI driver supports directly binding qore values into queries using the %v placeho...
Definition: QC_Datasource.dox.h:1183
const DBI_CAP_CHARSET_SUPPORT
Indicates that the DBI driver supports proper character encoding conversions.
Definition: QC_Datasource.dox.h:1185
const DBI_CAP_LOB_SUPPORT
Indicates that the DBI driver supports LOB columns (BLOBs and CLOBs, for example)
Definition: QC_Datasource.dox.h:1207
const DBI_CAP_HAS_OPTION_SUPPORT
Indicates that the DBI driver supports the new driver option API.
Definition: QC_Datasource.dox.h:1197
const DBI_CAP_HAS_STATEMENT
Indicates that the DBI driver supports the prepared statement interface (the SQLStatement class)
Definition: QC_Datasource.dox.h:1205
const DBI_CAP_TRANSACTION_MANAGEMENT
Indicates that the DBI driver supports transaction management.
Definition: QC_Datasource.dox.h:1215
const DBI_CAP_HAS_DESCRIBE
Indicates that the DBI driver supports the describe method.
Definition: QC_Datasource.dox.h:1191
const DBI_CAP_HAS_NUMBER_SUPPORT
Indicates that the DBI driver supports arbitrary-precision numeric support for binding and retrieving...
Definition: QC_Datasource.dox.h:1195
const DBI_CAP_HAS_ARRAY_BIND
Indicates that the DBI driver supports binding arrays by value for bulk DML operations.
Definition: QC_Datasource.dox.h:1189
const DBI_CAP_HAS_SELECT_ROW
Indicates that the DBI driver supports a native selectRow() method implementation.
Definition: QC_Datasource.dox.h:1203
const DBI_CAP_HAS_RESULTSET_OUTPUT
Indicates that the DBI driver supports result set output binding with a SQLStatement output variable.
Definition: QC_Datasource.dox.h:1201
const DBI_CAP_SERVER_TIME_ZONE
Indicates that the DBI driver supports automatically converting date/time values to the server's pres...
Definition: QC_Datasource.dox.h:1209
const DBI_CAP_TIME_ZONE_SUPPORT
Indicates that the DBI driver supports time zones in times.
Definition: QC_Datasource.dox.h:1213
const DBI_CAP_STORED_PROCEDURES
Indicates that the DBI driver supports stored procedure execution.
Definition: QC_Datasource.dox.h:1211
const DBI_CAP_BIND_BY_PLACEHOLDER
Indicates that the DBI driver supports binding placeholder buffers when executing SQL to retrieve dat...
Definition: QC_Datasource.dox.h:1181
const DBI_CAP_HAS_EXECRAW
Indicates that the DBI driver supports the Datasource::execRaw() and DatasourcePool::execRaw() method...
Definition: QC_Datasource.dox.h:1193
const DBI_CAP_EVENTS
Indicates that the DBI driver supports the event API.
Definition: QC_Datasource.dox.h:1187
const DBI_CAP_AUTORECONNECT
Indicates that the DBI driver supports automatically/transparently reconnecting to the server if the ...
Definition: QC_Datasource.dox.h:1179
Qore namespace.
Definition: QC_AbstractSmartLock.dox.h:2