#include <qsql_sqlite.h>

Inheritance diagram for QSQLiteResult:

Public Functions
QVariant	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. More...

	QSQLiteResult (const QSQLiteDriver *db)

	~QSQLiteResult ()

Public Functions inherited from QSqlCachedResult
virtual	~QSqlCachedResult ()

Public Functions inherited from QSqlResult
virtual	~QSqlResult ()
	Destroys the object and frees any allocated resources. More...

Protected Functions
bool	exec ()
	Executes the query, returning true if successful; otherwise returns false. More...

bool	gotoNext (QSqlCachedResult::ValueCache &row, int idx)

QVariant	lastInsertId () const
	Returns the object ID of the most recent inserted row if the database supports it. More...

int	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. More...

bool	prepare (const QString &query)
	Prepares the given query for execution; the query will normally use placeholders so that it can be executed repeatedly. More...

QSqlRecord	record () const
	Returns the current record if the query is active; otherwise returns an empty QSqlRecord. More...

bool	reset (const QString &query)
	Sets the result to use the SQL statement query for subsequent data retrieval. More...

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

void	virtual_hook (int id, void *data)

Protected Functions inherited from QSqlCachedResult
ValueCache &	cache ()

void	cleanup ()

void	clearValues ()

int	colCount () const

QVariant	data (int i)
	Returns the data for field index in the current row as a QVariant. More...

bool	fetch (int i)
	Positions the result to an arbitrary (zero-based) row index. More...

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

bool	fetchLast ()
	Positions the result to the last record (last row) in the result. More...

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

bool	fetchPrevious ()
	Positions the result to the previous record (row) in the result. More...

void	init (int colCount)

bool	isNull (int i)
	Returns true if the field at position index in the current row is null; otherwise returns false. More...

	QSqlCachedResult (const QSqlDriver *db)

void	virtual_hook (int id, void *data)

Protected Functions inherited from QSqlResult
void	addBindValue (const QVariant &val, QSql::ParamType type)
	Binds the value val of parameter type paramType to the next available position in the current record (row). More...

int	at () const
	Returns the current (zero-based) row position of the result. More...

BindingSyntax	bindingSyntax () const
	Returns the binding syntax used by prepared queries. More...

virtual void	bindValue (int pos, const QVariant &val, QSql::ParamType type)
	Binds the value val of parameter type paramType to position index in the current record (row). More...

virtual void	bindValue (const QString &placeholder, const QVariant &val, QSql::ParamType type)
	Binds the value val of parameter type paramType to the placeholder name in the current record (row). More...

QSql::ParamType	bindValueType (const QString &placeholder) const
	Returns the parameter type for the value bound with the given placeholder name. More...

QSql::ParamType	bindValueType (int pos) const
	Returns the parameter type for the value bound at position index. More...

QVariant	boundValue (const QString &placeholder) const
	Returns the value bound by the given placeholder name in the current record (row). More...

QVariant	boundValue (int pos) const
	Returns the value bound at position index in the current record (row). More...

int	boundValueCount () const
	Returns the number of bound values in the result. More...

QString	boundValueName (int pos) const
	Returns the name of the bound value at position index in the current record (row). More...

QVector< QVariant > &	boundValues () const
	Returns a vector of the result's bound values for the current record (row). More...

void	clear ()
	Clears the entire result set and releases any associated resources. More...

void	detachFromResultSet ()

const QSqlDriver *	driver () const
	Returns the driver associated with the result. More...

bool	execBatch (bool arrayBind=false)
	Executes a prepared query in batch mode if the driver supports it, otherwise emulates a batch execution using bindValue() and exec(). More...

QString	executedQuery () const
	Returns the query that was actually executed. More...

bool	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. More...

bool	isActive () const
	Returns true if the result has records to be retrieved; otherwise returns false. More...

bool	isForwardOnly () const
	Returns true if you can only scroll forward through the result set; otherwise returns false. More...

bool	isSelect () const
	Returns true if the current result is from a `SELECT` statement; otherwise returns false. More...

bool	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. More...

QSqlError	lastError () const
	Returns the last error associated with the result. More...

QString	lastQuery () const
	Returns the current SQL query text, or an empty string if there isn't one. More...

bool	nextResult ()

QSql::NumericalPrecisionPolicy	numericalPrecisionPolicy () const

	QSqlResult (const QSqlDriver *db)
	Creates a QSqlResult using database driver db. More...

virtual bool	savePrepare (const QString &sqlquery)
	Prepares the given query, using the underlying database functionality where possible. More...

virtual void	setActive (bool a)
	This function is provided for derived classes to set the internal active state to active. More...

virtual void	setAt (int at)
	This function is provided for derived classes to set the internal (zero-based) row position to index. More...

virtual void	setForwardOnly (bool forward)
	Sets forward only mode to forward. More...

virtual void	setLastError (const QSqlError &e)
	This function is provided for derived classes to set the last error to error. More...

void	setNumericalPrecisionPolicy (QSql::NumericalPrecisionPolicy policy)

virtual void	setQuery (const QString &query)
	Sets the current query for the result to query. More...

virtual void	setSelect (bool s)
	This function is provided for derived classes to indicate whether or not the current statement is a SQL `SELECT` statement. More...

Properties
QSQLiteResultPrivate *	d

Friends
class	QSQLiteDriver

class	QSQLiteResultPrivate

Additional Inherited Members
Public Types inherited from QSqlCachedResult
typedef QVector< QVariant >	ValueCache

Protected Types inherited from QSqlResult
enum	BindingSyntax { PositionalBinding, NamedBinding }
	This enum type specifies the different syntaxes for specifying placeholders in prepared queries. More...

enum	VirtualHookOperation { BatchOperation, DetachFromResultSet, SetNumericalPrecision, NextResult }

Detailed Description

Definition at line 64 of file qsql_sqlite.h.

Constructors and Destructors

◆ QSQLiteResult()

QSQLiteResult::QSQLiteResult ( const QSQLiteDriver * db )

explicit

Definition at line 310 of file qsql_sqlite.cpp.

     : QSqlCachedResult(db)
 {
     d = new QSQLiteResultPrivate(this);
     d->access = db->d->access;
     db->d->results.append(this);
 }

◆ ~QSQLiteResult()

QSQLiteResult::~QSQLiteResult ( )

Definition at line 318 of file qsql_sqlite.cpp.

 {
     const QSQLiteDriver * sqlDriver = qobject_cast<const QSQLiteDriver *>(driver());
     if (sqlDriver)
         sqlDriver->d->results.removeOne(this);
     d->cleanup();
     delete d;
 }

Functions

◆ exec()

bool QSQLiteResult::exec ( )

protectedvirtual

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

See also: prepare()

Reimplemented from QSqlResult.

Definition at line 379 of file qsql_sqlite.cpp.

Referenced by reset().

 {
     const QVector<QVariant> values = boundValues();
 
     d->skippedStatus = false;
     d->skipRow = false;
     d->rInf.clear();
     clearValues();
     setLastError(QSqlError());
 
     int res = sqlite3_reset(d->stmt);
     if (res != SQLITE_OK) {
         setLastError(qMakeError(d->access, QCoreApplication::translate("QSQLiteResult",
                      "Unable to reset statement"), QSqlError::StatementError, res));
         d->finalize();
         return false;
     }
     int paramCount = sqlite3_bind_parameter_count(d->stmt);
     if (paramCount == values.count()) {
         for (int i = 0; i < paramCount; ++i) {
             res = SQLITE_OK;
             const QVariant value = values.at(i);
 
             if (value.isNull()) {
                 res = sqlite3_bind_null(d->stmt, i + 1);
             } else {
                 switch (value.type()) {
                 case QVariant::ByteArray: {
                     const QByteArray *ba = static_cast<const QByteArray*>(value.constData());
                     res = sqlite3_bind_blob(d->stmt, i + 1, ba->constData(),
                                             ba->size(), SQLITE_STATIC);
                     break; }
                 case QVariant::Int:
                     res = sqlite3_bind_int(d->stmt, i + 1, value.toInt());
                     break;
                 case QVariant::Double:
                     res = sqlite3_bind_double(d->stmt, i + 1, value.toDouble());
                     break;
                 case QVariant::UInt:
                 case QVariant::LongLong:
                     res = sqlite3_bind_int64(d->stmt, i + 1, value.toLongLong());
                     break;
                 case QVariant::String: {
                     // lifetime of string == lifetime of its qvariant
                     const QString *str = static_cast<const QString*>(value.constData());
                     res = sqlite3_bind_text16(d->stmt, i + 1, str->utf16(),
                                               (str->size()) * sizeof(QChar), SQLITE_STATIC);
                     break; }
                 default: {
                     QString str = value.toString();
                     // SQLITE_TRANSIENT makes sure that sqlite buffers the data
                     res = sqlite3_bind_text16(d->stmt, i + 1, str.utf16(),
                                               (str.size()) * sizeof(QChar), SQLITE_TRANSIENT);
                     break; }
                 }
             }
             if (res != SQLITE_OK) {
                 setLastError(qMakeError(d->access, QCoreApplication::translate("QSQLiteResult",
                              "Unable to bind parameters"), QSqlError::StatementError, res));
                 d->finalize();
                 return false;
             }
         }
     } else {
         setLastError(QSqlError(QCoreApplication::translate("QSQLiteResult",
                         "Parameter count mismatch"), QString(), QSqlError::StatementError));
         return false;
     }
     d->skippedStatus = d->fetchNext(d->firstRow, 0, true);
     if (lastError().isValid()) {
         setSelect(false);
         setActive(false);
         return false;
     }
     setSelect(!d->rInf.isEmpty());
     setActive(true);
     return true;
 }

◆ gotoNext()

bool QSQLiteResult::gotoNext	(	QSqlCachedResult::ValueCache &	row,
		int	idx
	)

protectedvirtual

Implements QSqlCachedResult.

Definition at line 458 of file qsql_sqlite.cpp.

 {
     return d->fetchNext(row, idx, false);
 }

◆ handle()

QVariant QSQLiteResult::handle ( ) const

virtual

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.; The handle returned here can become a stale pointer if the result is modified (for example, if you clear it).; The handle can be NULL if the result was not executed yet.

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:

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

This snippet returns the handle for PostgreSQL or MySQL:

if (v.typeName() == "PGresult*") {
    PGresult *handle = *static_cast<PGresult **>(v.data());
    if (handle != 0) ...
}
if (v.typeName() == "MYSQL_STMT*") {
    MYSQL_STMT *handle = *static_cast<MYSQL_STMT **>(v.data());
    if (handle != 0) ...
}

See also: QSqlDriver::handle()

Reimplemented from QSqlResult.

Definition at line 490 of file qsql_sqlite.cpp.

 {
     return QVariant::fromValue(d->stmt);
 }

◆ lastInsertId()

QVariant QSQLiteResult::lastInsertId ( ) const

protectedvirtual

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

Reimplemented from QSqlResult.

Definition at line 473 of file qsql_sqlite.cpp.

 {
     if (isActive()) {
         qint64 id = sqlite3_last_insert_rowid(d->access);
         if (id)
             return id;
     }
     return QVariant();
 }

◆ numRowsAffected()

int QSQLiteResult::numRowsAffected ( )

protectedvirtual

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

Implements QSqlResult.

Definition at line 468 of file qsql_sqlite.cpp.

 {
     return sqlite3_changes(d->access);
 }

◆ prepare()

bool QSQLiteResult::prepare ( const QString & query )

protectedvirtual

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

Reimplemented from QSqlResult.

Definition at line 346 of file qsql_sqlite.cpp.

Referenced by reset().

 {
     if (!driver() || !driver()->isOpen() || driver()->isOpenError())
         return false;
 
     d->cleanup();
 
     setSelect(false);
 
     const void *pzTail = NULL;
 
 #if (SQLITE_VERSION_NUMBER >= 3003011)
     int res = sqlite3_prepare16_v2(d->access, query.constData(), (query.size() + 1) * sizeof(QChar),
                                    &d->stmt, &pzTail);
 #else
     int res = sqlite3_prepare16(d->access, query.constData(), (query.size() + 1) * sizeof(QChar),
                                 &d->stmt, &pzTail);
 #endif
 
     if (res != SQLITE_OK) {
         setLastError(qMakeError(d->access, QCoreApplication::translate("QSQLiteResult",
                      "Unable to execute statement"), QSqlError::StatementError, res));
         d->finalize();
         return false;
     } else if (pzTail && !QString(reinterpret_cast<const QChar *>(pzTail)).trimmed().isEmpty()) {
         setLastError(qMakeError(d->access, QCoreApplication::translate("QSQLiteResult",
             "Unable to execute multiple statements at a time"), QSqlError::StatementError, SQLITE_MISUSE));
         d->finalize();
         return false;
     }
     return true;
 }

◆ record()

QSqlRecord QSQLiteResult::record ( ) const

protectedvirtual

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

Reimplemented from QSqlResult.

Definition at line 483 of file qsql_sqlite.cpp.

 {
     if (!isActive() || !isSelect())
         return QSqlRecord();
     return d->rInf;
 }

◆ reset()

bool QSQLiteResult::reset ( const QString & query )

protectedvirtual

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

Implements QSqlResult.

Definition at line 339 of file qsql_sqlite.cpp.

 {
     if (!prepare(query))
         return false;
     return exec();
 }

◆ size()

int QSQLiteResult::size ( )

protectedvirtual

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

Implements QSqlResult.

Definition at line 463 of file qsql_sqlite.cpp.

 {
     return -1;
 }

◆ virtual_hook()

void QSQLiteResult::virtual_hook	(	int	id,
		void *	data
	)

protectedvirtual

Warning: This function is not part of the public interface.

Reimplemented from QSqlResult.

Definition at line 327 of file qsql_sqlite.cpp.

 {
     switch (id) {
     case QSqlResult::DetachFromResultSet:
         if (d->stmt)
             sqlite3_reset(d->stmt);
         break;
     default:
         QSqlCachedResult::virtual_hook(id, data);
     }
 }

Friends and Related Functions

◆ QSQLiteDriver

friend class QSQLiteDriver

friend

Definition at line 66 of file qsql_sqlite.h.

◆ QSQLiteResultPrivate

friend class QSQLiteResultPrivate

friend

Definition at line 67 of file qsql_sqlite.h.

Referenced by QSQLiteResult().

Properties

◆ d

QSQLiteResultPrivate* QSQLiteResult::d

private

Definition at line 85 of file qsql_sqlite.h.

Referenced by QSQLiteDriver::close(), exec(), gotoNext(), handle(), lastInsertId(), numRowsAffected(), prepare(), QSQLiteResult(), record(), virtual_hook(), and ~QSQLiteResult().

The documentation for this class was generated from the following files:

/src/sql/drivers/sqlite/qsql_sqlite.h
/src/sql/drivers/sqlite/qsql_sqlite.cpp

Public Functions

Protected Functions

Properties

Friends

Additional Inherited Members

Detailed Description

Constructors and Destructors

◆ QSQLiteResult()

◆ ~QSQLiteResult()

Functions

◆ exec()

◆ gotoNext()

◆ handle()

◆ lastInsertId()

◆ numRowsAffected()

◆ prepare()

◆ record()

◆ reset()

◆ size()

◆ virtual_hook()

Friends and Related Functions

◆ QSQLiteDriver

◆ QSQLiteResultPrivate

Properties

◆ d