| Qore Programming Language Reference Manual 1.0.8

QC_DatasourcePool.dox.h
1 namespace Qore {
4 namespace SQL {
6
50 class DatasourcePool : public AbstractDatasource, public Serializable {
51
52 public:
54
65 nothing beginTransaction();
66
67 public:
69
71 nothing clearEventQueue();
72
73 public:
75
82 clearWarningCallback();
83
84 public:
86
92 nothing commit();
93
94 public:
96
117 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);
118
119 public:
121
136 constructor(string desc, *Qore::Thread::Queue queue, auto arg);
137
138 public:
140
161 constructor(hash<auto> opts, *Qore::Thread::Queue queue, auto arg);
162
163 public:
165
170 copy();
171
172 public:
174
186 bool currentThreadInTransaction();
187
188 public:
190
197 destructor();
198
199 public:
201
215 auto exec(string sql, ...);
216
217 public:
219
235 auto execRaw(string sql);
236
237 public:
239
253 int getCapabilities();
254
255 public:
257
271 list<auto> getCapabilityList();
272
273 public:
275
284 auto getClientVersion();
285
286 public:
288
300 hash<auto> getConfigHash();
301
302 public:
304
316 string getConfigString();
317
318 public:
320
332 *string getDBCharset();
333
334 public:
336
348 *string getDBEncoding();
349
350 public:
352
362 *string getDBName();
363
364 public:
366
376 string getDriverName();
377
378 public:
380
392 int getErrorTimeout();
393
394 public:
396
406 *string getHostName();
407
408 public:
410
421 int getMaximum();
422
423 public:
425
437 int getMinimum();
438
439 public:
441
453 string getOSCharset();
454
455 public:
457
467 *string getOSEncoding();
468
469 public:
471
480 auto getOption(string opt);
481
482 public:
484
494 hash<auto> getOptionHash();
495
496 public:
498
508 *string getPassword();
509
510 public:
512
522 *int getPort();
523
524 public:
526
535 AbstractSQLStatement getSQLStatement();
536
537 public:
539
548 auto getServerVersion();
549
550 public:
552
572 *hash<auto> getUsageInfo();
573
574 public:
576
586 *string getUserName();
587
588 public:
590
600 bool inTransaction();
601
602 public:
604
610 nothing rollback();
611
612 public:
614
645 auto select(string sql, ...);
646
647 public:
649
669 auto selectRow(string sql, ...);
670
671 public:
673
695 auto selectRows(string sql, ...);
696
697 public:
699
706 setErrorTimeout(timeout ts);
707
708 public:
710
717 nothing setEventQueue(Qore::Thread::Queue queue, auto arg);
718
719 public:
721
737 setWarningCallback(timeout ms, code callback, auto arg);
738
739 public:
741
752 string toString();
753
754 public:
756
772 auto vexec(string sql, *softlist<auto> vargs);
773
774 public:
776
804 auto vselect(string sql, *softlist<auto> vargs);
805
806 public:
808
828 auto vselectRow(string sql, *softlist<auto> vargs);
829
830 public:
832
856 auto vselectRows(string sql, *softlist<auto> vargs);
857 };
858 }
859 }
Qore::SQL::AbstractSQLStatement
This class defines an abstract interface for the SQLStatement class.
Definition: QC_AbstractSQLStatement.dox.h:11
Qore::SQL::DatasourcePool::getOSCharset
string getOSCharset()
Returns the Qore character encoding name for the object as a string or "(unknown)" if none is set...
Qore::Serializable::constructor
constructor()
The constructor does not perform any action; this class is just used to mark a class as serializable ...
Qore::SQL::DatasourcePool::getDBEncoding
*string getDBEncoding()
Retrieves the database-specific charset set encoding for the object.
Qore::SQL::DatasourcePool::getDriverName
string getDriverName()
Returns the name of the driver used for the object.
Qore::SQL::DatasourcePool::vselect
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 (...
Qore::SQL::DatasourcePool::setEventQueue
nothing setEventQueue(Qore::Thread::Queue queue, auto arg)
Sets a queue object for DBI events on the pool.
Qore::SQL::DatasourcePool::getOSEncoding
*string getOSEncoding()
Returns the Qore character encoding name for the object as a string or NOTHING if none is set...
Qore::SQL::DatasourcePool::getPassword
*string getPassword()
Returns the password parameter as a string or NOTHING if none is set.
Qore::SQL::DatasourcePool::getHostName
*string getHostName()
Returns the hostname parameter as a string or NOTHING if none is set.
Qore::SQL::DatasourcePool
Provides transparent per-thread, per-transaction datasource connection pooling.
Definition: QC_DatasourcePool.dox.h:50
Qore::SQL::DatasourcePool::execRaw
auto execRaw(string sql)
Allocates a persistent connection to the current thread from the pool (if one has not already been al...
Qore::SQL::DatasourcePool::rollback
nothing rollback()
Rolls back the current transaction and releases the connection to the pool.
Qore::SQL::DatasourcePool::getCapabilities
int getCapabilities()
Returns an integer bitfield of DBI driver capabilities.
Qore::SQL::DatasourcePool::selectRows
auto selectRows(string sql,...)
Executes an SQL select statement on the server and returns the result as a list (rows) of hashes (the...
Qore::SQL::DatasourcePool::selectRow
auto selectRow(string sql,...)
Executes an SQL select statement on the server and returns the first row as a hash (the column values...
Qore::SQL::DatasourcePool::getConfigString
string getConfigString()
Returns a string giving the configuration of the current object in a format that can be parsed by par...
Qore::SQL::DatasourcePool::getUsageInfo
*hash< auto > getUsageInfo()
Returns a hash with usage information about the DatasourcePool object.
Qore::SQL::DatasourcePool::copy
copy()
Creates a new Datasource object with the same driver as the original and copies of all the connection...
Qore::SQL::DatasourcePool::exec
auto exec(string sql,...)
Allocates a persistent connection to the current thread from the pool (if one has not already been al...
Qore::Serializable
The Serializable class can be used to mark a class as being serializable.
Definition: QC_Serializable.dox.h:96
Qore::SQL::DatasourcePool::getPort
*int getPort()
Gets the port number that will be used for the next connection to the server.
Qore::SQL::AbstractDatasource
This class defines an abstract interface for database access, inherited by both the Datasource and Da...
Definition: QC_AbstractDatasource.dox.h:10
Qore::max
auto max(list< auto > l)
Returns the maximum value in a list.
Qore::SQL::DatasourcePool::vselectRow
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...
Qore::SQL::DatasourcePool::getDBCharset
*string getDBCharset()
Retrieves the database-specific charset set encoding for the object.
Qore::SQL::DatasourcePool::inTransaction
bool inTransaction()
Returns True if a transaction is currently in progress (meaning in this case that a datasource form t...
Qore::SQL::DatasourcePool::commit
nothing commit()
Commits the current transaction and releases the connection to the pool.
Qore::SQL::DatasourcePool::getOptionHash
hash< auto > getOptionHash()
returns the valid options for the driver associated with the Datasource with descriptions and current...
Qore::SQL::DatasourcePool::toString
string toString()
Returns a string with technical information about the object.
Qore::min
auto min(list< auto > l)
Returns the minumum value in a list.
Qore::SQL::DatasourcePool::getDBName
*string getDBName()
Returns the database name parameter as a string or NOTHING if none is set.
Qore::SQL::DatasourcePool::getMaximum
int getMaximum()
Returns the maximum number of connections in this object.
Qore::SQL::DatasourcePool::clearEventQueue
nothing clearEventQueue()
Clears the queue object for DBI events on the pool.
Qore::SQL::DatasourcePool::currentThreadInTransaction
bool currentThreadInTransaction()
Returns True if the current thread is in a transaction (i.e. has a dedicated datasource allocation)...
Qore::SQL::DatasourcePool::getClientVersion
auto getClientVersion()
Retrieves the driver-specific client library version information; this method may not be implemented ...
Qore::SQL::DatasourcePool::setWarningCallback
setWarningCallback(timeout ms, code callback, auto arg)
sets a connection delay warning callback to be called any time the delay assigning a connection from ...
Qore::SQL::DatasourcePool::vexec
auto vexec(string sql, *softlist< auto > vargs)
Allocates a persistent connection to the current thread from the pool (if one has not already been al...
Qore::SQL::DatasourcePool::getMinimum
int getMinimum()
Returns the minimum number of connections in this object.
Qore::SQL::DatasourcePool::clearWarningCallback
clearWarningCallback()
clears any connection delay warning callback from the object
Qore::SQL::DatasourcePool::vselectRows
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 ...
Qore::SQL::DatasourcePool::getServerVersion
auto getServerVersion()
Returns the driver-specific server version data for the current connection.
Qore::SQL::DatasourcePool::getErrorTimeout
int getErrorTimeout()
Returns the error timeout period for waiting for a connection to come free as an integer giving milli...
Qore::Thread::Queue
Queue objects provide a blocking, thread-safe message-passing object to Qore programs ...
Definition: QC_Queue.dox.h:22
Qore::SQL::DatasourcePool::getOption
auto getOption(string opt)
Returns the current value for the given option.
Qore::SQL::DatasourcePool::getUserName
*string getUserName()
Returns the username parameter as a string or NOTHING if none is set.
Qore
main Qore-language namespace
Definition: Pseudo_QC_All.dox.h:3
Qore::SQL::DatasourcePool::setErrorTimeout
setErrorTimeout(timeout ts)
Sets the timeout period for waiting for a connection to come free; note that timeout values less than...
Qore::SQL::DatasourcePool::destructor
destructor()
Throws an exception if any transactions are in progress and returns immediately; the object is destro...
Qore::SQL::DatasourcePool::beginTransaction
nothing beginTransaction()
Manually allocates a persistent connection from the pool to the calling thread.
Qore::SQL::DatasourcePool::getCapabilityList
list< auto > getCapabilityList()
Returns a list of strings giving the capabilities of the current DBI driver.
Qore::SQL::DatasourcePool::select
auto select(string sql,...)
Executes an SQL select statement on the server and returns the result as a hash (column names) of lis...
Qore::SQL::DatasourcePool::getSQLStatement
AbstractSQLStatement getSQLStatement()
Returns an AbstractSQLStatement object based on the current database connection object.
Qore::SQL::DatasourcePool::getConfigHash
hash< auto > getConfigHash()
Returns a datasource hash describing the configuration of the current object.