CopperSpice API
1.9.2
|
The QSqlQuery class provides a means of executing and manipulating SQL statements. More...
Public Types | |
enum | BatchExecutionMode |
Public Methods | |
QSqlQuery (const QSqlQuery &other) | |
QSqlQuery (const QString &query=QString (), QSqlDatabase db=QSqlDatabase ()) | |
QSqlQuery (QSqlDatabase db) | |
QSqlQuery (QSqlResult *result) | |
~QSqlQuery () | |
void | addBindValue (const QVariant &value, QSql::ParamType type=QSql::In) |
int | at () const |
void | bindValue (const QString &placeholder, const QVariant &value, QSql::ParamType type=QSql::In) |
void | bindValue (int pos, const QVariant &value, QSql::ParamType type=QSql::In) |
QVariant | boundValue (const QString &placeholder) const |
QVariant | boundValue (int pos) const |
QMap< QString, QVariant > | boundValues () const |
void | clear () |
const QSqlDriver * | driver () const |
bool | exec () |
bool | exec (const QString &query) |
bool | execBatch (BatchExecutionMode mode=ValuesAsRows) |
QString | executedQuery () const |
void | finish () |
bool | first () |
bool | isActive () const |
bool | isForwardOnly () const |
bool | isNull (const QString &name) const |
bool | isNull (int field) const |
bool | isSelect () const |
bool | isValid () const |
bool | last () |
QSqlError | lastError () const |
QVariant | lastInsertId () const |
QString | lastQuery () const |
bool | next () |
bool | nextResult () |
QSql::NumericalPrecisionPolicy | numericalPrecisionPolicy () const |
int | numRowsAffected () const |
QSqlQuery & | operator= (const QSqlQuery &other) |
bool | prepare (const QString &query) |
bool | previous () |
QSqlRecord | record () const |
const QSqlResult * | result () const |
bool | seek (int index, bool relative=false) |
void | setForwardOnly (bool forward) |
void | setNumericalPrecisionPolicy (QSql::NumericalPrecisionPolicy precisionPolicy) |
int | size () const |
QVariant | value (const QString &name) const |
QVariant | value (int index) const |
The QSqlQuery class provides a means of executing and manipulating SQL statements.
QSqlQuery encapsulates the functionality involved in creating, navigating and retrieving data from SQL queries which are executed on a QSqlDatabase. It can be used to execute DML (data manipulation language) statements, such as SELECT
, INSERT
, UPDATE
and DELETE
, as well as DDL (data definition language) statements, such as CREATE
TABLE
. It can also be used to execute database-specific commands which are not standard SQL (e.g. SET DATESTYLE=ISO
for PostgreSQL).
Successfully executed SQL statements set the query's state to active so that isActive() returns true. Otherwise the query's state is set to inactive. In either case, when executing a new SQL statement, the query is positioned on an invalid record. An active query must be navigated to a valid record (so that isValid() returns true) before values can be retrieved.
For some databases, if an active query that is a SELECT
statement exists when you call commit() or rollback(), the commit or rollback will fail. Refer to isActive() for more details.
Navigating records is performed with the following methods.
These functions allow the programmer to move forward, backward or arbitrarily through the records returned by the query. If you only need to move forward through the results (e.g., by using next()), you can use setForwardOnly(), which will save a significant amount of memory overhead and improve performance on some databases. Once an active query is positioned on a valid record, data can be retrieved using value(). All data is transferred from the SQL backend using QVariant.
To access the data returned by a query, use value(int). Each field in the data returned by a SELECT
statement is accessed by passing the field's position in the statement, starting from 0. This makes using SELECT *
queries inadvisable because the order of the fields returned is indeterminate.
For the sake of efficiency, there are no functions to access a field by name (unless you use prepared queries with names, as explained below). To convert a field name into an index use record().indexOf() as shown in the following example.
QSqlQuery supports prepared query execution and the binding of parameter values to placeholders. Some databases do not support these features, so for those, CopperSpice emulates the required functionality. For example, the Oracle and ODBC drivers have proper prepared query support, and CopperSpice makes use of it; but for databases that do not have this support, CopperSpice implements the feature itself, e.g. by replacing placeholders with actual values when a query is executed. Use numRowsAffected() to find out how many rows were affected by a non-SELECT
query, and size() to find how many were retrieved by a SELECT
.
Oracle databases identify placeholders by using a colon-name syntax, e.g :name
. ODBC simply uses ?
characters. CopperSpice supports both syntaxes, with the restriction that you can not mix them in the same query.
You can retrieve the values of all the fields in a single variable (a map) using boundValues().
Below we present the same example using each of the four different binding approaches, as well as one example of binding values to a stored procedure.
Named binding using named placeholders:
Positional binding using named placeholders:
Binding values using positional placeholders (version 1):
Binding values using positional placeholders (version 2):
Binding values to a stored procedure:
This code calls a stored procedure called AsciiToInt()
, passing it a character through its in parameter, and taking its result in the out parameter.
Note that unbound parameters will retain their values.
Stored procedures that uses the return statement to return values, or return multiple result sets, are not fully supported. For specific details refer to SQL Drivers.
Constant | Value | Description |
---|---|---|
QSqlQuery::ValuesAsRows | 0 | - Updates multiple rows. Treats every entry in a QVariantList as a value for updating the next row. |
QSqlQuery::ValuesAsColumns | 1 | - Updates a single row. Treats every entry in a QVariantList as a single value of an array type. |
|
explicit |
Constructs a QSqlQuery object which uses the QSqlResult result to communicate with a database.
|
explicit |
Constructs a QSqlQuery object using the SQL query and the database db. If db is not specified, or is invalid, the application's default database is used. If query is not an empty string, it will be executed.
|
explicit |
Constructs a QSqlQuery object using the database db. If db is invalid, the application's default database will be used.
QSqlQuery::QSqlQuery | ( | const QSqlQuery & | other | ) |
Constructs a copy of other.
QSqlQuery::~QSqlQuery | ( | ) |
Destroys the object and frees any allocated resources.
void QSqlQuery::addBindValue | ( | const QVariant & | value, |
QSql::ParamType | type = QSql::In |
||
) |
Adds the value to the list of values when using positional value binding. The order of the addBindValue() calls determines which placeholder a value will be bound to in the prepared query. If type is QSql::Out or QSql::InOut, the placeholder will be overwritten with data from the database after the exec() call.
To bind a NULL value, use a null QVariant; for example, use QVariant(QVariant::String)
if you are binding a string.
int QSqlQuery::at | ( | ) | const |
Returns the current internal position of the query. The first record is at position zero. If the position is invalid, the function returns QSql::BeforeFirstRow or QSql::AfterLastRow, which are special negative values.
void QSqlQuery::bindValue | ( | const QString & | placeholder, |
const QVariant & | value, | ||
QSql::ParamType | type = QSql::In |
||
) |
Binds the given placeholder to the specified value in the prepared statement. The placeholder mark (e.g :
) must be included when specifying the placeholder name. If type is QSql::Out or QSql::InOut, the placeholder will be overwritten with data from the database after the exec() call. In this case, sufficient space must be pre-allocated to store the result into.
To bind a NULL value, use a null QVariant; for example, use QVariant(QVariant::String)
if you are binding a string. Values can not be bound to multiple locations in the query.
Binding to name will bind to the first :name, but not the second.
void QSqlQuery::bindValue | ( | int | pos, |
const QVariant & | value, | ||
QSql::ParamType | type = QSql::In |
||
) |
Set the placeholder at the given pos to be bound to value in the prepared statement. Field numbering starts at 0. If type is QSql::Out or QSql::InOut the placeholder will be overwritten with data from the database after the exec() call.
Returns the value for the placeholder.
QVariant QSqlQuery::boundValue | ( | int | pos | ) | const |
Returns the value for the placeholder at position pos.
Returns a map of the bound values.
With named binding, the bound values can be examined in the following ways:
With positional binding, the code becomes:
void QSqlQuery::clear | ( | ) |
Clears the result set and releases any resources held by the query. Sets the query state to inactive. You should rarely if ever need to call this function.
const QSqlDriver * QSqlQuery::driver | ( | ) | const |
Returns the database driver associated with the query.
bool QSqlQuery::exec | ( | ) |
Executes a previously prepared SQL query. Returns true if the query executed successfully, otherwise returns false.
The last error for this query is reset when exec() is called.
bool QSqlQuery::exec | ( | const QString & | query | ) |
Executes the SQL in query. Returns true and sets the query state to active if the query was successful; otherwise returns false. The query string must use syntax appropriate for the SQL database being queried (for example, standard SQL).
After the query is executed, the query is positioned on an invalid record and must be navigated to a valid record before data values can be retrieved (for example, using next()).
The last error for this query is reset when exec() is called.
For SQLite the query string can contain only one statement at a time. If more than one statements is give, the function returns false.
bool QSqlQuery::execBatch | ( | BatchExecutionMode | mode = ValuesAsRows | ) |
Executes a previously prepared SQL query in a batch. All the bound parameters have to be lists of variants. If the database does not support batch executions, the driver will simulate it using conventional exec() calls.
Returns true if the query is executed successfully, otherwise returns false.
The example above inserts four new rows into myTable
:
To bind NULL values, a null QVariant of the relevant type has to be added to the bound QVariantList; for example, QVariant(QVariant::String)
should be used if you are using strings.
The mode parameter indicates how the bound QVariantList will be interpreted. If mode is ValuesAsRows
, every variant within the QVariantList will be interpreted as a value for a new row. ValuesAsColumns
is a special case for the Oracle driver. In this mode, every entry within a QVariantList will be interpreted as array-value for an IN or OUT value within a stored procedure. Note that this will only work if the IN or OUT value is a table-type consisting of only one column of a basic type, for example TYPE myType IS TABLE OF VARCHAR(64) INDEX BY BINARY_INTEGER;
QString QSqlQuery::executedQuery | ( | ) | const |
Returns the last query that was successfully executed.
In most cases this function returns the same string as lastQuery(). If a prepared query with placeholders is executed on a DBMS that does not support it, the preparation of this query is emulated. The placeholders in the original query are replaced with their bound values to form a new query. This function returns the modified query. It is mostly useful for debugging purposes.
void QSqlQuery::finish | ( | ) |
Instruct the database driver that no more data will be fetched from this query until it is re-executed. There is normally no need to call this function, but it may be helpful in order to free resources such as locks or cursors if you intend to re-use the query at a later time.
Sets the query to inactive. Bound values retain their values.
bool QSqlQuery::first | ( | ) |
Retrieves the first record in the result, if available, and positions the query on the retrieved record. Note that the result must be in the active state and isSelect() must return true before calling this function or it will do nothing and return false. Returns true if successful. If unsuccessful the query position is set to an invalid position and false is returned.
bool QSqlQuery::isActive | ( | ) | const |
Returns true if the query is active. An active QSqlQuery is one where exec() has run successfully but not finished. When the active query is no longer needed make the query inactive by calling finish() or clear(), or delete the QSqlQuery instance.
SELECT
statement. For some databases that support transactions, an active query that is a SELECT
statement can cause a commit() or a rollback() to fail, so before committing or rolling back, you should make your active SELECT
statement query inactive using one of the ways listed above.bool QSqlQuery::isForwardOnly | ( | ) | const |
Returns true if you can only scroll forward through a result set, otherwise returns false.
bool QSqlQuery::isNull | ( | const QString & | name | ) | const |
Returns true if the given field name contains a NULL value or the field does not exist. Otherwise returns false.
bool QSqlQuery::isNull | ( | int | field | ) | const |
Returns true if the query is active and positioned on a valid record and the field is NULL. Otherwise returns false. For some drivers isNull() will not return accurate information until after an attempt is made to retrieve data.
bool QSqlQuery::isSelect | ( | ) | const |
Returns true if the current query is a SELECT
statement, otherwise returns false.
bool QSqlQuery::isValid | ( | ) | const |
Returns true if the query is currently positioned on a valid record, otherwise returns false.
bool QSqlQuery::last | ( | ) |
Retrieves the last record in the result, if available, and positions the query on the retrieved record. Note that the result must be in the active state and isSelect() must return true before calling this function or it will do nothing and return false. Returns true if successful. If unsuccessful the query position is set to an invalid position and false is returned.
QSqlError QSqlQuery::lastError | ( | ) | const |
Returns error information about the last error (if any) that occurred with this query.
QVariant QSqlQuery::lastInsertId | ( | ) | const |
Returns the object ID of the most recent inserted row if the database supports it. An invalid QVariant will be returned if the query did not insert any value or if the database does not report the id back. If more than one row was touched by the insert, the behavior is undefined.
For MySQL databases the row's auto-increment field will be returned.
default_with_oids
configuration variable to be sure.QString QSqlQuery::lastQuery | ( | ) | const |
Returns the text of the current query being used, or an empty string if there is no current query text.
bool QSqlQuery::next | ( | ) |
Retrieves the next record in the result, if available, and positions the query on the retrieved record. Note that the result must be in the active state and isSelect() must return true before calling this function or it will do nothing and return false.
The following rules apply:
If the record could not be retrieved, the result is positioned after the last record and false is returned. If the record is successfully retrieved, true is returned.
bool QSqlQuery::nextResult | ( | ) |
Discards the current result set and navigates to the next if available.
Some databases are capable of returning multiple result sets for stored procedures or SQL batches (a query strings that contains multiple statements). If multiple result sets are available after executing a query this function can be used to navigate to the next result set(s).
If a new result set is available this function will return true. The query will be repositioned on an invalid record in the new result set and must be navigated to a valid record before data values can be retrieved. If a new result set is not available the function returns false and the query is set to inactive. In any case the old result set will be discarded.
When one of the statements is a non-select statement a count of affected rows may be available instead of a result set.
Note that some databases, i.e. Microsoft SQL Server, requires non-scrollable cursors when working with multiple result sets. Some databases may execute all statements at once while others may delay the execution until the result set is actually accessed, and some databases may have restrictions on which statements are allowed to be used in a SQL batch.
QSql::NumericalPrecisionPolicy QSqlQuery::numericalPrecisionPolicy | ( | ) | const |
Returns the current precision policy.
int QSqlQuery::numRowsAffected | ( | ) | const |
Returns the number of rows affected by the result's SQL statement, or -1 if it can not be determined. Note that for SELECT
statements, the value is undefined; use size() instead. If the query is not active, -1 is returned.
QSqlQuery & QSqlQuery::operator= | ( | const QSqlQuery & | other | ) |
Copy assigns from other and returns a reference to this object.
bool QSqlQuery::prepare | ( | const QString & | query | ) |
Prepares the SQL query for execution. Returns true if the query is prepared successfully, otherwise returns false.
The query may contain placeholders for binding values. Both Oracle style colon-name (e.g., :surname
), and ODBC style (?
) placeholders are supported; but they can not be mixed in the same query.
Some databases choose to delay preparing a query until it is executed the first time. In this case, preparing a syntactically wrong query succeeds, but every consecutive exec() will fail. For SQLite the query string can contain only one statement at a time. If more than one statements are give this method returns false.
bool QSqlQuery::previous | ( | ) |
Retrieves the previous record in the result, if available, and positions the query on the retrieved record. Note that the result must be in the active state and isSelect() must return true before calling this function or it will do nothing and return false.
The following rules apply:
If the record could not be retrieved, the result is positioned before the first record and false is returned. If the record is successfully retrieved, true is returned.
QSqlRecord QSqlQuery::record | ( | ) | const |
Returns a QSqlRecord containing the field information for the current query. If the query points to a valid row (isValid() returns true), the record is populated with the row's values. An empty record is returned when there is no active query (isActive() returns false).
To retrieve values from a query, value() should be used since its index-based lookup is faster.
In the following example, a SELECT * FROM
query is executed. Since the order of the columns is not defined, QSqlRecord::indexOf() is used to obtain the index of a column.
const QSqlResult * QSqlQuery::result | ( | ) | const |
Returns the result associated with the query.
bool QSqlQuery::seek | ( | int | index, |
bool | relative = false |
||
) |
Retrieves the record at position index, if available, and positions the query on the retrieved record. The first record is at position 0. Note that the query must be in an active state and isSelect() must return true before calling this method.
If relative is false the following rules apply:
If relative is true the following rules apply:
Otherwise, an attempt is made to move to the record by the given number index records, if index is negative the current position will backwards.
If the record at offset index could not be retrieved the result is positioned after the last record. If index >= 0 or before the first record if index is negative then false is returned. If the record is successfully retrieved true is returned.
void QSqlQuery::setForwardOnly | ( | bool | forward | ) |
Sets forward only mode to forward. If forward is true, only next() and seek() with positive values, are allowed for navigating the results.
Forward only mode can be (depending on the driver) more memory efficient since results do not need to be cached. It will also improve performance on some databases. For this to be true, you must call setForwardOnly()
before the query is prepared or executed. Note that the constructor that takes a query and a database may execute the query.
Forward only mode is off by default.
Setting forward only to false is a suggestion to the database engine, which has the final say on whether a result set is forward only or scrollable. isForwardOnly() will always return the correct status of the result set.
void QSqlQuery::setNumericalPrecisionPolicy | ( | QSql::NumericalPrecisionPolicy | precisionPolicy | ) |
Instruct the database driver to return numerical values with a precision specified by precisionPolicy.
The Oracle driver, for example, can retrieve numerical values as strings to prevent the loss of precision. If high precision does not matter, use this method to increase execution speed by bypassing string conversions.
Drivers that do not support fetching numerical values with low precision will ignore the precision policy. You can use QSqlDriver::hasFeature() to find out whether a driver supports this feature.
Setting the precision policy does not affect the currently active query. Call exec(QString) or prepare() in order to activate the policy.
int QSqlQuery::size | ( | ) | const |
Returns the size of the result (number of rows returned), or -1 if the size can not be determined or if the database does not support reporting information about query sizes. Note that for non-SELECT
statements (isSelect() returns false), size() will return -1. If the query is not active (isActive() returns false), -1 is returned.
To determine the number of rows affected by a non-SELECT
statement, use numRowsAffected().
Returns the value of field name in the current record. If the given field name does not exist an empty QVariant is returned.
QVariant QSqlQuery::value | ( | int | index | ) | const |
Returns the value of field index in the current record.
The fields are numbered from left to right using the text of the SELECT
statement. For example, field 0 is forename
and field 1 is surname
.
Using SELECT *
is not recommended because the order of the fields in the query is undefined.
An invalid QVariant is returned if field index does not exist, if the query is inactive, or if the query is positioned on an invalid record.