QTDSResult Class Reference

#include <qsql_tds.h>

Inheritance diagram for QTDSResult:

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...
	QTDSResult (const QTDSDriver *db)
	~QTDSResult ()
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
void	cleanup ()
bool	gotoNext (QSqlCachedResult::ValueCache &values, int index)
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...
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...
virtual bool	exec ()
	Executes the query, returning true if successful; otherwise returns false. 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...
virtual QVariant	lastInsertId () const
	Returns the object ID of the most recent inserted row if the database supports it. 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
virtual 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...
	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
QTDSResultPrivate *	d

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 78 of file qsql_tds.h.

Constructors and Destructors

QTDSResult()

QTDSResult::QTDSResult ( const QTDSDriver *  db )

explicit

Definition at line 294 of file qsql_tds.cpp.

    : QSqlCachedResult(db)
{
    d = new QTDSResultPrivate();
    d->login = db->d->login;

    d->dbproc = dbopen(d->login, const_cast<char*>(db->d->hostName.toLatin1().constData()));
    if (!d->dbproc)
        return;
    if (dbuse(d->dbproc, const_cast<char*>(db->d->db.toLatin1().constData())) == FAIL)
        return;

    // insert d in error handler dict
    errs()->insert(d->dbproc, d);
    dbcmd(d->dbproc, "set quoted_identifier on");
    dbsqlexec(d->dbproc);
}

~QTDSResult()

QTDSResult::~QTDSResult

(

)

Definition at line 312 of file qsql_tds.cpp.

{
    cleanup();
    if (d->dbproc)
        dbclose(d->dbproc);
    errs()->remove(d->dbproc);
    delete d;
}

Functions

cleanup()

void QTDSResult::cleanup ( )

protected

Definition at line 321 of file qsql_tds.cpp.

Referenced by reset(), and ~QTDSResult().

{
    d->clearErrorMsgs();
    d->rec.clear();
    for (int i = 0; i < d->buffer.size() / 2; ++i)
        free(d->buffer.at(i * 2));
    d->buffer.clear();
    // "can" stands for "cancel"... very clever.
    dbcanquery(d->dbproc);
    dbfreebuf(d->dbproc);

    QSqlCachedResult::cleanup();
}

gotoNext()

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

protectedvirtual

Implements QSqlCachedResult.

Definition at line 345 of file qsql_tds.cpp.

{
    STATUS stat = dbnextrow(d->dbproc);
    if (stat == NO_MORE_ROWS) {
        setAt(QSql::AfterLastRow);
        return false;
    }
    if ((stat == FAIL) || (stat == BUF_FULL)) {
        setLastError(d->lastError);
        return false;
    }

    if (index < 0)
        return true;

    for (int i = 0; i < d->rec.count(); ++i) {
        int idx = index + i;
        switch (d->rec.field(i).type()) {
            case QVariant::DateTime:
                if (qIsNull(d->buffer.at(i * 2 + 1))) {
                    values[idx] = QVariant(QVariant::DateTime);
                } else {
                    DBDATETIME *bdt = (DBDATETIME*) d->buffer.at(i * 2);
                    QDate date = QDate::fromString(QLatin1String("1900-01-01"), Qt::ISODate);
                    QTime time = QTime::fromString(QLatin1String("00:00:00"), Qt::ISODate);
                    values[idx] = QDateTime(date.addDays(bdt->dtdays), time.addMSecs(int(bdt->dttime / 0.3)));
                }
                break;
            case QVariant::Int:
                if (qIsNull(d->buffer.at(i * 2 + 1)))
                    values[idx] = QVariant(QVariant::Int);
                else
                    values[idx] = *((int*)d->buffer.at(i * 2));
                break;
            case QVariant::Double:
            case QVariant::String:
                if (qIsNull(d->buffer.at(i * 2 + 1)))
                    values[idx] = QVariant(QVariant::String);
                else
                    values[idx] = QString::fromLocal8Bit((const char*)d->buffer.at(i * 2)).trimmed();
                break;
            case QVariant::ByteArray: {
                if (qIsNull(d->buffer.at(i * 2 + 1)))
                    values[idx] = QVariant(QVariant::ByteArray);
                else
                    values[idx] = QByteArray((const char*)d->buffer.at(i * 2));
                break;
            }
            default:
                // should never happen, and we already fired
                // a warning while binding.
                values[idx] = QVariant();
                break;
        }
    }

    return true;
}

handle()

QVariant QTDSResult::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 335 of file qsql_tds.cpp.

{
    return QVariant(qRegisterMetaType<DBPROCESS *>("DBPROCESS*"), &d->dbproc);
}

numRowsAffected()

int QTDSResult::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 492 of file qsql_tds.cpp.

{
#ifdef DBNTWIN32
    if (dbiscount(d->dbproc)) {
        return DBCOUNT(d->dbproc);
    }
    return -1;
#else
    return DBCOUNT(d->dbproc);
#endif
}

record()

QSqlRecord QTDSResult::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 504 of file qsql_tds.cpp.

{
    return d->rec;
}

reset()

bool QTDSResult::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 404 of file qsql_tds.cpp.

{
    cleanup();
    if (!driver() || !driver()-> isOpen() || driver()->isOpenError())
        return false;
    setActive(false);
    setAt(QSql::BeforeFirstRow);
    if (dbcmd(d->dbproc, const_cast<char*>(query.toLocal8Bit().constData())) == FAIL) {
        setLastError(d->lastError);
        return false;
    }

    if (dbsqlexec(d->dbproc) == FAIL) {
        setLastError(d->lastError);
        dbfreebuf(d->dbproc);
        return false;
    }
    if (dbresults(d->dbproc) != SUCCEED) {
        setLastError(d->lastError);
        dbfreebuf(d->dbproc);
        return false;
    }

    setSelect((DBCMDROW(d->dbproc) == SUCCEED)); // decide whether or not we are dealing with a SELECT query
    int numCols = dbnumcols(d->dbproc);
    if (numCols > 0) {
        d->buffer.resize(numCols * 2);
        init(numCols);
    }
    for (int i = 0; i < numCols; ++i) {
        int dbType = dbcoltype(d->dbproc, i+1);
        QVariant::Type vType = qDecodeTDSType(dbType);
        QSqlField f(QString::fromAscii(dbcolname(d->dbproc, i+1)), vType);
        f.setSqlType(dbType);
        f.setLength(dbcollen(d->dbproc, i+1));
        d->rec.append(f);

        RETCODE ret = -1;
        void* p = 0;
        switch (vType) {
        case QVariant::Int:
            p = malloc(4);
            ret = dbbind(d->dbproc, i+1, INTBIND, (DBINT) 4, (unsigned char *)p);
            break;
        case QVariant::Double:
            // use string binding to prevent loss of precision
            p = malloc(50);
            ret = dbbind(d->dbproc, i+1, STRINGBIND, 50, (unsigned char *)p);
            break;
        case QVariant::String:
            p = malloc(dbcollen(d->dbproc, i+1) + 1);
            ret = dbbind(d->dbproc, i+1, STRINGBIND, DBINT(dbcollen(d->dbproc, i+1) + 1), (unsigned char *)p);
            break;
        case QVariant::DateTime:
            p = malloc(8);
            ret = dbbind(d->dbproc, i+1, DATETIMEBIND, (DBINT) 8, (unsigned char *)p);
            break;
        case QVariant::ByteArray:
            p = malloc(dbcollen(d->dbproc, i+1) + 1);
            ret = dbbind(d->dbproc, i+1, BINARYBIND, DBINT(dbcollen(d->dbproc, i+1) + 1), (unsigned char *)p);
            break;
        default: //don't bind the field since we do not support it
            qWarning("QTDSResult::reset: Unsupported type for field \"%s\"", dbcolname(d->dbproc, i+1));
            break;
        }
        if (ret == SUCCEED) {
            d->buffer[i * 2] = p;
            ret = dbnullbind(d->dbproc, i+1, (DBINT*)(&d->buffer[i * 2 + 1]));
        } else {
            d->buffer[i * 2] = 0;
            d->buffer[i * 2 + 1] = 0;
            free(p);
        }
        if ((ret != SUCCEED) && (ret != -1)) {
            setLastError(d->lastError);
            return false;
        }
    }

    setActive(true);
    return true;
}

size()

int QTDSResult::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 487 of file qsql_tds.cpp.

{
    return -1;
}

Properties

d

QTDSResultPrivate* QTDSResult::d

private

Definition at line 94 of file qsql_tds.h.

Referenced by cleanup(), gotoNext(), handle(), numRowsAffected(), QTDSResult(), record(), reset(), and ~QTDSResult().

---

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

• /src/sql/drivers/tds/qsql_tds.h
• /src/sql/drivers/tds/qsql_tds.cpp