#include <qsql_oci_p.h>

Inheritance diagram for QOCIResult:

Collaboration diagram for QOCIResult:

Public Member Functions
	QOCIResult (const QOCIDriver *db)
	~QOCIResult () override
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 (ValueCache &values, int index) 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.
QVariant	lastInsertId () const override
	Returns the object ID of the most recent inserted row if the database supports it.
bool	execBatch (bool arrayBind=false) override
void	virtual_hook (int id, void *data) override
bool	fetchNext () override
	Positions the result to the next available record (row) in the result.
bool	internal_prepare ()
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
ValueCache &	cache ()
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 QSqlDriver *	driver () 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.
QVariantList &	boundValues (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.
QSql::NumericalPrecisionPolicy	numericalPrecisionPolicy () const
void	setPositionalBindingEnabled (bool enable)
bool	isPositionalBindingEnabled () const
virtual bool	nextResult ()
void	resetBindCount ()
	Resets the number of bind parameters.

Protected Attributes
bool	isCursor
Protected Attributes inherited from QSqlResult
QSqlResultPrivate *	d_ptr

Friends
class	QOCICols

Additional Inherited Members
Public Types inherited from QSqlCachedResult
typedef QList< 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

Detailed Description

Definition at line 72 of file qsql_oci_p.h.

Constructor & Destructor Documentation

◆ QOCIResult()

QOCIResult::QOCIResult ( const QOCIDriver * db )

explicit

Definition at line 1810 of file qsql_oci.cpp.

◆ ~QOCIResult()

QOCIResult::~QOCIResult ( )

override

Definition at line 1816 of file qsql_oci.cpp.

Member Function Documentation

◆ exec()

bool QOCIResult::exec ( )

overridevirtual

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

See also: prepare()

Reimplemented from QSqlResult.

Definition at line 1967 of file qsql_oci.cpp.

◆ execBatch()

bool QOCIResult::execBatch ( bool arrayBind = false )

overrideprotectedvirtual

Executes a prepared query in batch mode if the driver supports it, otherwise emulates a batch execution using bindValue() and exec(). QSqlDriver::hasFeature() can be used to find out whether a driver supports batch execution.

Batch execution can be faster for large amounts of data since it reduces network roundtrips.

For batch executions, bound values have to be provided as lists of variants (QVariantList).

Each list must contain values of the same type. All lists must contain equal amount of values (rows).

NULL values are passed in as typed QVariants, for example {QVariant(QMetaType::fromType<int>())} for an integer NULL value.

Example:

QSqlQuery q;
q.prepare("insert into test (i1, i2, s) values (?, ?, ?)");
 
QVariantList col1;
QVariantList col2;
QVariantList col3;
 
col1 << 1 << 3;
col2 << 2 << 4;
col3 << "hello" << "world";
 
q.bindValue(0, col1);
q.bindValue(1, col2);
q.bindValue(2, col3);
 
if (!q.execBatch())
    qDebug() << q.lastError();

Here, we insert two rows into a SQL table, with each row containing three values.

See also: exec(), QSqlDriver::hasFeature()

Reimplemented from QSqlResult.

Definition at line 2074 of file qsql_oci.cpp.

◆ fetchNext()

bool QOCIResult::fetchNext ( )

overrideprotectedvirtual

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

Reimplemented from QSqlResult.

Definition at line 2089 of file qsql_oci.cpp.

◆ gotoNext()

bool QOCIResult::gotoNext	(	QSqlCachedResult::ValueCache &	values,
		int	index )

overrideprotectedvirtual

Implements QSqlCachedResult.

Definition at line 1833 of file qsql_oci.cpp.

◆ handle()

QVariant QOCIResult::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:

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

Reimplemented from QSqlResult.

Definition at line 1820 of file qsql_oci.cpp.

◆ internal_prepare()

bool QOCIResult::internal_prepare ( )

protected

Definition at line 1906 of file qsql_oci.cpp.

◆ lastInsertId()

QVariant QOCIResult::lastInsertId ( ) const

overrideprotectedvirtual

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 2060 of file qsql_oci.cpp.

◆ numRowsAffected()

int QOCIResult::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 1893 of file qsql_oci.cpp.

◆ prepare()

bool QOCIResult::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 1940 of file qsql_oci.cpp.

◆ record()

QSqlRecord QOCIResult::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 2051 of file qsql_oci.cpp.

◆ reset()

bool QOCIResult::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 1826 of file qsql_oci.cpp.

◆ size()

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

Definition at line 1888 of file qsql_oci.cpp.

◆ virtual_hook()

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

overrideprotectedvirtual

Reimplemented from QSqlResult.

Definition at line 2082 of file qsql_oci.cpp.

◆ QOCICols

friend class QOCICols

friend

Definition at line 74 of file qsql_oci_p.h.

Member Data Documentation

◆ isCursor

bool QOCIResult::isCursor

protected

Definition at line 83 of file qsql_oci_p.h.

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

qtbase/src/plugins/sqldrivers/oci/qsql_oci_p.h (55f46569f3e9688c2a07973923bfda68aa2b0c3e)
qtbase/src/plugins/sqldrivers/oci/qsql_oci.cpp (55f46569f3e9688c2a07973923bfda68aa2b0c3e)

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QOCIResult()

◆ ~QOCIResult()

Member Function Documentation

◆ exec()

◆ execBatch()

◆ fetchNext()

◆ gotoNext()

◆ handle()

◆ internal_prepare()

◆ lastInsertId()

◆ numRowsAffected()

◆ prepare()

◆ record()

◆ reset()

◆ size()

◆ virtual_hook()

Friends And Related Symbol Documentation

◆ QOCICols

Member Data Documentation

◆ isCursor