API reference - Class QSqlDriver

Notation used in Ruby API documentation

Description: Binding of QSqlDriver

Class hierarchy: QSqlDriver » QObject

Sub-classes: DriverFeature, IdentifierType, StatementType

Public constructors

new QSqlDrivernew(QObject ptr parent = 0)Constructor QSqlDriver::QSqlDriver(QObject *parent)

Public methods

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.
[virtual]boolbeginTransactionVirtual method bool QSqlDriver::beginTransaction()
[virtual]voidcloseVirtual method void QSqlDriver::close()
[virtual]boolcommitTransactionVirtual method bool QSqlDriver::commitTransaction()
[virtual,const]QSqlResult ptrcreateResultVirtual method QSqlResult *QSqlDriver::createResult()
[event]voiddestroyed(QObject ptr arg1)Signal declaration for QSqlDriver::destroyed(QObject *)
[virtual,const]stringescapeIdentifier(string identifier,
const QSqlDriver_IdentifierType type)
Virtual method QString QSqlDriver::escapeIdentifier(const QString &identifier, QSqlDriver::IdentifierType type)
[virtual]boolevent(QEvent ptr arg1)Virtual method bool QSqlDriver::event(QEvent *)
[virtual]booleventFilter(QObject ptr arg1,
QEvent ptr arg2)
Virtual method bool QSqlDriver::eventFilter(QObject *, QEvent *)
[virtual,const]stringformatValue(const QSqlField field,
bool trimStrings)
Virtual method QString QSqlDriver::formatValue(const QSqlField &field, bool trimStrings)
[virtual,const]QVarianthandleVirtual method QVariant QSqlDriver::handle()
[virtual,const]boolhasFeature(const QSqlDriver_DriverFeature f)Virtual method bool QSqlDriver::hasFeature(QSqlDriver::DriverFeature f)
[const]boolisIdentifierEscaped?(string identifier,
const QSqlDriver_IdentifierType type)
Method bool QSqlDriver::isIdentifierEscaped(const QString &identifier, QSqlDriver::IdentifierType type)
[virtual,const]boolisOpenVirtual method bool QSqlDriver::isOpen()
[const]boolisOpen?Method bool QSqlDriver::isOpen()
[const]boolisOpenError?Method bool QSqlDriver::isOpenError()
[const]QSqlErrorlastErrorMethod QSqlError QSqlDriver::lastError()
[event]voidnotification(string name)Signal declaration for QSqlDriver::notification(const QString &name)
[const]QSql_NumericalPrecisionPolicynumericalPrecisionPolicyMethod QSql::NumericalPrecisionPolicy QSqlDriver::numericalPrecisionPolicy()
voidnumericalPrecisionPolicy=(const QSql_NumericalPrecisionPolicy precisionPolicy)Method void QSqlDriver::setNumericalPrecisionPolicy(QSql::NumericalPrecisionPolicy precisionPolicy)
[virtual]boolopen(string db,
string user,
string password,
string host,
int port,
string connOpts)
Virtual method bool QSqlDriver::open(const QString &db, const QString &user, const QString &password, const QString &host, int port, const QString &connOpts)
[virtual,const]QSqlIndexprimaryIndex(string tableName)Virtual method QSqlIndex QSqlDriver::primaryIndex(const QString &tableName)
[virtual,const]QSqlRecordrecord(string tableName)Virtual method QSqlRecord QSqlDriver::record(const QString &tableName)
[virtual]boolrollbackTransactionVirtual method bool QSqlDriver::rollbackTransaction()
voidsetNumericalPrecisionPolicy(const QSql_NumericalPrecisionPolicy precisionPolicy)Method void QSqlDriver::setNumericalPrecisionPolicy(QSql::NumericalPrecisionPolicy precisionPolicy)
[virtual,const]stringsqlStatement(const QSqlDriver_StatementType type,
string tableName,
const QSqlRecord rec,
bool preparedStatement)
Virtual method QString QSqlDriver::sqlStatement(QSqlDriver::StatementType type, const QString &tableName, const QSqlRecord &rec, bool preparedStatement)
[const]stringstripDelimiters(string identifier,
const QSqlDriver_IdentifierType type)
Method QString QSqlDriver::stripDelimiters(const QString &identifier, QSqlDriver::IdentifierType type)
boolsubscribeToNotification(string name)Method bool QSqlDriver::subscribeToNotification(const QString &name)
[const]string[]subscribedToNotificationsMethod QStringList QSqlDriver::subscribedToNotifications()
[virtual,const]string[]tables(const QSql_TableType tableType)Virtual method QStringList QSqlDriver::tables(QSql::TableType tableType)
boolunsubscribeFromNotification(string name)Method bool QSqlDriver::unsubscribeFromNotification(const QString &name)

Public static methods and constants

[static,const]new QSqlDriver_DriverFeature ptrBLOBEnum constant QSqlDriver::BLOB
[static,const]new QSqlDriver_DriverFeature ptrBatchOperationsEnum constant QSqlDriver::BatchOperations
[static,const]new QSqlDriver_StatementType ptrDeleteStatementEnum constant QSqlDriver::DeleteStatement
[static,const]new QSqlDriver_DriverFeature ptrEventNotificationsEnum constant QSqlDriver::EventNotifications
[static,const]new QSqlDriver_IdentifierType ptrFieldNameEnum constant QSqlDriver::FieldName
[static,const]new QSqlDriver_DriverFeature ptrFinishQueryEnum constant QSqlDriver::FinishQuery
[static,const]new QSqlDriver_StatementType ptrInsertStatementEnum constant QSqlDriver::InsertStatement
[static,const]new QSqlDriver_DriverFeature ptrLastInsertIdEnum constant QSqlDriver::LastInsertId
[static,const]new QSqlDriver_DriverFeature ptrLowPrecisionNumbersEnum constant QSqlDriver::LowPrecisionNumbers
[static,const]new QSqlDriver_DriverFeature ptrMultipleResultSetsEnum constant QSqlDriver::MultipleResultSets
[static,const]new QSqlDriver_DriverFeature ptrNamedPlaceholdersEnum constant QSqlDriver::NamedPlaceholders
[static,const]new QSqlDriver_DriverFeature ptrPositionalPlaceholdersEnum constant QSqlDriver::PositionalPlaceholders
[static,const]new QSqlDriver_DriverFeature ptrPreparedQueriesEnum constant QSqlDriver::PreparedQueries
[static,const]new QSqlDriver_DriverFeature ptrQuerySizeEnum constant QSqlDriver::QuerySize
[static,const]new QSqlDriver_StatementType ptrSelectStatementEnum constant QSqlDriver::SelectStatement
[static,const]new QSqlDriver_DriverFeature ptrSimpleLockingEnum constant QSqlDriver::SimpleLocking
[static,const]new QSqlDriver_IdentifierType ptrTableNameEnum constant QSqlDriver::TableName
[static,const]new QSqlDriver_DriverFeature ptrTransactionsEnum constant QSqlDriver::Transactions
[static,const]new QSqlDriver_DriverFeature ptrUnicodeEnum constant QSqlDriver::Unicode
[static,const]new QSqlDriver_StatementType ptrUpdateStatementEnum constant QSqlDriver::UpdateStatement
[static,const]new QSqlDriver_StatementType ptrWhereStatementEnum constant QSqlDriver::WhereStatement
QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = 0)
Static method QString QSqlDriver::tr(const char *s, const char *c)
stringtr(string s,
string c,
int n)
Static method QString QSqlDriver::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = 0)
Static method QString QSqlDriver::trUtf8(const char *s, const char *c)
stringtrUtf8(string s,
string c,
int n)
Static method QString QSqlDriver::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

[virtual]voidchildEvent(QChildEvent ptr arg1)Virtual method void QSqlDriver::childEvent(QChildEvent *)
[virtual]voidcustomEvent(QEvent ptr arg1)Virtual method void QSqlDriver::customEvent(QEvent *)
[virtual]voiddisconnectNotify(string signal)Virtual method void QSqlDriver::disconnectNotify(const char *signal)
[const]boolisIdentifierEscapedImplementation(string identifier,
const QSqlDriver_IdentifierType type)
Method bool QSqlDriver::isIdentifierEscapedImplementation(const QString &identifier, QSqlDriver::IdentifierType type)
[const]intreceivers(string signal)Method int QSqlDriver::receivers(const char *signal)
[const]QObject ptrsenderMethod QObject *QSqlDriver::sender()
[virtual]voidsetLastError(const QSqlError e)Virtual method void QSqlDriver::setLastError(const QSqlError &e)
[virtual]voidsetOpen(bool o)Virtual method void QSqlDriver::setOpen(bool o)
[virtual]voidsetOpenError(bool e)Virtual method void QSqlDriver::setOpenError(bool e)
[const]stringstripDelimitersImplementation(string identifier,
const QSqlDriver_IdentifierType type)
Method QString QSqlDriver::stripDelimitersImplementation(const QString &identifier, QSqlDriver::IdentifierType type)
boolsubscribeToNotificationImplementation(string name)Method bool QSqlDriver::subscribeToNotificationImplementation(const QString &name)
[const]string[]subscribedToNotificationsImplementationMethod QStringList QSqlDriver::subscribedToNotificationsImplementation()
[virtual]voidtimerEvent(QTimerEvent ptr arg1)Virtual method void QSqlDriver::timerEvent(QTimerEvent *)
boolunsubscribeFromNotificationImplementation(string name)Method bool QSqlDriver::unsubscribeFromNotificationImplementation(const QString &name)

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 QSqlDriver_DriverFeature ptr BLOB

Description: Enum constant QSqlDriver::BLOB

[static,const] new QSqlDriver_DriverFeature ptr BatchOperations

Description: Enum constant QSqlDriver::BatchOperations

[static,const] new QSqlDriver_StatementType ptr DeleteStatement

Description: Enum constant QSqlDriver::DeleteStatement

[static,const] new QSqlDriver_DriverFeature ptr EventNotifications

Description: Enum constant QSqlDriver::EventNotifications

[static,const] new QSqlDriver_IdentifierType ptr FieldName

Description: Enum constant QSqlDriver::FieldName

[static,const] new QSqlDriver_DriverFeature ptr FinishQuery

Description: Enum constant QSqlDriver::FinishQuery

[static,const] new QSqlDriver_StatementType ptr InsertStatement

Description: Enum constant QSqlDriver::InsertStatement

[static,const] new QSqlDriver_DriverFeature ptr LastInsertId

Description: Enum constant QSqlDriver::LastInsertId

[static,const] new QSqlDriver_DriverFeature ptr LowPrecisionNumbers

Description: Enum constant QSqlDriver::LowPrecisionNumbers

[static,const] new QSqlDriver_DriverFeature ptr MultipleResultSets

Description: Enum constant QSqlDriver::MultipleResultSets

[static,const] new QSqlDriver_DriverFeature ptr NamedPlaceholders

Description: Enum constant QSqlDriver::NamedPlaceholders

[static,const] new QSqlDriver_DriverFeature ptr PositionalPlaceholders

Description: Enum constant QSqlDriver::PositionalPlaceholders

[static,const] new QSqlDriver_DriverFeature ptr PreparedQueries

Description: Enum constant QSqlDriver::PreparedQueries

[static,const] new QSqlDriver_DriverFeature ptr QuerySize

Description: Enum constant QSqlDriver::QuerySize

[static,const] new QSqlDriver_StatementType ptr SelectStatement

Description: Enum constant QSqlDriver::SelectStatement

[static,const] new QSqlDriver_DriverFeature ptr SimpleLocking

Description: Enum constant QSqlDriver::SimpleLocking

[static,const] new QSqlDriver_IdentifierType ptr TableName

Description: Enum constant QSqlDriver::TableName

[static,const] new QSqlDriver_DriverFeature ptr Transactions

Description: Enum constant QSqlDriver::Transactions

[static,const] new QSqlDriver_DriverFeature ptr Unicode

Description: Enum constant QSqlDriver::Unicode

[static,const] new QSqlDriver_StatementType ptr UpdateStatement

Description: Enum constant QSqlDriver::UpdateStatement

[static,const] new QSqlDriver_StatementType ptr WhereStatement

Description: Enum constant QSqlDriver::WhereStatement

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.

[virtual] bool beginTransaction

Description: Virtual method bool QSqlDriver::beginTransaction()

This method can be reimplemented in a derived class.

[virtual] void childEvent(QChildEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[virtual] void close

Description: Virtual method void QSqlDriver::close()

This method can be reimplemented in a derived class.

[virtual] bool commitTransaction

Description: Virtual method bool QSqlDriver::commitTransaction()

This method can be reimplemented in a derived class.

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

[virtual,const] QSqlResult ptr createResult

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

This method can be reimplemented in a derived class.

[virtual] void customEvent(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[event] void destroyed(QObject ptr arg1)

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

You can bind a procedure to this signal.

[const] bool destroyed?

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

Use of this method is deprecated. Use _destroyed? instead

[virtual] void disconnectNotify(string signal)

Description: Virtual method void QSqlDriver::disconnectNotify(const char *signal)

This method can be reimplemented in a derived class.

[virtual,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.

[virtual] bool event(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[virtual] bool eventFilter(QObject ptr arg1,QEvent ptr arg2)

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

This method can be reimplemented in a derived class.

[virtual,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.

[virtual,const] QVariant handle

Description: Virtual method QVariant QSqlDriver::handle()

This method can be reimplemented in a derived class.

[virtual,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.

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

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

[const] bool isIdentifierEscapedImplementation(string identifier,const QSqlDriver_IdentifierType type)

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

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

[virtual,const] bool isOpen

Description: Virtual method bool QSqlDriver::isOpen()

This method can be reimplemented in a derived class.

[const] bool isOpen?

Description: Method bool QSqlDriver::isOpen()

[const] bool isOpenError?

Description: Method bool QSqlDriver::isOpenError()

[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

[const] QSqlError lastError

Description: Method QSqlError QSqlDriver::lastError()

[static] new QSqlDriver new(QObject ptr parent = 0)

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

[event] void notification(string name)

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

You can bind a procedure to this signal.

[const] QSql_NumericalPrecisionPolicy numericalPrecisionPolicy

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

Python specific notes:

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

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.

[virtual] 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.

[virtual,const] QSqlIndex primaryIndex(string tableName)

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

This method can be reimplemented in a derived class.

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

[virtual,const] QSqlRecord record(string tableName)

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

This method can be reimplemented in a derived class.

[virtual] bool rollbackTransaction

Description: Virtual method bool QSqlDriver::rollbackTransaction()

This method can be reimplemented in a derived class.

[const] QObject ptr sender

Description: Method QObject *QSqlDriver::sender()

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

[virtual] void setLastError(const QSqlError e)

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

This method can be reimplemented in a derived class.

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.

[virtual] void setOpen(bool o)

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

This method can be reimplemented in a derived class.

[virtual] void setOpenError(bool e)

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

This method can be reimplemented in a derived class.

[virtual,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.

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

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

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

[const] string stripDelimitersImplementation(string identifier,const QSqlDriver_IdentifierType type)

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

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

bool subscribeToNotification(string name)

Description: Method bool QSqlDriver::subscribeToNotification(const QString &name)

bool subscribeToNotificationImplementation(string name)

Description: Method bool QSqlDriver::subscribeToNotificationImplementation(const QString &name)

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

[const] string[] subscribedToNotifications

Description: Method QStringList QSqlDriver::subscribedToNotifications()

[const] string[] subscribedToNotificationsImplementation

Description: Method QStringList QSqlDriver::subscribedToNotificationsImplementation()

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

[virtual,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.

[virtual] void timerEvent(QTimerEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[static] string tr(string s,string c = 0)

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

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

[static] string tr(string s,string c,int n)

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.

[static] string trUtf8(string s,string c = 0)

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

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

[static] string trUtf8(string s,string c,int n)

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.

bool unsubscribeFromNotification(string name)

Description: Method bool QSqlDriver::unsubscribeFromNotification(const QString &name)

bool unsubscribeFromNotificationImplementation(string name)

Description: Method bool QSqlDriver::unsubscribeFromNotificationImplementation(const QString &name)

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