API reference - Class QSqlQuery

ValuesAsColumns

Signature: [static,const] QSqlQuery_BatchExecutionMode ValuesAsColumns

Description: Enum constant QSqlQuery::ValuesAsColumns

Python specific notes:
The object exposes a readable attribute 'ValuesAsColumns'. This is the getter.

ValuesAsRows

Signature: [static,const] QSqlQuery_BatchExecutionMode ValuesAsRows

Description: Enum constant QSqlQuery::ValuesAsRows

Python specific notes:
The object exposes a readable attribute 'ValuesAsRows'. This is the getter.

_assign

Signature: void _assign (const QSqlQuery other)

Description: Assigns another object to self

_const_cast

Signature: [const] QSqlQuery ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: 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.

_destroy

Signature: 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.

_destroyed?

Signature: [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.

_is_const_object?

Signature: [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.

_manage

Signature: 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.

_unmanage

Signature: 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.

addBindValue

Signature: void addBindValue (variant val, QSql_QFlags_ParamTypeFlag type = QSql::In)

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

assign

Signature: QSqlQuery assign (const QSqlQuery other)

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

at

Signature: [const] int at

Description: Method int QSqlQuery::at()

bindValue

(1) Signature: void bindValue (string placeholder, variant val, QSql_QFlags_ParamTypeFlag type = QSql::In)

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

(2) Signature: void bindValue (int pos, variant val, QSql_QFlags_ParamTypeFlag type = QSql::In)

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

boundValue

(1) Signature: [const] variant boundValue (string placeholder)

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

(2) Signature: [const] variant boundValue (int pos)

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

boundValues

Signature: [const] map<string,variant> boundValues

Description: Method QMap<QString, QVariant> QSqlQuery::boundValues()

clear

Signature: void clear

Description: Method void QSqlQuery::clear()

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

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.

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

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.

destroyed?

Signature: [const] bool destroyed?

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

Use of this method is deprecated. Use _destroyed? instead

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.

driver

Signature: [const] const QSqlDriver ptr driver

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

dup

Signature: [const] new QSqlQuery ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

exec

(1) Signature: bool exec (string query)

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

Python specific notes:
This attribute is available as 'exec_' in Python.

(2) Signature: bool exec

Description: Method bool QSqlQuery::exec()

Python specific notes:
This attribute is available as 'exec_' in Python.

execBatch

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

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

executedQuery

Signature: [const] string executedQuery

Description: Method QString QSqlQuery::executedQuery()

finish

Signature: void finish

Description: Method void QSqlQuery::finish()

first

Signature: bool first

Description: Method bool QSqlQuery::first()

forwardOnly

Signature: [const] bool forwardOnly

Description: Method bool QSqlQuery::isForwardOnly()

Python specific notes:
The object exposes a readable attribute 'forwardOnly'. This is the getter.

forwardOnly=

Signature: 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.

isActive?

Signature: [const] bool isActive?

Description: Method bool QSqlQuery::isActive()

isForwardOnly?

Signature: [const] bool isForwardOnly?

Description: Method bool QSqlQuery::isForwardOnly()

Python specific notes:
The object exposes a readable attribute 'forwardOnly'. This is the getter.

isNull?

(1) Signature: [const] bool isNull? (int field)

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

(2) Signature: [const] bool isNull? (string name)

Description: Method bool QSqlQuery::isNull(const QString &name)

isSelect?

Signature: [const] bool isSelect?

Description: Method bool QSqlQuery::isSelect()

isValid?

Signature: [const] bool isValid?

Description: Method bool QSqlQuery::isValid()

is_const_object?

Signature: [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

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

last

Signature: bool last

Description: Method bool QSqlQuery::last()

lastError

Signature: [const] QSqlError lastError

Description: Method QSqlError QSqlQuery::lastError()

lastInsertId

Signature: [const] variant lastInsertId

Description: Method QVariant QSqlQuery::lastInsertId()

lastQuery

Signature: [const] string lastQuery

Description: Method QString QSqlQuery::lastQuery()

new

(1) Signature: [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.

(2) Signature: [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.

(3) Signature: [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.

(4) Signature: [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.

next

Signature: bool next

Description: Method bool QSqlQuery::next()

nextResult

Signature: bool nextResult

Description: Method bool QSqlQuery::nextResult()

numRowsAffected

Signature: [const] int numRowsAffected

Description: Method int QSqlQuery::numRowsAffected()

numericalPrecisionPolicy

Signature: [const] QSql_NumericalPrecisionPolicy numericalPrecisionPolicy

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

Python specific notes:
The object exposes a readable attribute 'numericalPrecisionPolicy'. This is the getter.

numericalPrecisionPolicy=

Signature: 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.

prepare

Signature: bool prepare (string query)

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

previous

Signature: bool previous

Description: Method bool QSqlQuery::previous()

record

Signature: [const] QSqlRecord record

Description: Method QSqlRecord QSqlQuery::record()

result

Signature: [const] const QSqlResult ptr result

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

seek

Signature: bool seek (int i, bool relative = false)

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

setForwardOnly

Signature: 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.

setNumericalPrecisionPolicy

Signature: 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.

size

Signature: [const] int size

Description: Method int QSqlQuery::size()

Python specific notes:
This method is also available as 'len(object)'.

value

(1) Signature: [const] variant value (int i)

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

(2) Signature: [const] variant value (string name)

Description: Method QVariant QSqlQuery::value(const QString &name)