Qore Programming Language Reference Manual
1.8.0
|
This class defines an abstract interface for the SQLStatement class. More...
Public Member Methods | |
abstract bool | active () |
Returns True if the object is currently active and has a connection or transaction lock allocated to it, or False if not. More... | |
abstract int | affectedRows () |
Returns the number of rows affected by the last call to AbstractSQLStatement::exec() More... | |
abstract nothing | beginTransaction () |
Manually starts a transaction and allocates a connection or grabs the transaction lock according to the object used in the AbstractSQLStatement::constructor() More... | |
abstract nothing | bind (...) |
Binds placeholder buffer specifications and values to buffers defined in AbstractSQLStatement::prepare() More... | |
abstract nothing | bindArgs (softlist< auto > vargs) |
Binds placeholder buffer specifications and values given as a list in the single argument to the method to buffers defined in AbstractSQLStatement::prepare() More... | |
abstract nothing | bindPlaceholders (...) |
Binds placeholder buffer specifications to buffers defined in AbstractSQLStatement::prepare() More... | |
abstract nothing | bindPlaceholdersArgs (softlist< auto > vargs) |
Binds placeholder buffer specifications given as a list in the single argument to the method to buffers defined in AbstractSQLStatement::prepare() More... | |
abstract nothing | bindValues (...) |
Binds values to value buffer specifications to buffers defined in AbstractSQLStatement::prepare() More... | |
abstract nothing | bindValuesArgs (softlist< auto > vargs) |
Binds values to value buffer specifications given as a list in the single argument to the method to value buffers defined in AbstractSQLStatement::prepare() More... | |
abstract nothing | close () |
Closes the statement if it is open, however this method does not release the connection or transaction lock. More... | |
abstract nothing | commit () |
Commits the transaction, releases the connection or the transaction lock according to the object used in the AbstractSQLStatement::constructor(), and closes the SQLStatement. More... | |
abstract bool | currentThreadInTransaction () |
Returns True if the current thread is in a transaction (i.e. holds the transaction lock), False if not. More... | |
abstract nothing | define () |
Performs an explicit define operation on the SQLStatement. More... | |
abstract hash< auto > | describe () |
Describes columns in the statement result. More... | |
abstract nothing | exec (...) |
Executes the bound statement with any bound buffers, also optionally allows binding placeholder buffer specifications and values to buffers defined in AbstractSQLStatement::prepare() before executing the statement. More... | |
abstract nothing | execArgs (softlist< auto > vargs) |
Executes the bound statement with any bound buffers, also optionally allows binding placeholder buffer specifications and values given as a list in the single argument to the method to buffers defined in AbstractSQLStatement::prepare() More... | |
abstract hash< auto > | fetchColumns (softint rows=-1) |
Retrieves a block of rows as a hash of lists with the maximum number of rows determined by the argument passed; automatically advances the row pointer; with this call it is not necessary to call AbstractSQLStatement::next(). More... | |
abstract *hash< auto > | fetchRow () |
Retrieves the current row as a hash where the keys are the column names and the values are the column values. More... | |
abstract list< auto > | fetchRows (softint rows=-1) |
Retrieves a block of rows as a list of hashes with the maximum number of rows determined by the argument passed; automatically advances the row pointer; with this call it is not necessary to call AbstractSQLStatement::next() More... | |
abstract hash< auto > | getOutput () |
Retrieves output buffers as a hash; result sets will be returned as hashes of lists. More... | |
abstract hash< auto > | getOutputRows () |
Retrieves output buffers as a hash; result sets will be returned as lists of hashes. More... | |
abstract *string | getSQL () |
Returns the current SQL string set with the call to AbstractSQLStatement::prepare() or AbstractSQLStatement::prepareRaw() or NOTHING if no SQL has been set. More... | |
abstract *hash< auto > | getValue () |
Retrieves the current row as a hash where the keys are the column names and the values are the column values. More... | |
abstract bool | next () |
Increments the row pointer when retrieving rows from a select statement; returns True if there is a row to retrieve, False if not. More... | |
abstract nothing | prepare (string sql,...) |
Saves an SQL statement that will be prepared and executed later, along with optional arguments. More... | |
abstract nothing | prepareRaw (string sql) |
Saves an SQL statement that will be prepared and executed later. More... | |
abstract nothing | rollback () |
Closes the SQLStatement, performs a transaction rollback, and releases the connection or the transaction lock according to the object used in the AbstractSQLStatement::constructor(), and closes the SQLStatement. More... | |
abstract bool | valid () |
returns True if the object is currently pointing at a valid element, False if not (use when iterating with AbstractSQLStatement::next()) More... | |
This class defines an abstract interface for the SQLStatement class.
|
pure virtual |
Returns True if the object is currently active and has a connection or transaction lock allocated to it, or False if not.
Implemented in Qore::SQL::SQLStatement.
|
pure virtual |
Returns the number of rows affected by the last call to AbstractSQLStatement::exec()
SQLSTATEMENT-ERROR | No SQL has been set with AbstractSQLStatement::prepare() or AbstractSQLStatement::prepareRaw() |
Implemented in Qore::SQL::SQLStatement.
|
pure virtual |
Manually starts a transaction and allocates a connection or grabs the transaction lock according to the object used in the AbstractSQLStatement::constructor()
Implemented in Qore::SQL::SQLStatement.
|
pure virtual |
Binds placeholder buffer specifications and values to buffers defined in AbstractSQLStatement::prepare()
If the statement has not previously been prepared with the DB API, it will be implicitly prepared by this method call. This means that this call will cause a connection to be dedicated from a DatasourcePool object or the transaction lock to be grabbed with a Datasource object, depending on the argument to AbstractSQLStatement::constructor().
Arguments to buffer specifications must be given in the same order as declared in the string given to the AbstractSQLStatement::prepare() method.
Any arguments previously bound will be released when this call is made.
... | Arguments to placeholder specifications (if required by the underlying DBI driver) and bind by value arguments |
SQLSTATEMENT-ERROR | No SQL has been set with AbstractSQLStatement::prepare() |
Implemented in Qore::SQL::SQLStatement.
|
pure virtual |
Binds placeholder buffer specifications and values given as a list in the single argument to the method to buffers defined in AbstractSQLStatement::prepare()
If the statement has not previously been prepared with the DB API, it will be implicitly prepared by this method call. This means that this call will cause a connection to be dedicated from a DatasourcePool object or the transaction lock to be grabbed with a Datasource object, depending on the argument to AbstractSQLStatement::constructor().
Arguments to buffer specifications must be given in the same order as declared in the string given to the AbstractSQLStatement::prepare() method.
Any arguments previously bound will be released when this call is made.
vargs | Arguments to placeholder specifications (if required by the underlying DBI driver) and bind by value arguments |
SQLSTATEMENT-ERROR | No SQL has been set with AbstractSQLStatement::prepare() |
Implemented in Qore::SQL::SQLStatement.
|
pure virtual |
Binds placeholder buffer specifications to buffers defined in AbstractSQLStatement::prepare()
If the statement has not previously been prepared with the DB API, it will be implicitly prepared by this method call. This means that this call will cause a connection to be dedicated from a DatasourcePool object or the transaction lock to be grabbed with a Datasource object, depending on the argument to AbstractSQLStatement::constructor().
Arguments to buffer specifications must be given in the same order as declared in the string given to the AbstractSQLStatement::prepare() method. Only placeholder buffer specifications will be processed; value buffer specifications will be skipped by this method.
Any buffer specifications previously defined will be released when this call is made.
... | Arguments to placeholder specifications (if required by the underlying DBI driver) |
SQLSTATEMENT-ERROR | No SQL has been set with AbstractSQLStatement::prepare() |
Implemented in Qore::SQL::SQLStatement.
|
pure virtual |
Binds placeholder buffer specifications given as a list in the single argument to the method to buffers defined in AbstractSQLStatement::prepare()
If the statement has not previously been prepared with the DB API, it will be implicitly prepared by this method call. This means that this call will cause a connection to be dedicated from a DatasourcePool object or the transaction lock to be grabbed with a Datasource object, depending on the argument to AbstractSQLStatement::constructor().
Arguments to buffer specifications must be given in the same order as declared in the string given to the AbstractSQLStatement::prepare() method. Only placeholder buffer specifications will be processed; value buffer specifications will be skipped by this method.
Any buffer specifications previously defined will be released when this call is made.
vargs | Arguments to placeholder specifications (if required by the underlying DBI driver) |
SQLSTATEMENT-ERROR | No SQL has been set with AbstractSQLStatement::prepare() |
Implemented in Qore::SQL::SQLStatement.
|
pure virtual |
Binds values to value buffer specifications to buffers defined in AbstractSQLStatement::prepare()
If the statement has not previously been prepared with the DB API, it will be implicitly prepared by this method call. This means that this call will cause a connection to be dedicated from a DatasourcePool object or the transaction lock to be grabbed with a Datasource object, depending on the argument to AbstractSQLStatement::constructor().
Arguments to buffer specifications must be given in the same order as declared in the string given to the AbstractSQLStatement::prepare() method.
Any values previously bound will be released when this call is made.
... | Arguments to bind by value arguments |
SQLSTATEMENT-ERROR | No SQL has been set with AbstractSQLStatement::prepare() |
Implemented in Qore::SQL::SQLStatement.
|
pure virtual |
Binds values to value buffer specifications given as a list in the single argument to the method to value buffers defined in AbstractSQLStatement::prepare()
If the statement has not previously been prepared with the DB API, it will be implicitly prepared by this method call. This means that this call will cause a connection to be dedicated from a DatasourcePool object or the transaction lock to be grabbed with a Datasource object, depending on the argument to AbstractSQLStatement::constructor().
Arguments to buffer specifications must be given in the same order as declared in the string given to the AbstractSQLStatement::prepare() method.
Any values previously bound will be released when this call is made.
vargs | Arguments to bind by value arguments |
SQLSTATEMENT-ERROR | No SQL has been set with AbstractSQLStatement::prepare() |
Implemented in Qore::SQL::SQLStatement.
|
pure virtual |
Closes the statement if it is open, however this method does not release the connection or transaction lock.
Implemented in Qore::SQL::SQLStatement.
|
pure virtual |
Commits the transaction, releases the connection or the transaction lock according to the object used in the AbstractSQLStatement::constructor(), and closes the SQLStatement.
Implemented in Qore::SQL::SQLStatement.
|
pure virtual |
Returns True if the current thread is in a transaction (i.e. holds the transaction lock), False if not.
Implemented in Qore::SQL::SQLStatement.
|
pure virtual |
Performs an explicit define operation on the SQLStatement.
It is not encessary to call this method manually; define operations are implicitly executed when needed when retrieving values from a select statement
Implemented in Qore::SQL::SQLStatement.
|
pure virtual |
Describes columns in the statement result.
"name"
: (string) the column name"type"
: (integer) the column type code (as returned by <value>::typeCode())"maxsize"
: (integer) the maximum size of the column"native_type"
: (string) the database-specific name of the type"internal_id"
: (integer) the database-specific type code of the type Implemented in Qore::SQL::SQLStatement.
|
pure virtual |
Executes the bound statement with any bound buffers, also optionally allows binding placeholder buffer specifications and values to buffers defined in AbstractSQLStatement::prepare() before executing the statement.
If the statement has not previously been prepared with the DB API, it will be implicitly prepared by this method call. This means that this call will cause a connection to be dedicated from a DatasourcePool object or the transaction lock to be grabbed with a Datasource object, depending on the argument to AbstractSQLStatement::constructor().
Optional arguments to buffer specifications must be given in the same order as declared in the string given to the AbstractSQLStatement::prepare() method.
If bind arguments are provided, any arguments previously bound will be released when this call is made.
After calling this method to execute the statement, to retrieve information about the call or output values bound in the call, call AbstractSQLStatement::affectedRows(), AbstractSQLStatement::getOutput(), or AbstractSQLStatement::getOutputRows() as needed.
To retrieve rows from a select statement call either AbstractSQLStatement::next() and AbstractSQLStatement::fetchRow(), or AbstractSQLStatement::fetchRows() or AbstractSQLStatement::fetchColumns() as needed.
... | Optional arguments to placeholder specifications (if required by the underlying DBI driver) and bind by value arguments can be given in the call to the method; if present, arguments are bound before the statement is executed |
SQLSTATEMENT-ERROR | No SQL has been set with AbstractSQLStatement::prepare(); the SQLStatement uses a DatasourcePool an the statement was prepared on another connection |
Implemented in Qore::SQL::SQLStatement.
|
pure virtual |
Executes the bound statement with any bound buffers, also optionally allows binding placeholder buffer specifications and values given as a list in the single argument to the method to buffers defined in AbstractSQLStatement::prepare()
If the statement has not previously been prepared with the DB API, it will be implicitly prepared by this method call. This means that this call will cause a connection to be dedicated from a DatasourcePool object or the transaction lock to be grabbed with a Datasource object, depending on the argument to AbstractSQLStatement::constructor().
Optional arguments to buffer specifications must be given in the same order as declared in the string given to the AbstractSQLStatement::prepare() method.
If bind arguments are provided, any arguments previously bound will be released when this call is made.
After calling this method to execute the statement, to retrieve information about the call or output values bound in the call, call AbstractSQLStatement::affectedRows(), AbstractSQLStatement::getOutput(), or AbstractSQLStatement::getOutputRows() as needed.
To retrieve rows from a select statement call either AbstractSQLStatement::next() and AbstractSQLStatement::fetchRow(), or AbstractSQLStatement::fetchRows() or AbstractSQLStatement::fetchColumns() as needed.
vargs | Optional arguments to placeholder specifications (if required by the underlying DBI driver) and bind by value arguments can be given in the call to the method; if present, arguments are bound before the statement is executed |
SQLSTATEMENT-ERROR | No SQL has been set with AbstractSQLStatement::prepare() or AbstractSQLStatement::prepareRaw(); the SQLStatement uses a DatasourcePool an the statement was prepared on another connection |
Implemented in Qore::SQL::SQLStatement.
|
pure virtual |
Retrieves a block of rows as a hash of lists with the maximum number of rows determined by the argument passed; automatically advances the row pointer; with this call it is not necessary to call AbstractSQLStatement::next().
If the argument passed is omitted or less than or equal to zero, then all available rows from the current row position are retrieved, also if fewer rows are available than requested then only the rows available are retrieved.
rows | The maximum number of rows to retrieve, if this argument is omitted, negative, or equal to zero, then all available rows from the current row position are retrieved |
SQLSTATEMENT-ERROR | No SQL has been set with AbstractSQLStatement::prepare() or AbstractSQLStatement::prepareRaw() |
Implemented in Qore::SQL::SQLStatement.
|
pure virtual |
Retrieves the current row as a hash where the keys are the column names and the values are the column values.
Use with AbstractSQLStatement::next() to iterate through the results of a select statement one row at a time
SQLSTATEMENT-ERROR | No SQL has been set with AbstractSQLStatement::prepare() or AbstractSQLStatement::prepareRaw() |
Implemented in Qore::SQL::SQLStatement.
|
pure virtual |
Retrieves a block of rows as a list of hashes with the maximum number of rows determined by the argument passed; automatically advances the row pointer; with this call it is not necessary to call AbstractSQLStatement::next()
If the argument passed is omitted or less than or equal to zero, then all available rows from the current row position are retrieved, also if fewer rows are available than requested then only the rows available are retrieved.
If no more rows are available then an empty list is returned.
rows | The maximum number of rows to retrieve, if this argument is omitted, negative, or equal to zero, then all available rows from the current row position are retrieved |
SQLSTATEMENT-ERROR | No SQL has been set with AbstractSQLStatement::prepare() or AbstractSQLStatement::prepareRaw() |
Implemented in Qore::SQL::SQLStatement.
|
pure virtual |
Retrieves output buffers as a hash; result sets will be returned as hashes of lists.
SQLSTATEMENT-ERROR | No SQL has been set with AbstractSQLStatement::prepare() or AbstractSQLStatement::prepareRaw() |
Implemented in Qore::SQL::SQLStatement.
|
pure virtual |
Retrieves output buffers as a hash; result sets will be returned as lists of hashes.
SQLSTATEMENT-ERROR | No SQL has been set with AbstractSQLStatement::prepare() or AbstractSQLStatement::prepareRaw() |
Implemented in Qore::SQL::SQLStatement.
|
pure virtual |
Returns the current SQL string set with the call to AbstractSQLStatement::prepare() or AbstractSQLStatement::prepareRaw() or NOTHING if no SQL has been set.
Implemented in Qore::SQL::SQLStatement.
|
pure virtual |
Retrieves the current row as a hash where the keys are the column names and the values are the column values.
Use with AbstractSQLStatement::next() to iterate through the results of a select statement one row at a time
SQLSTATEMENT-ERROR | No SQL has been set with AbstractSQLStatement::prepare() or AbstractSQLStatement::prepareRaw() |
Implements Qore::AbstractIterator.
Implemented in Qore::SQL::SQLStatement.
|
pure virtual |
Increments the row pointer when retrieving rows from a select statement; returns True if there is a row to retrieve, False if not.
If this method returns True, then call AbstractSQLStatement::fetchRow() afterwards to retrieve the row
SQLSTATEMENT-ERROR | No SQL has been set with AbstractSQLStatement::prepare() or AbstractSQLStatement::prepareRaw() |
Implements Qore::AbstractIterator.
Implemented in Qore::SQL::SQLStatement.
|
pure virtual |
Saves an SQL statement that will be prepared and executed later, along with optional arguments.
The statement is actually only prepared when used for the first time, this is so that SQLStatement objects created with DatasourcePool objects use the DatasourcePool more efficiently, as many drivers require the actual DB API prepare call to be made on the same connection as the connection the statement will be executed on as well.
%v
); for a version of this method that does not parse the SQL string for placeholders and bind by value tokens, see AbstractSQLStatement::prepareRaw().sql | The SQL string to prepare for execution on the DB server |
Implemented in Qore::SQL::SQLStatement.
|
pure virtual |
Saves an SQL statement that will be prepared and executed later.
The statement is actually only prepared when used for the first time, this is so that SQLStatement objects created with DatasourcePool objects use the DatasourcePool more efficiently, as many drivers require the actual DB API prepare call to be made on the same connection as the connection the statement will be executed on as well.
%v
); for a version of this method that does parse the SQL string for placeholders and bind by value tokens, see AbstractSQLStatement::prepare().sql | The SQL string to prepare for execution on the DB server |
Implemented in Qore::SQL::SQLStatement.
|
pure virtual |
Closes the SQLStatement, performs a transaction rollback, and releases the connection or the transaction lock according to the object used in the AbstractSQLStatement::constructor(), and closes the SQLStatement.
Implemented in Qore::SQL::SQLStatement.
|
pure virtual |
returns True if the object is currently pointing at a valid element, False if not (use when iterating with AbstractSQLStatement::next())
Implements Qore::AbstractIterator.
Implemented in Qore::SQL::SQLStatement.