Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QIBaseResult Class Reference
Inheritance diagram for QIBaseResult:
Collaboration diagram for QIBaseResult:

Public Member Functions

 QIBaseResult (const QIBaseDriver *db)
bool prepare (const QString &query) override
 Prepares the given query for execution; the query will normally use placeholders so that it can be executed repeatedly.
bool exec () override
 Executes the query, returning true if successful; otherwise returns false.
QVariant handle () const override
 Returns the low-level database handle for this result set wrapped in a QVariant or an invalid QVariant if there is no handle.
 QIBaseResult (const QIBaseDriver *db)
bool prepare (const QString &query) override
 Prepares the given query for execution; the query will normally use placeholders so that it can be executed repeatedly.
bool exec () override
 Executes the query, returning true if successful; otherwise returns false.
QVariant handle () const override
 Returns the low-level database handle for this result set wrapped in a QVariant or an invalid QVariant if there is no handle.
Public Member Functions inherited from QSqlResult
virtual ~QSqlResult ()
 Destroys the object and frees any allocated resources.

Protected Member Functions

bool gotoNext (QSqlCachedResult::ValueCache &row, int rowIdx) override
bool reset (const QString &query) override
 Sets the result to use the SQL statement query for subsequent data retrieval.
int size () override
 Returns the size of the SELECT result, or -1 if it cannot be determined or if the query is not a SELECT statement.
int numRowsAffected () override
 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.
QSqlRecord record () const override
 Returns the current record if the query is active; otherwise returns an empty QSqlRecord.
template<typename T>
QVariant applyScale (T val, int scale) const
template<typename T>
void setWithScale (const QVariant &val, int scale, char *data)
bool gotoNext (QSqlCachedResult::ValueCache &row, int rowIdx) override
bool reset (const QString &query) override
 Sets the result to use the SQL statement query for subsequent data retrieval.
int size () override
 Returns the size of the SELECT result, or -1 if it cannot be determined or if the query is not a SELECT statement.
int numRowsAffected () override
 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.
QSqlRecord record () const override
 Returns the current record if the query is active; otherwise returns an empty QSqlRecord.
template<typename T>
QVariant applyScale (T val, int scale) const
template<typename T>
void setWithScale (const QVariant &val, int scale, char *data)
Protected Member Functions inherited from QSqlCachedResult
 QSqlCachedResult (QSqlCachedResultPrivate &d)
void init (int colCount)
void cleanup ()
void clearValues ()
QVariant data (int i) override
 Returns the data for field index in the current row as a QVariant.
bool isNull (int i) override
 Returns true if the field at position index in the current row is null; otherwise returns false.
bool fetch (int i) override
 Positions the result to an arbitrary (zero-based) row index.
bool fetchNext () override
 Positions the result to the next available record (row) in the result.
bool fetchPrevious () override
 Positions the result to the previous record (row) in the result.
bool fetchFirst () override
 Positions the result to the first record (row 0) in the result.
bool fetchLast () override
 Positions the result to the last record (last row) in the result.
int colCount () const
ValueCachecache ()
void virtual_hook (int id, void *data) override
void detachFromResultSet () override
void setNumericalPrecisionPolicy (QSql::NumericalPrecisionPolicy policy) override
Protected Member Functions inherited from QSqlResult
 QSqlResult (const QSqlDriver *db)
 Creates a QSqlResult using database driver db.
 QSqlResult (QSqlResultPrivate &dd)
int at () const
 Returns the current (zero-based) row position of the result.
QString lastQuery () const
 Returns the current SQL query text, or an empty string if there isn't one.
QSqlError lastError () const
 Returns the last error associated with the result.
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.
bool isActive () const
 Returns true if the result has records to be retrieved; otherwise returns false.
bool isSelect () const
 Returns true if the current result is from a SELECT statement; otherwise returns false.
bool isForwardOnly () const
 Returns true if you can only scroll forward through the result set; otherwise returns false.
const QSqlDriverdriver () const
 Returns the driver associated with the result.
virtual void setAt (int at)
 This function is provided for derived classes to set the internal (zero-based) row position to index.
virtual void setActive (bool a)
 This function is provided for derived classes to set the internal active state to active.
virtual void setLastError (const QSqlError &e)
 This function is provided for derived classes to set the last error to error.
virtual void setQuery (const QString &query)
 Sets the current query for the result to query.
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.
virtual void setForwardOnly (bool forward)
 Sets forward only mode to forward.
virtual bool savePrepare (const QString &sqlquery)
 Prepares the given query, using the underlying database functionality where possible.
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).
virtual void bindValue (const QString &placeholder, const QVariant &val, QSql::ParamType type)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Binds the value val of parameter type paramType to the placeholder name in the current record (row).
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).
QVariant boundValue (const QString &placeholder) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Returns the value bound by the given placeholder name in the current record (row).
QVariant boundValue (int pos) const
 Returns the value bound at position index in the current record (row).
QSql::ParamType bindValueType (const QString &placeholder) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Returns the parameter type for the value bound with the given placeholder name.
QSql::ParamType bindValueType (int pos) const
 Returns the parameter type for the value bound at position index.
int boundValueCount () const
 Returns the number of bound values in the result.
QVariantListboundValues (QT6_DECL_NEW_OVERLOAD)
QVariantList boundValues (QT6_DECL_NEW_OVERLOAD) const
QString executedQuery () const
 Returns the query that was actually executed.
QStringList boundValueNames () const
 Returns the names of all bound values.
QString boundValueName (int pos) const
 Returns the name of the bound value at position index in the current record (row).
void clear ()
 Clears the entire result set and releases any associated resources.
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.
BindingSyntax bindingSyntax () const
 Returns the binding syntax used by prepared queries.
virtual QVariant lastInsertId () const
 Returns the object ID of the most recent inserted row if the database supports it.
virtual bool execBatch (bool arrayBind=false)
QSql::NumericalPrecisionPolicy numericalPrecisionPolicy () const
void setPositionalBindingEnabled (bool enable)
bool isPositionalBindingEnabled () const
virtual bool nextResult ()
void resetBindCount ()
 Resets the number of bind parameters.

Static Protected Member Functions

template<typename T>
static QString numberToHighPrecision (T val, int scale)
template<typename T>
static QString numberToHighPrecision (T val, int scale)

Additional Inherited Members

Public Types inherited from QSqlCachedResult
typedef QList< QVariantValueCache
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
Protected Attributes inherited from QSqlResult
QSqlResultPrivated_ptr

Detailed Description

Definition at line 390 of file qsql_ibase.cpp.

Constructor & Destructor Documentation

◆ QIBaseResult() [1/2]

QIBaseResult::QIBaseResult ( const QIBaseDriver * db)
explicit

Definition at line 1016 of file qsql_ibase.cpp.

◆ QIBaseResult() [2/2]

QIBaseResult::QIBaseResult ( const QIBaseDriver * db)
explicit

Member Function Documentation

◆ applyScale() [1/2]

template<typename T>
QVariant QIBaseResult::applyScale ( T val,
int scale ) const
inlineprotected

Definition at line 435 of file qsql_ibase.cpp.

◆ applyScale() [2/2]

template<typename T>
QVariant QIBaseResult::applyScale ( T val,
int scale ) const
inlineprotected

Definition at line 435 of file qsql_ibase.cpp.

◆ exec() [1/2]

bool QIBaseResult::exec ( )
overridevirtual

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

See also
prepare()

Reimplemented from QSqlResult.

Definition at line 1097 of file qsql_ibase.cpp.

Referenced by reset().

Here is the caller graph for this function:

◆ exec() [2/2]

bool QIBaseResult::exec ( )
overridevirtual

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

See also
prepare()

Reimplemented from QSqlResult.

◆ gotoNext() [1/2]

bool QIBaseResult::gotoNext ( QSqlCachedResult::ValueCache & row,
int rowIdx )
overrideprotectedvirtual

Implements QSqlCachedResult.

Definition at line 1247 of file qsql_ibase.cpp.

◆ gotoNext() [2/2]

bool QIBaseResult::gotoNext ( QSqlCachedResult::ValueCache & row,
int rowIdx )
overrideprotectedvirtual

Implements QSqlCachedResult.

◆ handle() [1/2]

QVariant QIBaseResult::handle ( ) const
overridevirtual

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

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

Reimplemented from QSqlResult.

Definition at line 1533 of file qsql_ibase.cpp.

◆ handle() [2/2]

QVariant QIBaseResult::handle ( ) const
overridevirtual

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

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

Reimplemented from QSqlResult.

◆ numberToHighPrecision() [1/2]

template<typename T>
QString QIBaseResult::numberToHighPrecision ( T val,
int scale )
inlinestaticprotected

Definition at line 409 of file qsql_ibase.cpp.

◆ numberToHighPrecision() [2/2]

template<typename T>
QString QIBaseResult::numberToHighPrecision ( T val,
int scale )
inlinestaticprotected

Definition at line 409 of file qsql_ibase.cpp.

◆ numRowsAffected() [1/2]

int QIBaseResult::numRowsAffected ( )
overrideprotectedvirtual

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 1437 of file qsql_ibase.cpp.

◆ numRowsAffected() [2/2]

int QIBaseResult::numRowsAffected ( )
overrideprotectedvirtual

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.

◆ prepare() [1/2]

bool QIBaseResult::prepare ( const QString & query)
overridevirtual

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 1021 of file qsql_ibase.cpp.

◆ prepare() [2/2]

bool QIBaseResult::prepare ( const QString & query)
overridevirtual

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.

◆ record() [1/2]

QSqlRecord QIBaseResult::record ( ) const
overrideprotectedvirtual

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 1492 of file qsql_ibase.cpp.

◆ record() [2/2]

QSqlRecord QIBaseResult::record ( ) const
overrideprotectedvirtual

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.

◆ reset() [1/2]

bool QIBaseResult::reset ( const QString & query)
overrideprotectedvirtual

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 1240 of file qsql_ibase.cpp.

References exec().

Here is the call graph for this function:

◆ reset() [2/2]

bool QIBaseResult::reset ( const QString & query)
overrideprotectedvirtual

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.

◆ setWithScale() [1/2]

template<typename T>
void QIBaseResult::setWithScale ( const QVariant & val,
int scale,
char * data )
inlineprotected

Definition at line 454 of file qsql_ibase.cpp.

◆ setWithScale() [2/2]

template<typename T>
void QIBaseResult::setWithScale ( const QVariant & val,
int scale,
char * data )
inlineprotected

Definition at line 454 of file qsql_ibase.cpp.

◆ size() [1/2]

int QIBaseResult::size ( )
overrideprotectedvirtual

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

FIXME

Implements QSqlResult.

Definition at line 1386 of file qsql_ibase.cpp.

◆ size() [2/2]

int QIBaseResult::size ( )
overrideprotectedvirtual

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.


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