QOCIResult Class Reference

#include <qsql_oci.h>

Inheritance diagram for QOCIResult:

Public Functions
bool	exec ()
	Executes the query, returning true if successful; otherwise returns false. More...
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...
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...
	QOCIResult (const QOCIDriver *db, const QOCIDriverPrivate *p)
	~QOCIResult ()
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	gotoNext (ValueCache &values, int index)
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...
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
QOCIResultPrivate *	d

Friends
class	QOCICols
class	QOCIDriver
struct	QOCIResultPrivate

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 67 of file qsql_oci.h.

Constructors and Destructors

QOCIResult()

QOCIResult::QOCIResult	(	const QOCIDriver *	db,
		const QOCIDriverPrivate *	p
	)

Definition at line 1803 of file qsql_oci.cpp.

    : QSqlCachedResult(db)
{
    d = new QOCIResultPrivate(this, p);
}

~QOCIResult()

QOCIResult::~QOCIResult

(

)

Definition at line 1809 of file qsql_oci.cpp.

{
    if (d->sql) {
        int r = OCIHandleFree(d->sql, OCI_HTYPE_STMT);
        if (r != 0)
            qWarning("~QOCIResult: unable to free statement handle");
    }
    delete d;
}

Functions

exec()

bool QOCIResult::exec ( )

virtual

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

See also

prepare()

Reimplemented from QSqlResult.

Definition at line 1947 of file qsql_oci.cpp.

Referenced by reset().

{
    int r = 0;
    ub2 stmtType=0;
    ub4 iters;
    ub4 mode;
    QList<QByteArray> tmpStorage;
    IndicatorArray indicators(boundValueCount());
    SizeArray tmpSizes(boundValueCount());

    r = OCIAttrGet(d->sql,
                    OCI_HTYPE_STMT,
                    &stmtType,
                    NULL,
                    OCI_ATTR_STMT_TYPE,
                    d->err);

    if (r != OCI_SUCCESS && r != OCI_SUCCESS_WITH_INFO) {
        qOraWarning("QOCIResult::exec: Unable to get statement type:", d->err);
        setLastError(qMakeError(QCoreApplication::translate("QOCIResult",
                     "Unable to get statement type"), QSqlError::StatementError, d->err));
#ifdef QOCI_DEBUG
        qDebug() << "lastQuery()" << lastQuery();
#endif
        return false;
    }

    if (stmtType == OCI_STMT_SELECT) {
        iters = 0;
        mode = OCI_DEFAULT;
    } else {
        iters = 1;
        mode = d->transaction ? OCI_DEFAULT : OCI_COMMIT_ON_SUCCESS;
    }

    // bind placeholders
    if (boundValueCount() > 0
        && d->bindValues(boundValues(), indicators, tmpSizes, tmpStorage) != OCI_SUCCESS) {
        qOraWarning("QOCIResult::exec: unable to bind value: ", d->err);
        setLastError(qMakeError(QCoreApplication::translate("QOCIResult", "Unable to bind value"),
                    QSqlError::StatementError, d->err));
#ifdef QOCI_DEBUG
        qDebug() << "lastQuery()" << lastQuery();
#endif
        return false;
    }

    // execute
    r = OCIStmtExecute(d->svc,
                       d->sql,
                       d->err,
                       iters,
                       0,
                       0,
                       0,
                       mode);
    if (r != OCI_SUCCESS && r != OCI_SUCCESS_WITH_INFO) {
        qOraWarning("QOCIResult::exec: unable to execute statement:", d->err);
        setLastError(qMakeError(QCoreApplication::translate("QOCIResult",
                     "Unable to execute statement"), QSqlError::StatementError, d->err));
#ifdef QOCI_DEBUG
        qDebug() << "lastQuery()" << lastQuery();
#endif
        return false;
    }

    if (stmtType == OCI_STMT_SELECT) {
        ub4 parmCount = 0;
        int r = OCIAttrGet(d->sql, OCI_HTYPE_STMT, reinterpret_cast<void **>(&parmCount),
                           0, OCI_ATTR_PARAM_COUNT, d->err);
        if (r == 0 && !d->cols)
            d->cols = new QOCICols(parmCount, d);
        setSelect(true);
        QSqlCachedResult::init(parmCount);
    } else { /* non-SELECT */
        setSelect(false);
    }
    setAt(QSql::BeforeFirstRow);
    setActive(true);

    if (hasOutValues())
        d->outValues(boundValues(), indicators, tmpStorage);

    return true;
}

gotoNext()

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

protectedvirtual

Implements QSqlCachedResult.

Definition at line 1831 of file qsql_oci.cpp.

{
    if (at() == QSql::AfterLastRow)
        return false;

    bool piecewise = false;
    int r = OCI_SUCCESS;
    r = OCIStmtFetch(d->sql, d->err, 1, OCI_FETCH_NEXT, OCI_DEFAULT);

    if (index < 0) //not interested in values
        return r == OCI_SUCCESS || r == OCI_SUCCESS_WITH_INFO;

    switch (r) {
    case OCI_SUCCESS:
        break;
    case OCI_SUCCESS_WITH_INFO:
        qOraWarning("QOCIResult::gotoNext: SuccessWithInfo: ", d->err);
        r = OCI_SUCCESS; //ignore it
        break;
    case OCI_NO_DATA:
        // end of rowset
        return false;
    case OCI_NEED_DATA:
        piecewise = true;
        r = OCI_SUCCESS;
        break;
    case OCI_ERROR:
        if (qOraErrorNumber(d->err) == 1406) {
            qWarning("QOCI Warning: data truncated for %s", lastQuery().toLocal8Bit().constData());
            r = OCI_SUCCESS; /* ignore it */
            break;
        }
        // fall through
    default:
        qOraWarning("QOCIResult::gotoNext: ", d->err);
        setLastError(qMakeError(QCoreApplication::translate("QOCIResult",
                                "Unable to goto next"),
                                QSqlError::StatementError, d->err));
        break;
    }

    // need to read piecewise before assigning values
    if (r == OCI_SUCCESS && piecewise)
        r = d->cols->readPiecewise(values, index);

    if (r == OCI_SUCCESS)
        d->cols->getValues(values, index);
    if (r == OCI_SUCCESS)
        r = d->cols->readLOBs(values, index);
    if (r != OCI_SUCCESS)
        setAt(QSql::AfterLastRow);
    return r == OCI_SUCCESS || r == OCI_SUCCESS_WITH_INFO;
}

handle()

QVariant QOCIResult::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 1819 of file qsql_oci.cpp.

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

lastInsertId()

QVariant QOCIResult::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 2041 of file qsql_oci.cpp.

{
    if (isActive()) {
        QOCIRowIdPointer ptr(new QOCIRowId(d->env));

        int r = OCIAttrGet(d->sql, OCI_HTYPE_STMT, ptr.constData()->id,
                           0, OCI_ATTR_ROWID, d->err);
        if (r == OCI_SUCCESS)
            return QVariant::fromValue(ptr);
    }
    return QVariant();
}

numRowsAffected()

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

{
    int rowCount;
    OCIAttrGet(d->sql,
                OCI_HTYPE_STMT,
                &rowCount,
                NULL,
                OCI_ATTR_ROW_COUNT,
                d->err);
    return rowCount;
}

prepare()

bool QOCIResult::prepare ( const QString &  query )

virtual

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

Referenced by reset().

{
    int r = 0;
    QSqlResult::prepare(query);

    delete d->cols;
    d->cols = 0;
    QSqlCachedResult::cleanup();

    if (d->sql) {
        r = OCIHandleFree(d->sql, OCI_HTYPE_STMT);
        if (r != OCI_SUCCESS)
            qOraWarning("QOCIResult::prepare: unable to free statement handle:", d->err);
    }
    if (query.isEmpty())
        return false;
    r = OCIHandleAlloc(d->env,
                       reinterpret_cast<void **>(&d->sql),
                       OCI_HTYPE_STMT,
                       0,
                       0);
    if (r != OCI_SUCCESS) {
        qOraWarning("QOCIResult::prepare: unable to alloc statement:", d->err);
        setLastError(qMakeError(QCoreApplication::translate("QOCIResult",
                     "Unable to alloc statement"), QSqlError::StatementError, d->err));
        return false;
    }
    d->setStatementAttributes();
    const OraText *txt = reinterpret_cast<const OraText *>(query.utf16());
    const int len = query.length() * sizeof(QChar);
    r = OCIStmtPrepare(d->sql,
                       d->err,
                       txt,
                       len,
                       OCI_NTV_SYNTAX,
                       OCI_DEFAULT);
    if (r != OCI_SUCCESS) {
        qOraWarning("QOCIResult::prepare: unable to prepare statement:", d->err);
        setLastError(qMakeError(QCoreApplication::translate("QOCIResult",
                                "Unable to prepare statement"), QSqlError::StatementError, d->err));
        return false;
    }
    return true;
}

record()

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

{
    QSqlRecord inf;
    if (!isActive() || !isSelect() || !d->cols)
        return inf;
    return d->cols->rec;
}

reset()

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

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

size()

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

{
    return -1;
}

virtual_hook()

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

protectedvirtual

Warning

This function is not part of the public interface.

Reimplemented from QSqlResult.

Definition at line 2054 of file qsql_oci.cpp.

{
    Q_ASSERT(data);

    switch (id) {
    case QSqlResult::BatchOperation:
        QOCICols::execBatch(d, boundValues(), *reinterpret_cast<bool *>(data));
        break;
    default:
        QSqlCachedResult::virtual_hook(id, data);
    }
}

Friends and Related Functions

QOCICols

friend class QOCICols

friend

Definition at line 71 of file qsql_oci.h.

Referenced by exec().

QOCIDriver

friend class QOCIDriver

friend

Definition at line 69 of file qsql_oci.h.

QOCIResultPrivate

friend struct QOCIResultPrivate

friend

Definition at line 70 of file qsql_oci.h.

Referenced by QOCIResult().

Properties

d

QOCIResultPrivate* QOCIResult::d

private

Definition at line 89 of file qsql_oci.h.

Referenced by exec(), gotoNext(), handle(), lastInsertId(), numRowsAffected(), prepare(), QOCIResult(), record(), virtual_hook(), and ~QOCIResult().

---

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

• /src/sql/drivers/oci/qsql_oci.h
• /src/sql/drivers/oci/qsql_oci.cpp