Qore Programming Language Reference Manual  0.8.13.6
QC_DatasourcePool.dox.h
1 namespace Qore::SQL {
4 
42 
43 public:
45 
56 nothing beginTransaction();
57 
58 public:
60 
62 nothing clearEventQueue();
63 
64 public:
66 
74 
75 public:
77 
83 nothing commit();
84 
85 public:
87 
108  constructor(string driver, *string user, *string pass, *string db, *string encoding, *string host, softint min = 3, softint max = 10, softint port = 0, *Qore::Thread::Queue queue, auto arg);
109 
110 public:
112 
127  constructor(string desc, *Qore::Thread::Queue queue, auto arg);
128 
129 public:
131 
152  constructor(hash opts, *Qore::Thread::Queue queue, auto arg);
153 
154 public:
156 
161  copy();
162 
163 public:
165 
178 
179 public:
181 
188  destructor();
189 
190 public:
192 
206 auto exec(string sql, ...);
207 
208 public:
210 
226 auto execRaw(string sql);
227 
228 public:
230 
244 int getCapabilities();
245 
246 public:
248 
263 
264 public:
266 
275 auto getClientVersion();
276 
277 public:
279 
292 
293 public:
295 
307 string getConfigString();
308 
309 public:
311 
323 *string getDBCharset();
324 
325 public:
327 
339 string getDBEncoding();
340 
341 public:
343 
353 *string getDBName();
354 
355 public:
357 
367 string getDriverName();
368 
369 public:
371 
383 int getErrorTimeout();
384 
385 public:
387 
397 *string getHostName();
398 
399 public:
401 
412 int getMaximum();
413 
414 public:
416 
428 int getMinimum();
429 
430 public:
432 
444 string getOSCharset();
445 
446 public:
448 
458 *string getOSEncoding();
459 
460 public:
462 
471 auto getOption(string opt);
472 
473 public:
475 
486 
487 public:
489 
499 *string getPassword();
500 
501 public:
503 
513 *int getPort();
514 
515 public:
517 
526 auto getServerVersion();
527 
528 public:
530 
550 *hash getUsageInfo();
551 
552 public:
554 
564 *string getUserName();
565 
566 public:
568 
578 bool inTransaction();
579 
580 public:
582 
588 nothing rollback();
589 
590 public:
592 
623 auto select(string sql, ...);
624 
625 public:
627 
647 auto selectRow(string sql, ...);
648 
649 public:
651 
673 auto selectRows(string sql, ...);
674 
675 public:
677 
684  setErrorTimeout(timeout ts);
685 
686 public:
688 
695 nothing setEventQueue(Qore::Thread::Queue queue, auto arg);
696 
697 public:
699 
715  setWarningCallback(timeout ms, code callback, auto arg);
716 
717 public:
719 
730 string toString();
731 
732 public:
734 
750 auto vexec(string sql, *softlist vargs);
751 
752 public:
754 
782 auto vselect(string sql, *softlist vargs);
783 
784 public:
786 
806 auto vselectRow(string sql, *softlist vargs);
807 
808 public:
810 
834 auto vselectRows(string sql, *softlist vargs);
835 };
836 };
string getOSCharset()
Returns the Qore character encoding name for the object as a string or "(unknown)" if none is set...
string getDriverName()
Returns the name of the driver used for the object.
nothing setEventQueue(Qore::Thread::Queue queue, auto arg)
Sets a queue object for DBI events on the pool.
*string getOSEncoding()
Returns the Qore character encoding name for the object as a string or NOTHING if none is set...
*string getPassword()
Returns the password parameter as a string or NOTHING if none is set.
*string getHostName()
Returns the hostname parameter as a string or NOTHING if none is set.
Provides transparent per-thread, per-transaction datasource connection pooling.
Definition: QC_DatasourcePool.dox.h:41
auto execRaw(string sql)
Allocates a persistent connection to the current thread from the pool (if one has not already been al...
nothing rollback()
Rolls back the current transaction and releases the connection to the pool.
list getCapabilityList()
Returns a list of strings giving the capabilities of the current DBI driver.
Qore::SQL namespace.
Definition: QC_AbstractDatasource.dox.h:2
int getCapabilities()
Returns an integer bitfield of DBI driver capabilities.
auto selectRows(string sql,...)
Executes an SQL select statement on the server and returns the result as a list (rows) of hashes (the...
auto selectRow(string sql,...)
Executes an SQL select statement on the server and returns the first row as a hash (the column values...
auto vexec(string sql, *softlist vargs)
Allocates a persistent connection to the current thread from the pool (if one has not already been al...
string getConfigString()
Returns a string giving the configuration of the current object in a format that can be parsed by par...
copy()
Creates a new Datasource object with the same driver as the original and copies of all the connection...
auto exec(string sql,...)
Allocates a persistent connection to the current thread from the pool (if one has not already been al...
auto max(list l)
Returns the maximum value in a list.
*int getPort()
Gets the port number that will be used for the next connection to the server.
This class defines an abstract interface for database access, inherited by both the Datasource and Da...
Definition: QC_AbstractDatasource.dox.h:8
list list(...)
Returns an untyped list of the arguments passed at the top level.
string getDBEncoding()
Retrieves the database-specific charset set encoding for the object.
*string getDBCharset()
Retrieves the database-specific charset set encoding for the object.
bool inTransaction()
Returns True if a transaction is currently in progress (meaning in this case that a datasource form t...
nothing commit()
Commits the current transaction and releases the connection to the pool.
string toString()
Returns a string with technical information about the object.
*string getDBName()
Returns the database name parameter as a string or NOTHING if none is set.
auto min(list l)
Returns the minumum value in a list.
int getMaximum()
Returns the maximum number of connections in this object.
nothing clearEventQueue()
Clears the queue object for DBI events on the pool.
bool currentThreadInTransaction()
Returns True if the current thread is in a transaction (i.e. has a dedicated datasource allocation)...
auto getClientVersion()
Retrieves the driver-specific client library version information; this method may not be implemented ...
setWarningCallback(timeout ms, code callback, auto arg)
sets a connection delay warning callback to be called any time the delay assigning a connection from ...
hash getOptionHash()
returns the valid options for the driver associated with the Datasource with descriptions and current...
auto vselect(string sql, *softlist vargs)
Executes a select statement on the server and returns the results in a hash (column names) of lists (...
*hash getUsageInfo()
Returns a hash with usage information about the DatasourcePool object.
int getMinimum()
Returns the minimum number of connections in this object.
clearWarningCallback()
clears any connection delay warning callback from the object
auto getServerVersion()
Returns the driver-specific server version data for the current connection.
int getErrorTimeout()
Returns the error timeout period for waiting for a connection to come free as an integer giving milli...
Queue objects provide a blocking, thread-safe message-passing object to Qore programs ...
Definition: QC_Queue.dox.h:15
auto getOption(string opt)
Returns the current value for the given option.
*string getUserName()
Returns the username parameter as a string or NOTHING if none is set.
auto vselectRows(string sql, *softlist vargs)
Executes a select statement on the server and returns the results in a list (rows) of hashes (column ...
setErrorTimeout(timeout ts)
Sets the timeout period for waiting for a connection to come free; note that timeout values less than...
destructor()
Throws an exception if any transactions are in progress and returns immediately; the object is destro...
constructor(string driver, *string user, *string pass, *string db, *string encoding, *string host, softint min=3, softint max=10, softint port=0, *Qore::Thread::Queue queue, auto arg)
Creates the DatasourcePool object; attempts to load a DBI driver if the driver is not already present...
hash getConfigHash()
Returns a datasource hash describing the configuration of the current object.
nothing beginTransaction()
Manually allocates a persistent connection from the pool to the calling thread.
hash hash(object obj)
Returns a hash of an object's members.
auto vselectRow(string sql, *softlist vargs)
Executes a select statement on the server and returns the first row as a hash (column names and value...
auto select(string sql,...)
Executes an SQL select statement on the server and returns the result as a hash (column names) of lis...