QSymSQLResult Class Reference

#include <qsql_symsql.h>

Inheritance diagram for QSymSQLResult:

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...
	QSymSQLResult (const QSymSQLDriver *db)
	~QSymSQLResult ()
Public Functions inherited from QSqlResult
virtual	~QSqlResult ()
	Destroys the object and frees any allocated resources. More...

Protected Functions
QVariant	data (int field)
	Returns the data for field index in the current row as a QVariant. More...
bool	exec ()
	Executes the query, returning true if successful; otherwise returns false. 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...
bool	isNull (int i)
	Returns true if the field at position index in the current row is null; otherwise returns false. More...
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 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
QSymSQLResultPrivate *	d

Friends
class	QSymSQLDriver
class	QSymSQLResultPrivate

Additional Inherited Members
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 65 of file qsql_symsql.h.

Constructors and Destructors

QSymSQLResult()

QSymSQLResult::QSymSQLResult ( const QSymSQLDriver *  db )

explicit

Definition at line 297 of file qsql_symsql.cpp.

    : QSqlResult(db)
{
    d = new QSymSQLResultPrivate(this);
    d->access = db->d->access;
}

~QSymSQLResult()

QSymSQLResult::~QSymSQLResult

(

)

Definition at line 305 of file qsql_symsql.cpp.

{
    d->cleanup();
    delete d;
}

Functions

data()

QVariant QSymSQLResult::data ( int  index )

protectedvirtual

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.

Implements QSqlResult.

Definition at line 500 of file qsql_symsql.cpp.

Referenced by exec().

{
    QVariant r;
    
    switch (d->stmt.ColumnType(idx)) {
    case ESqlBinary:
        {
            TPtrC8 data; 
            d->stmt.ColumnBinary(idx, data);
            return QByteArray(reinterpret_cast<const char *>(data.Ptr()), data.Length());
            break;
         }
    case ESqlInt:
        r = QVariant(d->stmt.ColumnInt(idx));
        break;
    case ESqlInt64:
        r = QVariant(d->stmt.ColumnInt64(idx));
        break;
    case ESqlReal:
        switch(numericalPrecisionPolicy()) {
        case QSql::LowPrecisionInt32:
            r = QVariant(d->stmt.ColumnInt(idx));
            break;
        case QSql::LowPrecisionInt64:
            r = QVariant(d->stmt.ColumnInt64(idx));
            break;
        case QSql::LowPrecisionDouble:
            r = QVariant(d->stmt.ColumnReal(idx));
            break;
        case QSql::HighPrecision:
        default:
            TPtrC res;
            d->stmt.ColumnText(idx, res);
            r = QVariant(qt_TDesC2QString(res));
            break;
        };
        break;
    case ESqlNull:
        r  = QVariant(QVariant::String);
        break;
    default:
        TPtrC res;
        d->stmt.ColumnText(idx, res);
        r = QVariant(qt_TDesC2QString(res));
        break;
    }

    return r;
}    

exec()

bool QSymSQLResult::exec ( )

protectedvirtual

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

See also

prepare()

Reimplemented from QSqlResult.

Definition at line 341 of file qsql_symsql.cpp.

Referenced by reset().

{
    if (d->prepareCalled == false) {
        setLastError(qMakeError(d->access, QCoreApplication::translate("QSymSQLResult",
                        "Statement is not prepared"), QSqlError::StatementError, KErrGeneral));
        return false;
    }
    
    const QVector<QVariant> values = boundValues();
    
    d->skippedStatus = false;
    d->skipRow = false;
    setAt(QSql::BeforeFirstRow);
    setLastError(QSqlError());
    int res = d->stmt.Reset();
    
    if (res != KErrNone) {
        setLastError(qMakeError(d->access, QCoreApplication::translate("QSymSQLResult",
                     "Unable to reset statement"), QSqlError::StatementError, res));
        d->finalize();
        return false;
    }
    TPtrC tmp;
    TInt paramCount = 0;
    while (d->stmt.ParamName(paramCount, tmp) == KErrNone) 
        paramCount++;

    if (paramCount == values.count()) {
        for (int i = 0; i < paramCount; ++i) {
            res = KErrNone;
            const QVariant value = values.at(i);

            if (value.isNull()) {
                res = d->stmt.BindNull(i); //replaced i + 1 with i
            } else {
                switch (value.type()) {
                case QVariant::ByteArray: {
                    const QByteArray *ba = static_cast<const QByteArray*>(value.constData());
                    TPtrC8 data(reinterpret_cast<const TUint8 *>(ba->constData()), ba->length());
                    res = d->stmt.BindBinary(i, data); //replaced i + 1 with i
                    break; }
                case QVariant::Int:
                    res = d->stmt.BindInt(i, value.toInt()); //replaced i + 1 with i
                    break;
                case QVariant::Double:
                    res = d->stmt.BindReal(i, value.toDouble()); //replaced i + 1 with i

                    break;
                case QVariant::UInt:
                case QVariant::LongLong:
                    res = d->stmt.BindReal(i, value.toLongLong()); //replaced i + 1 with i
                    break;
                
                case QVariant::String: {
                    // lifetime of string == lifetime of its qvariant
                    const QString *str = static_cast<const QString*>(value.constData());
                    res = d->stmt.BindText(i, qt_QString2TPtrC(*str)); // replaced i + 1 with i
                    break; }
                default: {
                    QString str = value.toString();
                    res = d->stmt.BindText(i, qt_QString2TPtrC(str)); //replaced i + 1 with i
                    break; }
                }
            }
            if (res != KErrNone) {
                setLastError(qMakeError(d->access, QCoreApplication::translate("QSymSQLResult",
                             "Unable to bind parameters"), QSqlError::StatementError, res));
                d->finalize();
                return false;
            }
        }
    } else {
        setLastError(QSqlError(QCoreApplication::translate("QSymSQLResult",
                        "Parameter count mismatch"), QString(), QSqlError::StatementError));
        return false;
    }
    
    d->skippedStatus = d->fetchNext(true);
    
    if (lastError().isValid()) {
        setSelect(false);
        setActive(false);
        return false;
    }
    
    if (d->stmt.ColumnCount() > 0) {
        //If there is something, it has to be select
        setSelect(true);
    } else {
        //If there isn't it might be just bad query, let's check manually whether we can find SELECT
       QString query = this->lastQuery();
       query = query.trimmed();
       query = query.toLower();
        
       //Just check whether there is one in the beginning, don't know if this is enough
       //Comments should be at the end of line if those are passed
       //For some reason, case insensitive indexOf didn't work for me
       if (query.indexOf(QLatin1String("select")) == 0) {
           setSelect(true);
       } else {
           setSelect(false);
       }
    }

    setActive(true);
    return true;
}

fetch()

bool QSymSQLResult::fetch ( int  index )

protectedvirtual

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

Implements QSqlResult.

Definition at line 555 of file qsql_symsql.cpp.

Referenced by fetchFirst().

{
    //Single return point modified according to review
    bool retVal = true;
    
    if (i < 0 || !isActive()) {
        retVal = false;
    } else {
        if (at() <= -1 || i < at()) {
            d->stmt.Reset();
            setAt(-1);
            d->skipRow = false;
        }
    
        while (at() < i) {
            if (!d->fetchNext(false)) {
                retVal = false;
                break;
            }
        
            setAt(at() + 1);
        }
    }
    
    return retVal;
}

fetchFirst()

bool QSymSQLResult::fetchFirst ( )

protectedvirtual

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

Implements QSqlResult.

Definition at line 597 of file qsql_symsql.cpp.

Referenced by fetchLast().

{
    return fetch(0);
}

fetchLast()

bool QSymSQLResult::fetchLast ( )

protectedvirtual

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

Implements QSqlResult.

Definition at line 602 of file qsql_symsql.cpp.

{
    if (!isActive())
        return false;

    if (at() <= -1) {
        if (!fetchFirst())
            return false;
    }
    
    TInt res;
    
    do {
        res = d->stmt.Next();
        setAt(at()+1);
    } while (res == KSqlAtRow);
        
    if (res != KSqlAtEnd)
        return false;
    
    d->skippedStatus = false;
    d->skipRow = false;
    
    return fetchPrevious();
}

fetchNext()

bool QSymSQLResult::fetchNext ( )

protectedvirtual

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 582 of file qsql_symsql.cpp.

{   
    bool res = d->fetchNext(false);
    if (res) {
        setAt(at()+1);
    }
    
    return res;
}

fetchPrevious()

bool QSymSQLResult::fetchPrevious ( )

protectedvirtual

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.

Reimplemented from QSqlResult.

Definition at line 592 of file qsql_symsql.cpp.

Referenced by fetchLast().

{
    return QSqlResult::fetchPrevious();
}

handle()

QVariant QSymSQLResult::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 482 of file qsql_symsql.cpp.

{
    return qVariantFromValue(d->stmt);
}

isNull()

bool QSymSQLResult::isNull ( int  i )

protectedvirtual

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

Implements QSqlResult.

Definition at line 550 of file qsql_symsql.cpp.

{
    return d->stmt.IsNull(i);
}

lastInsertId()

QVariant QSymSQLResult::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 460 of file qsql_symsql.cpp.

{
    if (isActive()) {
        qint64 id = static_cast<qint64>(d->access.LastInsertedRowId());
        if (id)
            return id;
    }

    return QVariant();
}

numRowsAffected()

int QSymSQLResult::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 455 of file qsql_symsql.cpp.

{   
    return -1;
}

prepare()

bool QSymSQLResult::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 319 of file qsql_symsql.cpp.

Referenced by reset().

{
    if (!driver() || !driver()->isOpen() || driver()->isOpenError())
        return false;

    d->cleanup();
    setSelect(false);

    TInt res = d->stmt.Prepare(d->access, qt_QString2TPtrC(query));
    
    if (res != KErrNone) {
        setLastError(qMakeError(d->access, QCoreApplication::translate("QSymSQLResult",
                     "Unable to execute statement"), QSqlError::StatementError, res));
        d->finalize();
        return false;
    }
    
    d->prepareCalled = true;
    
    return true;
}

record()

QSqlRecord QSymSQLResult::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 471 of file qsql_symsql.cpp.

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

reset()

bool QSymSQLResult::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 311 of file qsql_symsql.cpp.

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

size()

int QSymSQLResult::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 450 of file qsql_symsql.cpp.

{
    return -1;
}

virtual_hook()

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

protectedvirtual

Warning

This function is not part of the public interface.

Reimplemented from QSqlResult.

Definition at line 488 of file qsql_symsql.cpp.

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

Friends and Related Functions

QSymSQLDriver

friend class QSymSQLDriver

friend

Definition at line 67 of file qsql_symsql.h.

QSymSQLResultPrivate

friend class QSymSQLResultPrivate

friend

Definition at line 68 of file qsql_symsql.h.

Referenced by QSymSQLResult().

Properties

d

QSymSQLResultPrivate* QSymSQLResult::d

private

Definition at line 94 of file qsql_symsql.h.

Referenced by data(), exec(), fetch(), fetchLast(), fetchNext(), handle(), isNull(), lastInsertId(), prepare(), QSymSQLResult(), record(), virtual_hook(), and ~QSymSQLResult().

---

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

• /src/sql/drivers/symsql/qsql_symsql.h
• /src/sql/drivers/symsql/qsql_symsql.cpp