QSqlQuery Class

Member Function Documentation

[explicit] QSqlQuery::QSqlQuery(QSqlResult *result)

Constructs a QSqlQuery object which uses the QSqlResult result to communicate with a database.

[explicit] QSqlQuery::QSqlQuery(const QSqlDatabase &db)

Constructs a QSqlQuery object using the database db. If db is invalid, the application's default database will be used.

See also QSqlDatabase.

[explicit] QSqlQuery::QSqlQuery(const QString &query = QString(), const QSqlDatabase &db = QSqlDatabase())

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.

See also QSqlDatabase.

[noexcept, since 6.2] QSqlQuery::QSqlQuery(QSqlQuery &&other)

Move-constructs a QSqlQuery from other.

This function was introduced in Qt 6.2.

[noexcept] QSqlQuery::~QSqlQuery()

Destroys the object and frees any allocated resources.

void QSqlQuery::addBindValue(const QVariant &val, QSql::ParamType paramType = QSql::In)

Adds the value val 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 paramType 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(QMetaType::fromType<QString>()) if you are binding a string.

See also bindValue(), prepare(), exec(), boundValue(), and boundValues().

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.

See also previous(), next(), first(), last(), seek(), isActive(), and isValid().

void QSqlQuery::bindValue(const QString &placeholder, const QVariant &val, QSql::ParamType paramType = QSql::In)

Set the placeholder placeholder to be bound to value val in the prepared statement. Note that the placeholder mark (e.g :) must be included when specifying the placeholder name. If paramType 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(QMetaType::fromType<QString>()) if you are binding a string.

See also addBindValue(), prepare(), exec(), boundValue(), and boundValues().

void QSqlQuery::bindValue(int pos, const QVariant &val, QSql::ParamType paramType = QSql::In)

Set the placeholder in position pos to be bound to value val in the prepared statement. Field numbering starts at 0. If paramType is QSql::Out or QSql::InOut, the placeholder will be overwritten with data from the database after the exec() call.

QVariant QSqlQuery::boundValue(const QString &placeholder) const

Returns the value for the placeholder.

See also boundValues(), bindValue(), and addBindValue().

QVariant QSqlQuery::boundValue(int pos) const

Returns the value for the placeholder at position pos.

See also boundValues().

[since 6.6] QString QSqlQuery::boundValueName(int pos) const

Returns the bound value name at position pos.

The order of the list is in binding order, irrespective of whether named or positional binding is used.

This function was introduced in Qt 6.6.

See also boundValueNames().

[since 6.6] QStringList QSqlQuery::boundValueNames() const

Returns the names of all bound values.

The order of the list is in binding order, irrespective of whether named or positional binding is used.

This function was introduced in Qt 6.6.

See also boundValues() and boundValueName().

[since 6.0] QVariantList QSqlQuery::boundValues() const

Returns a list of bound values.

The order of the list is in binding order, irrespective of whether named or positional binding is used.

The bound values can be examined in the following way:

    const QVariantList list = query.boundValues();
    for (qsizetype i = 0; i < list.size(); ++i)
        qDebug() << i << ":" << list.at(i).toString();

This function was introduced in Qt 6.0.

See also boundValue(), bindValue(), addBindValue(), and boundValueNames().

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.

Note that the last error for this query is reset when exec() is called.

See also prepare(), bindValue(), addBindValue(), boundValue(), and boundValues().

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()).

Note that 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 statement is given, the function returns false.

Example:

    QSqlQuery query;
    query.exec("INSERT INTO employee (id, name, salary) "
               "VALUES (1001, 'Thad Beaumont', 65000)");

See also isActive(), isValid(), next(), previous(), first(), last(), and seek().

bool QSqlQuery::execBatch(QSqlQuery::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 doesn't support batch executions, the driver will simulate it using conventional exec() calls.

Returns true if the query is executed successfully; otherwise returns false.

Example:

QSqlQuery q;
q.prepare("insert into myTable values (?, ?)");

QVariantList ints;
ints << 1 << 2 << 3 << 4;
q.addBindValue(ints);

QVariantList names;
names << "Harald" << "Boris" << "Trond" << QVariant(QMetaType::fromType<QString>());
q.addBindValue(names);

if (!q.execBatch())
    qDebug() << q.lastError();

The example above inserts four new rows into myTable:

1  Harald
2  Boris
3  Trond
4  NULL

To bind NULL values, a null QVariant of the relevant type has to be added to the bound QVariantList; for example, QVariant(QMetaType::fromType<QString>()) 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;

See also prepare(), bindValue(), and addBindValue().

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.

See also lastQuery().

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.

See also prepare(), exec(), and isActive().

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.

See also next(), previous(), last(), seek(), at(), isActive(), and isValid().

bool QSqlQuery::isActive() const

Returns true if the query is active. An active QSqlQuery is one that has been exec()'d successfully but not yet finished with. When you are finished with an active query, you can make the query inactive by calling finish() or clear(), or you can delete the QSqlQuery instance.

See also isSelect().

bool QSqlQuery::isForwardOnly() const

Returns forwardOnly.

See also forwardOnly, next(), and seek().

bool QSqlQuery::isNull(int field) const

Returns true if the query is not active, the query is not positioned on a valid record, there is no such field, or the field is null; otherwise false. Note that for some drivers, isNull() will not return accurate information until after an attempt is made to retrieve data.

See also isActive(), isValid(), and value().

bool QSqlQuery::isNull(QAnyStringView name) const

This is an overloaded function.

Returns true if there is no field with this name; otherwise returns isNull(int index) for the corresponding field index.

This overload is less efficient than isNull()

[since 6.7] bool QSqlQuery::isPositionalBindingEnabled() const

Returns positionalBindingEnabled.

This function was introduced in Qt 6.7.

See also positionalBindingEnabled.

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.

See also next(), previous(), first(), seek(), at(), isActive(), and isValid().

QSqlError QSqlQuery::lastError() const

Returns error information about the last error (if any) that occurred with this query.

See also QSqlError and QSqlDatabase::lastError().

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.

See also QSqlDriver::hasFeature().

QString QSqlQuery::lastQuery() const

Returns the text of the current query being used, or an empty string if there is no current query text.

See also executedQuery().

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 result is currently located before the first record, e.g. immediately after a query is executed, an attempt is made to retrieve the first record.
• If the result is currently located after the last record, there is no change and false is returned.
• If the result is located somewhere in the middle, an attempt is made to retrieve the next record.

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.

See also previous(), first(), last(), seek(), at(), isActive(), and isValid().

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 isn't 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.

See also QSqlDriver::hasFeature(), forwardOnly, next(), isSelect(), numRowsAffected(), isActive(), and lastError().

int QSqlQuery::numRowsAffected() const

Returns the number of rows affected by the result's SQL statement, or -1 if it cannot be determined. Note that for SELECT statements, the value is undefined; use size() instead. If the query is not active, -1 is returned.

See also size() and QSqlDriver::hasFeature().

QSql::NumericalPrecisionPolicy QSqlQuery::numericalPrecisionPolicy() const

Returns the numericalPrecisionPolicy.

See also setNumericalPrecisionPolicy().

bool QSqlQuery::prepare(const QString &query)

Prepares the SQL query 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 cannot be mixed in the same query. See the Detailed Description for examples.

Portability notes: 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. When the database does not support named placeholders directly, the placeholder can only contain characters in the range [a-zA-Z0-9_].

For SQLite, the query string can contain only one statement at a time. If more than one statement is given, the function returns false.

Example:

    QSqlQuery query;
    query.prepare("INSERT INTO person (id, forename, surname) "
                  "VALUES (:id, :forename, :surname)");
    query.bindValue(":id", 1001);
    query.bindValue(":forename", "Bart");
    query.bindValue(":surname", "Simpson");
    query.exec();

See also exec(), bindValue(), and addBindValue().

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 result is currently located before the first record, there is no change and false is returned.
• If the result is currently located after the last record, an attempt is made to retrieve the last record.
• If the result is somewhere in the middle, an attempt is made to retrieve the previous record.

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.

See also next(), first(), last(), seek(), at(), isActive(), and isValid().

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.

QSqlQuery q("select * from employees");
QSqlRecord rec = q.record();

qDebug() << "Number of columns: " << rec.count();

int nameCol = rec.indexOf("name"); // index of the field "name"
while (q.next())
    qDebug() << q.value(nameCol).toString(); // output all names

See also value().

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 function.

If relative is false (the default), the following rules apply:

• If index is negative, the result is positioned before the first record and false is returned.
• Otherwise, an attempt is made to move to the record at position index. If the record at position index 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.

If relative is true, the following rules apply:

• If the result is currently positioned before the first record and:
  • index is negative or zero, there is no change, and false is returned.
  • index is positive, an attempt is made to position the result at absolute position index - 1, following the sames rule for non relative seek, above.
• If the result is currently positioned after the last record and:
  • index is positive or zero, there is no change, and false is returned.
  • index is negative, an attempt is made to position the result at index + 1 relative position from last record, following the rule below.
• If the result is currently located somewhere in the middle, and the relative offset index moves the result below zero, the result is positioned before the first record and false is returned.
• Otherwise, an attempt is made to move to the record index records ahead of the current record (or index records behind the current record if index is negative). 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), and false is returned. If the record is successfully retrieved, true is returned.

See also next(), previous(), first(), last(), at(), isActive(), and isValid().

void QSqlQuery::setForwardOnly(bool forward)

Sets forwardOnly to forward.

See also isForwardOnly(), forwardOnly, next(), and seek().

void QSqlQuery::setNumericalPrecisionPolicy(QSql::NumericalPrecisionPolicy precisionPolicy)

Sets numericalPrecisionPolicy to precisionPolicy.

See also numericalPrecisionPolicy().

[since 6.7] void QSqlQuery::setPositionalBindingEnabled(bool enable)

Sets positionalBindingEnabled to enable.

This function was introduced in Qt 6.7.

See also isPositionalBindingEnabled() and positionalBindingEnabled.

int QSqlQuery::size() const

Returns the size of the result (number of rows returned), or -1 if the size cannot 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().

See also isActive(), numRowsAffected(), and QSqlDriver::hasFeature().

[noexcept, since 6.2] void QSqlQuery::swap(QSqlQuery &other)

Swaps this query with other. This operation is very fast and never fails.

This function was introduced in Qt 6.2.

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, e.g. in

SELECT forename, surname FROM people;

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.

See also previous(), next(), first(), last(), seek(), isActive(), and isValid().

QVariant QSqlQuery::value(QAnyStringView name) const

This is an overloaded function.

Returns the value of the field called name in the current record. If field name does not exist an invalid variant is returned.

This overload is less efficient than value()

[noexcept, since 6.2] QSqlQuery &QSqlQuery::operator=(QSqlQuery &&other)

Move-assigns other to this object.

This function was introduced in Qt 6.2.