QSqlResult Class

The QSqlResult class provides an abstract interface for accessing data from specific SQL databases. More...

Header:	#include <QSqlResult>
CMake:	find_package(Qt6 COMPONENTS Sql REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Sql)
qmake:	QT += sql

• List of all members, including inherited members

Public Functions

virtual	~QSqlResult()
virtual QVariant	handle() const

Protected Types

enum	BindingSyntax { PositionalBinding, NamedBinding }

Protected Functions

	QSqlResult(const QSqlDriver *db)
void	addBindValue(const QVariant &val, QSql::ParamType paramType)
int	at() const
virtual void	bindValue(int index, const QVariant &val, QSql::ParamType paramType)
virtual void	bindValue(const QString &placeholder, const QVariant &val, QSql::ParamType paramType)
QSql::ParamType	bindValueType(int index) const
QSql::ParamType	bindValueType(const QString &placeholder) const
QSqlResult::BindingSyntax	bindingSyntax() const
QVariant	boundValue(int index) const
QVariant	boundValue(const QString &placeholder) const
int	boundValueCount() const
QString	boundValueName(int index) const
QList<QVariant> &	boundValues() const
void	clear()
virtual QVariant	data(int index) = 0
const QSqlDriver *	driver() const
virtual bool	exec()
QString	executedQuery() const
virtual bool	fetch(int index) = 0
virtual bool	fetchFirst() = 0
virtual bool	fetchLast() = 0
virtual bool	fetchNext()
virtual bool	fetchPrevious()
bool	hasOutValues() const
bool	isActive() const
bool	isForwardOnly() const
virtual bool	isNull(int index) = 0
bool	isSelect() const
bool	isValid() const
QSqlError	lastError() const
virtual QVariant	lastInsertId() const
QString	lastQuery() const
virtual int	numRowsAffected() = 0
virtual bool	prepare(const QString &query)
virtual QSqlRecord	record() const
virtual bool	reset(const QString &query) = 0
void	resetBindCount()
virtual bool	savePrepare(const QString &query)
virtual void	setActive(bool active)
virtual void	setAt(int index)
virtual void	setForwardOnly(bool forward)
virtual void	setLastError(const QSqlError &error)
virtual void	setQuery(const QString &query)
virtual void	setSelect(bool select)
virtual int	size() = 0

Detailed Description

Normally, you would use QSqlQuery instead of QSqlResult, since QSqlQuery provides a generic wrapper for database-specific implementations of QSqlResult.

If you are implementing your own SQL driver (by subclassing QSqlDriver), you will need to provide your own QSqlResult subclass that implements all the pure virtual functions and other virtual functions that you need.

See also QSqlDriver.

Member Type Documentation

enum QSqlResult::BindingSyntax

This enum type specifies the different syntaxes for specifying placeholders in prepared queries.

Constant	Value	Description
QSqlResult::PositionalBinding	0	Use the ODBC-style positional syntax, with "?" as placeholders.
QSqlResult::NamedBinding	1	Use the Oracle-style syntax with named placeholders (e.g., ":id")

See also bindingSyntax().

Member Function Documentation

[protected] QSqlResult::QSqlResult(const QSqlDriver *db)

Creates a QSqlResult using database driver db. The object is initialized to an inactive state.

See also isActive() and driver().

[virtual] QSqlResult::~QSqlResult()

Destroys the object and frees any allocated resources.

[protected] void QSqlResult::addBindValue(const QVariant &val, QSql::ParamType paramType)

Binds the value val of parameter type paramType to the next available position in the current record (row).

See also bindValue().

[protected] int QSqlResult::at() const

Returns the current (zero-based) row position of the result. May return the special values QSql::BeforeFirstRow or QSql::AfterLastRow.

See also setAt() and isValid().

[virtual protected] void QSqlResult::bindValue(int index, const QVariant &val, QSql::ParamType paramType)

Binds the value val of parameter type paramType to position index in the current record (row).

See also addBindValue().

[virtual protected] void QSqlResult::bindValue(const QString &placeholder, const QVariant &val, QSql::ParamType paramType)

This is an overloaded function.

Binds the value val of parameter type paramType to the placeholder name in the current record (row).

Note: Binding an undefined placeholder will result in undefined behavior.

See also QSqlQuery::bindValue().

[protected] QSql::ParamType QSqlResult::bindValueType(int index) const

Returns the parameter type for the value bound at position index.

See also boundValue().

[protected] QSql::ParamType QSqlResult::bindValueType(const QString &placeholder) const

This is an overloaded function.

Returns the parameter type for the value bound with the given placeholder name.

[protected] QSqlResult::BindingSyntax QSqlResult::bindingSyntax() const

Returns the binding syntax used by prepared queries.

[protected] QVariant QSqlResult::boundValue(int index) const

Returns the value bound at position index in the current record (row).

See also bindValue() and boundValues().

[protected] QVariant QSqlResult::boundValue(const QString &placeholder) const

This is an overloaded function.

Returns the value bound by the given placeholder name in the current record (row).

See also bindValueType().

[protected] int QSqlResult::boundValueCount() const

Returns the number of bound values in the result.

See also boundValues().

[protected] QString QSqlResult::boundValueName(int index) const

Returns the name of the bound value at position index in the current record (row).

See also boundValue().

[protected] QList<QVariant> &QSqlResult::boundValues() const

Returns a vector of the result's bound values for the current record (row).

See also boundValueCount().

[protected] void QSqlResult::clear()

Clears the entire result set and releases any associated resources.

[pure virtual protected] QVariant QSqlResult::data(int index)

Returns the data for field index in the current row as a QVariant. This function is only called if the result is in an active state and is positioned on a valid record and index is non-negative. Derived classes must reimplement this function and return the value of field index, or QVariant() if it cannot be determined.

[protected] const QSqlDriver *QSqlResult::driver() const

Returns the driver associated with the result. This is the object that was passed to the constructor.

[virtual protected] bool QSqlResult::exec()

Executes the query, returning true if successful; otherwise returns false.

See also prepare().

[protected] QString QSqlResult::executedQuery() const

Returns the query that was actually executed. This may differ from the query that was passed, for example if bound values were used with a prepared query and the underlying database doesn't support prepared queries.

See also exec() and setQuery().

[pure virtual protected] bool QSqlResult::fetch(int index)

Positions the result to an arbitrary (zero-based) row index.

This function is only called if the result is in an active state. Derived classes must reimplement this function and position the result to the row index, and call setAt() with an appropriate value. Return true to indicate success, or false to signify failure.

See also isActive(), fetchFirst(), fetchLast(), fetchNext(), and fetchPrevious().

[pure virtual protected] bool QSqlResult::fetchFirst()

Positions the result to the first record (row 0) in the result.

This function is only called if the result is in an active state. Derived classes must reimplement this function and position the result to the first record, and call setAt() with an appropriate value. Return true to indicate success, or false to signify failure.

See also fetch() and fetchLast().

[pure virtual protected] bool QSqlResult::fetchLast()

Positions the result to the last record (last row) in the result.

This function is only called if the result is in an active state. Derived classes must reimplement this function and position the result to the last record, and call setAt() with an appropriate value. Return true to indicate success, or false to signify failure.

See also fetch() and fetchFirst().

[virtual protected] bool QSqlResult::fetchNext()

Positions the result to the next available record (row) in the result.

This function is only called if the result is in an active state. The default implementation calls fetch() with the next index. Derived classes can reimplement this function and position the result to the next record in some other way, and call setAt() with an appropriate value. Return true to indicate success, or false to signify failure.

See also fetch() and fetchPrevious().

[virtual protected] bool QSqlResult::fetchPrevious()

Positions the result to the previous record (row) in the result.

This function is only called if the result is in an active state. The default implementation calls fetch() with the previous index. Derived classes can reimplement this function and position the result to the next record in some other way, and call setAt() with an appropriate value. Return true to indicate success, or false to signify failure.

[virtual] QVariant QSqlResult::handle() const

Returns the low-level database handle for this result set wrapped in a QVariant or an invalid QVariant if there is no handle.

Warning: Use this with uttermost care and only if you know what you're doing.

Warning: The handle returned here can become a stale pointer if the result is modified (for example, if you clear it).

Warning: The handle can be NULL if the result was not executed yet.

Warning: PostgreSQL: in forward-only mode, the handle of QSqlResult can change after calling fetch(), fetchFirst(), fetchLast(), fetchNext(), fetchPrevious(), nextResult().

The handle returned here is database-dependent, you should query the type name of the variant before accessing it.

This example retrieves the handle for a sqlite result:

QSqlDatabase db = QSqlDatabase::database("sales");
QSqlQuery query("SELECT NAME, DOB FROM EMPLOYEES", db);

QVariant v = query.result()->handle();
if (v.isValid() && qstrcmp(v.typeName(), "sqlite3_stmt*") == 0) {
    // v.data() returns a pointer to the handle
    sqlite3_stmt *handle = *static_cast<sqlite3_stmt **>(v.data());
    if (handle) {
        // ...
    }
}

This snippet returns the handle for PostgreSQL or MySQL:

if (qstrcmp(v.typeName(), "PGresult*") == 0) {
    PGresult *handle = *static_cast<PGresult **>(v.data());
    if (handle) {
        // ...
        }
}

if (qstrcmp(v.typeName(), "MYSQL_STMT*") == 0) {
    MYSQL_STMT *handle = *static_cast<MYSQL_STMT **>(v.data());
    if (handle) {
        // ...
        }
    }

See also QSqlDriver::handle().

[protected] bool QSqlResult::hasOutValues() const

Returns true if at least one of the query's bound values is a QSql::Out or a QSql::InOut; otherwise returns false.

See also bindValueType().

[protected] bool QSqlResult::isActive() const

Returns true if the result has records to be retrieved; otherwise returns false.

[protected] bool QSqlResult::isForwardOnly() const

Returns true if you can only scroll forward through the result set; otherwise returns false.

See also setForwardOnly().

[pure virtual protected] bool QSqlResult::isNull(int index)

Returns true if the field at position index in the current row is null; otherwise returns false.

[protected] bool QSqlResult::isSelect() const

Returns true if the current result is from a SELECT statement; otherwise returns false.

See also setSelect().

[protected] bool QSqlResult::isValid() const

Returns true if the result is positioned on a valid record (that is, the result is not positioned before the first or after the last record); otherwise returns false.

See also at().

[protected] QSqlError QSqlResult::lastError() const

Returns the last error associated with the result.

See also setLastError().

[virtual protected] QVariant QSqlResult::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.

Note that for Oracle databases the row's ROWID will be returned, while for MySQL databases the row's auto-increment field will be returned.

See also QSqlDriver::hasFeature().

[protected] QString QSqlResult::lastQuery() const

Returns the current SQL query text, or an empty string if there isn't one.

See also setQuery().

[pure virtual protected] int QSqlResult::numRowsAffected()

Returns the number of rows affected by the last query executed, or -1 if it cannot be determined or if the query is a SELECT statement.

See also size().

[virtual protected] bool QSqlResult::prepare(const QString &query)

Prepares the given query for execution; the query will normally use placeholders so that it can be executed repeatedly. Returns true if the query is prepared successfully; otherwise returns false.

See also exec().

[virtual protected] QSqlRecord QSqlResult::record() const

Returns the current record if the query is active; otherwise returns an empty QSqlRecord.

The default implementation always returns an empty QSqlRecord.

See also isActive().

[pure virtual protected] bool QSqlResult::reset(const QString &query)

Sets the result to use the SQL statement query for subsequent data retrieval.

Derived classes must reimplement this function and apply the query to the database. This function is only called after the result is set to an inactive state and is positioned before the first record of the new result. Derived classes should return true if the query was successful and ready to be used, or false otherwise.

See also setQuery().

[protected] void QSqlResult::resetBindCount()

Resets the number of bind parameters.

[virtual protected] bool QSqlResult::savePrepare(const QString &query)

Prepares the given query, using the underlying database functionality where possible. Returns true if the query is prepared successfully; otherwise returns false.

Note: This method should have been called "safePrepare()".

See also prepare().

[virtual protected] void QSqlResult::setActive(bool active)

This function is provided for derived classes to set the internal active state to active.

See also isActive().

[virtual protected] void QSqlResult::setAt(int index)

This function is provided for derived classes to set the internal (zero-based) row position to index.

See also at().

[virtual protected] void QSqlResult::setForwardOnly(bool forward)

Sets forward only mode to forward. If forward is true, only fetchNext() is allowed for navigating the results. Forward only mode needs much less memory since results do not have to be cached. By default, this feature is disabled.

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.

Note: Calling setForwardOnly after execution of the query will result in unexpected results at best, and crashes at worst.

Note: To make sure the forward-only query completed successfully, the application should check lastError() for an error not only after executing the query, but also after navigating the query results.

Warning: PostgreSQL: While navigating the query results in forward-only mode, do not execute any other SQL command on the same database connection. This will cause the query results to be lost.

See also isForwardOnly(), fetchNext(), and QSqlQuery::setForwardOnly().

[virtual protected] void QSqlResult::setLastError(const QSqlError &error)

This function is provided for derived classes to set the last error to error.

See also lastError().

[virtual protected] void QSqlResult::setQuery(const QString &query)

Sets the current query for the result to query. You must call reset() to execute the query on the database.

See also reset() and lastQuery().

[virtual protected] void QSqlResult::setSelect(bool select)

This function is provided for derived classes to indicate whether or not the current statement is a SQL SELECT statement. The select parameter should be true if the statement is a SELECT statement; otherwise it should be false.

See also isSelect().

[pure virtual protected] int QSqlResult::size()

Returns the size of the SELECT result, or -1 if it cannot be determined or if the query is not a SELECT statement.

See also numRowsAffected().