API reference - Class QSqlDriver

BLOB

Signature: [static,const] QSqlDriver_DriverFeature BLOB

Description: Enum constant QSqlDriver::BLOB

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

BatchOperations

Signature: [static,const] QSqlDriver_DriverFeature BatchOperations

Description: Enum constant QSqlDriver::BatchOperations

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

CancelQuery

Signature: [static,const] QSqlDriver_DriverFeature CancelQuery

Description: Enum constant QSqlDriver::CancelQuery

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

DB2

Signature: [static,const] QSqlDriver_DbmsType DB2

Description: Enum constant QSqlDriver::DB2

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

DeleteStatement

Signature: [static,const] QSqlDriver_StatementType DeleteStatement

Description: Enum constant QSqlDriver::DeleteStatement

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

EventNotifications

Signature: [static,const] QSqlDriver_DriverFeature EventNotifications

Description: Enum constant QSqlDriver::EventNotifications

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

FieldName

Signature: [static,const] QSqlDriver_IdentifierType FieldName

Description: Enum constant QSqlDriver::FieldName

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

FinishQuery

Signature: [static,const] QSqlDriver_DriverFeature FinishQuery

Description: Enum constant QSqlDriver::FinishQuery

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

InsertStatement

Signature: [static,const] QSqlDriver_StatementType InsertStatement

Description: Enum constant QSqlDriver::InsertStatement

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

Interbase

Signature: [static,const] QSqlDriver_DbmsType Interbase

Description: Enum constant QSqlDriver::Interbase

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

LastInsertId

Signature: [static,const] QSqlDriver_DriverFeature LastInsertId

Description: Enum constant QSqlDriver::LastInsertId

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

LowPrecisionNumbers

Signature: [static,const] QSqlDriver_DriverFeature LowPrecisionNumbers

Description: Enum constant QSqlDriver::LowPrecisionNumbers

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

MSSqlServer

Signature: [static,const] QSqlDriver_DbmsType MSSqlServer

Description: Enum constant QSqlDriver::MSSqlServer

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

MultipleResultSets

Signature: [static,const] QSqlDriver_DriverFeature MultipleResultSets

Description: Enum constant QSqlDriver::MultipleResultSets

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

MySqlServer

Signature: [static,const] QSqlDriver_DbmsType MySqlServer

Description: Enum constant QSqlDriver::MySqlServer

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

NamedPlaceholders

Signature: [static,const] QSqlDriver_DriverFeature NamedPlaceholders

Description: Enum constant QSqlDriver::NamedPlaceholders

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

Oracle

Signature: [static,const] QSqlDriver_DbmsType Oracle

Description: Enum constant QSqlDriver::Oracle

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

OtherSource

Signature: [static,const] QSqlDriver_NotificationSource OtherSource

Description: Enum constant QSqlDriver::OtherSource

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

PositionalPlaceholders

Signature: [static,const] QSqlDriver_DriverFeature PositionalPlaceholders

Description: Enum constant QSqlDriver::PositionalPlaceholders

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

PostgreSQL

Signature: [static,const] QSqlDriver_DbmsType PostgreSQL

Description: Enum constant QSqlDriver::PostgreSQL

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

PreparedQueries

Signature: [static,const] QSqlDriver_DriverFeature PreparedQueries

Description: Enum constant QSqlDriver::PreparedQueries

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

QuerySize

Signature: [static,const] QSqlDriver_DriverFeature QuerySize

Description: Enum constant QSqlDriver::QuerySize

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

SQLite

Signature: [static,const] QSqlDriver_DbmsType SQLite

Description: Enum constant QSqlDriver::SQLite

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

SelectStatement

Signature: [static,const] QSqlDriver_StatementType SelectStatement

Description: Enum constant QSqlDriver::SelectStatement

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

SelfSource

Signature: [static,const] QSqlDriver_NotificationSource SelfSource

Description: Enum constant QSqlDriver::SelfSource

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

SimpleLocking

Signature: [static,const] QSqlDriver_DriverFeature SimpleLocking

Description: Enum constant QSqlDriver::SimpleLocking

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

Sybase

Signature: [static,const] QSqlDriver_DbmsType Sybase

Description: Enum constant QSqlDriver::Sybase

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

TableName

Signature: [static,const] QSqlDriver_IdentifierType TableName

Description: Enum constant QSqlDriver::TableName

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

Transactions

Signature: [static,const] QSqlDriver_DriverFeature Transactions

Description: Enum constant QSqlDriver::Transactions

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

Unicode

Signature: [static,const] QSqlDriver_DriverFeature Unicode

Description: Enum constant QSqlDriver::Unicode

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

UnknownDbms

Signature: [static,const] QSqlDriver_DbmsType UnknownDbms

Description: Enum constant QSqlDriver::UnknownDbms

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

UnknownSource

Signature: [static,const] QSqlDriver_NotificationSource UnknownSource

Description: Enum constant QSqlDriver::UnknownSource

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

UpdateStatement

Signature: [static,const] QSqlDriver_StatementType UpdateStatement

Description: Enum constant QSqlDriver::UpdateStatement

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

WhereStatement

Signature: [static,const] QSqlDriver_StatementType WhereStatement

Description: Enum constant QSqlDriver::WhereStatement

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

_const_cast

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

beginTransaction

Signature: bool beginTransaction

Description: Virtual method bool QSqlDriver::beginTransaction()

This method can be reimplemented in a derived class.

cancelQuery

Signature: bool cancelQuery

Description: Virtual method bool QSqlDriver::cancelQuery()

This method can be reimplemented in a derived class.

childEvent

Signature: void childEvent (QChildEvent ptr event)

Description: Virtual method void QSqlDriver::childEvent(QChildEvent *event)

This method can be reimplemented in a derived class.

close

Signature: void close

Description: Virtual method void QSqlDriver::close()

This method can be reimplemented in a derived class.

commitTransaction

Signature: bool commitTransaction

Description: Virtual method bool QSqlDriver::commitTransaction()

This method can be reimplemented in a derived class.

createResult

Signature: [const] QSqlResult ptr createResult

Description: Virtual method QSqlResult *QSqlDriver::createResult()

This method can be reimplemented in a derived class.

customEvent

Signature: void customEvent (QEvent ptr event)

Description: Virtual method void QSqlDriver::customEvent(QEvent *event)

This method can be reimplemented in a derived class.

dbmsType

Signature: [const] QSqlDriver_DbmsType dbmsType

Description: Method QSqlDriver::DbmsType QSqlDriver::dbmsType()

destroyed

Signature: [signal] void destroyed (QObject ptr arg1)

Description: Signal declaration for QSqlDriver::destroyed(QObject *)

You can bind a procedure to this signal.

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

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

Description: Virtual method void QSqlDriver::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

Description: Emitter for signal void QSqlDriver::destroyed(QObject *)

Call this method to emit this signal.

emit_notification

Signature: void emit_notification (string name)

Description: Emitter for signal void QSqlDriver::notification(const QString &name)

Call this method to emit this signal.

emit_notification_withData

Signature: void emit_notification_withData (string name, const QSqlDriver_NotificationSource source, variant payload)

Description: Emitter for signal void QSqlDriver::notification(const QString &name, QSqlDriver::NotificationSource source, const QVariant &payload)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

Description: Emitter for signal void QSqlDriver::objectNameChanged(const QString &objectName)

Call this method to emit this signal.

escapeIdentifier

Signature: [const] string escapeIdentifier (string identifier, const QSqlDriver_IdentifierType type)

Description: Virtual method QString QSqlDriver::escapeIdentifier(const QString &identifier, QSqlDriver::IdentifierType type)

This method can be reimplemented in a derived class.

event

Signature: bool event (QEvent ptr event)

Description: Virtual method bool QSqlDriver::event(QEvent *event)

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr watched, QEvent ptr event)

Description: Virtual method bool QSqlDriver::eventFilter(QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

formatValue

Signature: [const] string formatValue (const QSqlField field, bool trimStrings)

Description: Virtual method QString QSqlDriver::formatValue(const QSqlField &field, bool trimStrings)

This method can be reimplemented in a derived class.

handle

Signature: [const] variant handle

Description: Virtual method QVariant QSqlDriver::handle()

This method can be reimplemented in a derived class.

hasFeature

Signature: [const] bool hasFeature (const QSqlDriver_DriverFeature f)

Description: Virtual method bool QSqlDriver::hasFeature(QSqlDriver::DriverFeature f)

This method can be reimplemented in a derived class.

isIdentifierEscaped

Signature: [const] bool isIdentifierEscaped (string identifier, const QSqlDriver_IdentifierType type)

Description: Virtual method bool QSqlDriver::isIdentifierEscaped(const QString &identifier, QSqlDriver::IdentifierType type)

This method can be reimplemented in a derived class.

isIdentifierEscaped?

Signature: [const] bool isIdentifierEscaped? (string identifier, const QSqlDriver_IdentifierType type)

Description: Method bool QSqlDriver::isIdentifierEscaped(const QString &identifier, QSqlDriver::IdentifierType type)

isOpen

Signature: [const] bool isOpen

Description: Virtual method bool QSqlDriver::isOpen()

This method can be reimplemented in a derived class.

isOpen?

Signature: [const] bool isOpen?

Description: Method bool QSqlDriver::isOpen()

isOpenError?

Signature: [const] bool isOpenError?

Description: Method bool QSqlDriver::isOpenError()

isSignalConnected

Signature: [const] bool isSignalConnected (const QMetaMethod signal)

Description: Method bool QSqlDriver::isSignalConnected(const QMetaMethod &signal)

This method is protected and can only be called from inside a derived class.

lastError

Signature: [const] QSqlError lastError

Description: Method QSqlError QSqlDriver::lastError()

new

Signature: [static] new QSqlDriver new (QObject ptr parent = nullptr)

Description: Constructor QSqlDriver::QSqlDriver(QObject *parent)

This method creates an object of class QSqlDriver.

Python specific notes:
This method is the default initializer of the object.

notification

Signature: [signal] void notification (string name)

Description: Signal declaration for QSqlDriver::notification(const QString &name)

You can bind a procedure to this signal.

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

notification_withData

Signature: [signal] void notification_withData (string name, const QSqlDriver_NotificationSource source, variant payload)

Description: Signal declaration for QSqlDriver::notification(const QString &name, QSqlDriver::NotificationSource source, const QVariant &payload)

You can bind a procedure to this signal.

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

numericalPrecisionPolicy

Signature: [const] QSql_NumericalPrecisionPolicy numericalPrecisionPolicy

Description: Method QSql::NumericalPrecisionPolicy QSqlDriver::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 QSqlDriver::setNumericalPrecisionPolicy(QSql::NumericalPrecisionPolicy precisionPolicy)

Python specific notes:
The object exposes a writable attribute 'numericalPrecisionPolicy'. This is the setter.

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QSqlDriver::objectNameChanged(const QString &objectName)

You can bind a procedure to this signal.

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

open

Signature: bool open (string db, string user, string password, string host, int port, string connOpts)

Description: Virtual method bool QSqlDriver::open(const QString &db, const QString &user, const QString &password, const QString &host, int port, const QString &connOpts)

This method can be reimplemented in a derived class.

primaryIndex

Signature: [const] QSqlIndex primaryIndex (string tableName)

Description: Virtual method QSqlIndex QSqlDriver::primaryIndex(const QString &tableName)

This method can be reimplemented in a derived class.

receivers

Signature: [const] int receivers (string signal)

Description: Method int QSqlDriver::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

record

Signature: [const] QSqlRecord record (string tableName)

Description: Virtual method QSqlRecord QSqlDriver::record(const QString &tableName)

This method can be reimplemented in a derived class.

rollbackTransaction

Signature: bool rollbackTransaction

Description: Virtual method bool QSqlDriver::rollbackTransaction()

This method can be reimplemented in a derived class.

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QSqlDriver::sender()

This method is protected and can only be called from inside a derived class.

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QSqlDriver::senderSignalIndex()

This method is protected and can only be called from inside a derived class.

setLastError

Signature: void setLastError (const QSqlError e)

Description: Virtual method void QSqlDriver::setLastError(const QSqlError &e)

This method can be reimplemented in a derived class.

setNumericalPrecisionPolicy

Signature: void setNumericalPrecisionPolicy (const QSql_NumericalPrecisionPolicy precisionPolicy)

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

Python specific notes:
The object exposes a writable attribute 'numericalPrecisionPolicy'. This is the setter.

setOpen

Signature: void setOpen (bool o)

Description: Virtual method void QSqlDriver::setOpen(bool o)

This method can be reimplemented in a derived class.

setOpenError

Signature: void setOpenError (bool e)

Description: Virtual method void QSqlDriver::setOpenError(bool e)

This method can be reimplemented in a derived class.

sqlStatement

Signature: [const] string sqlStatement (const QSqlDriver_StatementType type, string tableName, const QSqlRecord rec, bool preparedStatement)

Description: Virtual method QString QSqlDriver::sqlStatement(QSqlDriver::StatementType type, const QString &tableName, const QSqlRecord &rec, bool preparedStatement)

This method can be reimplemented in a derived class.

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

stripDelimiters

Signature: [const] string stripDelimiters (string identifier, const QSqlDriver_IdentifierType type)

Description: Virtual method QString QSqlDriver::stripDelimiters(const QString &identifier, QSqlDriver::IdentifierType type)

This method can be reimplemented in a derived class.

subscribeToNotification

Signature: bool subscribeToNotification (string name)

Description: Virtual method bool QSqlDriver::subscribeToNotification(const QString &name)

This method can be reimplemented in a derived class.

subscribedToNotifications

Signature: [const] string[] subscribedToNotifications

Description: Virtual method QStringList QSqlDriver::subscribedToNotifications()

This method can be reimplemented in a derived class.

tables

Signature: [const] string[] tables (const QSql_TableType tableType)

Description: Virtual method QStringList QSqlDriver::tables(QSql::TableType tableType)

This method can be reimplemented in a derived class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QSqlDriver::timerEvent(QTimerEvent *event)

This method can be reimplemented in a derived class.

tr

Signature: [static] string tr (string s, string c = nullptr, int n = -1)

Description: Static method QString QSqlDriver::tr(const char *s, const char *c, int n)

This method is static and can be called without an instance.

trUtf8

Signature: [static] string trUtf8 (string s, string c = nullptr, int n = -1)

Description: Static method QString QSqlDriver::trUtf8(const char *s, const char *c, int n)

This method is static and can be called without an instance.

unsubscribeFromNotification

Signature: bool unsubscribeFromNotification (string name)

Description: Virtual method bool QSqlDriver::unsubscribeFromNotification(const QString &name)

This method can be reimplemented in a derived class.