API reference - Class QSqlQuery

Notation used in Ruby API documentation

Description: Binding of QSqlQuery

Sub-classes: BatchExecutionMode

Public constructors

new QSqlQuerynew(QSqlResult ptr r)Constructor QSqlQuery::QSqlQuery(QSqlResult *r)
new QSqlQuerynew(string query = QString(),
QSqlDatabase db = QSqlDatabase())
Constructor QSqlQuery::QSqlQuery(const QString &query, QSqlDatabase db)
new QSqlQuerynew(QSqlDatabase db)Constructor QSqlQuery::QSqlQuery(QSqlDatabase db)
new QSqlQuerynew(const QSqlQuery other)Constructor QSqlQuery::QSqlQuery(const QSqlQuery &other)

Public methods

void_assign(const QSqlQuery other)Assigns another object to self
void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
voidaddBindValue(const QVariant val,
const QSql_QFlags_ParamTypeFlag type = QSql::In)
Method void QSqlQuery::addBindValue(const QVariant &val, QFlags<QSql::ParamTypeFlag> type)
QSqlQueryassign(const QSqlQuery other)Method QSqlQuery &QSqlQuery::operator=(const QSqlQuery &other)
[const]intatMethod int QSqlQuery::at()
voidbindValue(string placeholder,
const QVariant val,
const QSql_QFlags_ParamTypeFlag type = QSql::In)
Method void QSqlQuery::bindValue(const QString &placeholder, const QVariant &val, QFlags<QSql::ParamTypeFlag> type)
voidbindValue(int pos,
const QVariant val,
const QSql_QFlags_ParamTypeFlag type = QSql::In)
Method void QSqlQuery::bindValue(int pos, const QVariant &val, QFlags<QSql::ParamTypeFlag> type)
[const]QVariantboundValue(string placeholder)Method QVariant QSqlQuery::boundValue(const QString &placeholder)
[const]QVariantboundValue(int pos)Method QVariant QSqlQuery::boundValue(int pos)
voidclearMethod void QSqlQuery::clear()
[const]const QSqlDriver ptrdriverMethod const QSqlDriver *QSqlQuery::driver()
[const]new QSqlQuery ptrdupCreates a copy of self
boolexec(string query)Method bool QSqlQuery::exec(const QString &query)
boolexecMethod bool QSqlQuery::exec()
boolexecBatch(const QSqlQuery_BatchExecutionMode mode = QSqlQuery::ValuesAsRows)Method bool QSqlQuery::execBatch(QSqlQuery::BatchExecutionMode mode)
[const]stringexecutedQueryMethod QString QSqlQuery::executedQuery()
voidfinishMethod void QSqlQuery::finish()
boolfirstMethod bool QSqlQuery::first()
[const]boolforwardOnlyMethod bool QSqlQuery::isForwardOnly()
voidforwardOnly=(bool forward)Method void QSqlQuery::setForwardOnly(bool forward)
[const]boolisActive?Method bool QSqlQuery::isActive()
[const]boolisForwardOnly?Method bool QSqlQuery::isForwardOnly()
[const]boolisNull?(int field)Method bool QSqlQuery::isNull(int field)
[const]boolisSelect?Method bool QSqlQuery::isSelect()
[const]boolisValid?Method bool QSqlQuery::isValid()
boollastMethod bool QSqlQuery::last()
[const]QSqlErrorlastErrorMethod QSqlError QSqlQuery::lastError()
[const]QVariantlastInsertIdMethod QVariant QSqlQuery::lastInsertId()
[const]stringlastQueryMethod QString QSqlQuery::lastQuery()
boolnextMethod bool QSqlQuery::next()
boolnextResultMethod bool QSqlQuery::nextResult()
[const]intnumRowsAffectedMethod int QSqlQuery::numRowsAffected()
[const]QSql_NumericalPrecisionPolicynumericalPrecisionPolicyMethod QSql::NumericalPrecisionPolicy QSqlQuery::numericalPrecisionPolicy()
voidnumericalPrecisionPolicy=(const QSql_NumericalPrecisionPolicy precisionPolicy)Method void QSqlQuery::setNumericalPrecisionPolicy(QSql::NumericalPrecisionPolicy precisionPolicy)
boolprepare(string query)Method bool QSqlQuery::prepare(const QString &query)
boolpreviousMethod bool QSqlQuery::previous()
[const]QSqlRecordrecordMethod QSqlRecord QSqlQuery::record()
[const]const QSqlResult ptrresultMethod const QSqlResult *QSqlQuery::result()
boolseek(int i,
bool relative = false)
Method bool QSqlQuery::seek(int i, bool relative)
voidsetForwardOnly(bool forward)Method void QSqlQuery::setForwardOnly(bool forward)
voidsetNumericalPrecisionPolicy(const QSql_NumericalPrecisionPolicy precisionPolicy)Method void QSqlQuery::setNumericalPrecisionPolicy(QSql::NumericalPrecisionPolicy precisionPolicy)
[const]intsizeMethod int QSqlQuery::size()
[const]QVariantvalue(int i)Method QVariant QSqlQuery::value(int i)

Public static methods and constants

[static,const]new QSqlQuery_BatchExecutionMode ptrValuesAsColumnsEnum constant QSqlQuery::ValuesAsColumns
[static,const]new QSqlQuery_BatchExecutionMode ptrValuesAsRowsEnum constant QSqlQuery::ValuesAsRows

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

[static,const] new QSqlQuery_BatchExecutionMode ptr ValuesAsColumns

Description: Enum constant QSqlQuery::ValuesAsColumns

[static,const] new QSqlQuery_BatchExecutionMode ptr ValuesAsRows

Description: Enum constant QSqlQuery::ValuesAsRows

void _assign(const QSqlQuery other)

Description: Assigns another object to self

void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

[const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

[const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

void addBindValue(const QVariant val,const QSql_QFlags_ParamTypeFlag type = QSql::In)

Description: Method void QSqlQuery::addBindValue(const QVariant &val, QFlags<QSql::ParamTypeFlag> type)

QSqlQuery assign(const QSqlQuery other)

Description: Method QSqlQuery &QSqlQuery::operator=(const QSqlQuery &other)

[const] int at

Description: Method int QSqlQuery::at()

void bindValue(string placeholder,const QVariant val,const QSql_QFlags_ParamTypeFlag type = QSql::In)

Description: Method void QSqlQuery::bindValue(const QString &placeholder, const QVariant &val, QFlags<QSql::ParamTypeFlag> type)

void bindValue(int pos,const QVariant val,const QSql_QFlags_ParamTypeFlag type = QSql::In)

Description: Method void QSqlQuery::bindValue(int pos, const QVariant &val, QFlags<QSql::ParamTypeFlag> type)

[const] QVariant boundValue(string placeholder)

Description: Method QVariant QSqlQuery::boundValue(const QString &placeholder)

[const] QVariant boundValue(int pos)

Description: Method QVariant QSqlQuery::boundValue(int pos)

void clear

Description: Method void QSqlQuery::clear()

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

[const] const QSqlDriver ptr driver

Description: Method const QSqlDriver *QSqlQuery::driver()

[const] new QSqlQuery ptr dup

Description: Creates a copy of self

bool exec(string query)

Description: Method bool QSqlQuery::exec(const QString &query)

Python specific notes:

This method is available as method 'exec_' in Python

bool exec

Description: Method bool QSqlQuery::exec()

Python specific notes:

This method is available as method 'exec_' in Python

bool execBatch(const QSqlQuery_BatchExecutionMode mode = QSqlQuery::ValuesAsRows)

Description: Method bool QSqlQuery::execBatch(QSqlQuery::BatchExecutionMode mode)

[const] string executedQuery

Description: Method QString QSqlQuery::executedQuery()

void finish

Description: Method void QSqlQuery::finish()

bool first

Description: Method bool QSqlQuery::first()

[const] bool forwardOnly

Description: Method bool QSqlQuery::isForwardOnly()

Python specific notes:

The object exposes a readable attribute 'forwardOnly'. This is the getter.

void forwardOnly=(bool forward)

Description: Method void QSqlQuery::setForwardOnly(bool forward)

Python specific notes:

The object exposes a writable attribute 'forwardOnly'. This is the setter.

[const] bool isActive?

Description: Method bool QSqlQuery::isActive()

[const] bool isForwardOnly?

Description: Method bool QSqlQuery::isForwardOnly()

Python specific notes:

The object exposes a readable attribute 'forwardOnly'. This is the getter.

[const] bool isNull?(int field)

Description: Method bool QSqlQuery::isNull(int field)

[const] bool isSelect?

Description: Method bool QSqlQuery::isSelect()

[const] bool isValid?

Description: Method bool QSqlQuery::isValid()

[const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

bool last

Description: Method bool QSqlQuery::last()

[const] QSqlError lastError

Description: Method QSqlError QSqlQuery::lastError()

[const] QVariant lastInsertId

Description: Method QVariant QSqlQuery::lastInsertId()

[const] string lastQuery

Description: Method QString QSqlQuery::lastQuery()

[static] new QSqlQuery new(QSqlResult ptr r)

Description: Constructor QSqlQuery::QSqlQuery(QSqlResult *r)

This method creates an object of class QSqlQuery.

Python specific notes:

This method is the default initializer of the object

[static] new QSqlQuery new(string query = QString(),QSqlDatabase db = QSqlDatabase())

Description: Constructor QSqlQuery::QSqlQuery(const QString &query, QSqlDatabase db)

This method creates an object of class QSqlQuery.

Python specific notes:

This method is the default initializer of the object

[static] new QSqlQuery new(QSqlDatabase db)

Description: Constructor QSqlQuery::QSqlQuery(QSqlDatabase db)

This method creates an object of class QSqlQuery.

Python specific notes:

This method is the default initializer of the object

[static] new QSqlQuery new(const QSqlQuery other)

Description: Constructor QSqlQuery::QSqlQuery(const QSqlQuery &other)

This method creates an object of class QSqlQuery.

Python specific notes:

This method is the default initializer of the object

bool next

Description: Method bool QSqlQuery::next()

bool nextResult

Description: Method bool QSqlQuery::nextResult()

[const] int numRowsAffected

Description: Method int QSqlQuery::numRowsAffected()

[const] QSql_NumericalPrecisionPolicy numericalPrecisionPolicy

Description: Method QSql::NumericalPrecisionPolicy QSqlQuery::numericalPrecisionPolicy()

Python specific notes:

The object exposes a readable attribute 'numericalPrecisionPolicy'. This is the getter.

void numericalPrecisionPolicy=(const QSql_NumericalPrecisionPolicy precisionPolicy)

Description: Method void QSqlQuery::setNumericalPrecisionPolicy(QSql::NumericalPrecisionPolicy precisionPolicy)

Python specific notes:

The object exposes a writable attribute 'numericalPrecisionPolicy'. This is the setter.

bool prepare(string query)

Description: Method bool QSqlQuery::prepare(const QString &query)

bool previous

Description: Method bool QSqlQuery::previous()

[const] QSqlRecord record

Description: Method QSqlRecord QSqlQuery::record()

[const] const QSqlResult ptr result

Description: Method const QSqlResult *QSqlQuery::result()

bool seek(int i,bool relative = false)

Description: Method bool QSqlQuery::seek(int i, bool relative)

void setForwardOnly(bool forward)

Description: Method void QSqlQuery::setForwardOnly(bool forward)

Python specific notes:

The object exposes a writable attribute 'forwardOnly'. This is the setter.

void setNumericalPrecisionPolicy(const QSql_NumericalPrecisionPolicy precisionPolicy)

Description: Method void QSqlQuery::setNumericalPrecisionPolicy(QSql::NumericalPrecisionPolicy precisionPolicy)

Python specific notes:

The object exposes a writable attribute 'numericalPrecisionPolicy'. This is the setter.

[const] int size

Description: Method int QSqlQuery::size()

Python specific notes:

This method is also available as 'len(object)'

[const] QVariant value(int i)

Description: Method QVariant QSqlQuery::value(int i)