QSqlDriver ¶

概要 ¶

详细描述 ¶

This class should not be used directly. Use QSqlDatabase 代替。

If you want to create your own SQL drivers, you can subclass this class and reimplement its pure virtual functions and those virtual functions that you need. See How to Write Your Own Database Driver 了解更多信息。

另请参阅

QSqlDatabase QSqlResult

class QSqlDriver ( [ parent=None ] ) ¶

param parent

QObject

Constructs a new driver with the given parent .

PySide2.QtSql.QSqlDriver. DriverFeature ¶

This enum contains a list of features a driver might support. Use hasFeature() to query whether a feature is supported or not.

常量	描述
QSqlDriver.Transactions	Whether the driver supports SQL transactions.
QSqlDriver.QuerySize	Whether the database is capable of reporting the size of a query. Note that some databases do not support returning the size (i.e. number of rows returned) of a query, in which case size() will return -1.
QSqlDriver.BLOB	Whether the driver supports Binary Large Object fields.
QSqlDriver.Unicode	Whether the driver supports Unicode strings if the database server does.
QSqlDriver.PreparedQueries	Whether the driver supports prepared query execution.
QSqlDriver.NamedPlaceholders	Whether the driver supports the use of named placeholders.
QSqlDriver.PositionalPlaceholders	Whether the driver supports the use of positional placeholders.
QSqlDriver.LastInsertId	Whether the driver supports returning the Id of the last touched row.
QSqlDriver.BatchOperations	Whether the driver supports batched operations, see execBatch()
QSqlDriver.SimpleLocking	Whether the driver disallows a write lock on a table while other queries have a read lock on it.
QSqlDriver.LowPrecisionNumbers	Whether the driver allows fetching numerical values with low precision.
QSqlDriver.EventNotifications	Whether the driver supports database event notifications.
QSqlDriver.FinishQuery	Whether the driver can do any low-level resource cleanup when finish() 被调用。
QSqlDriver.MultipleResultSets	Whether the driver can access multiple result sets returned from batched statements or stored procedures.
QSqlDriver.CancelQuery	Whether the driver allows cancelling a running query.

More information about supported features can be found in the Qt SQL driver 文档编制。

另请参阅

hasFeature()

PySide2.QtSql.QSqlDriver. StatementType ¶

This enum contains a list of SQL statement (or clause) types the driver can create.

常量	描述
QSqlDriver.WhereStatement	An SQL WHERE statement (e.g., WHERE f = 5 ).
QSqlDriver.SelectStatement	An SQL SELECT statement (e.g., SELECT f FROM t ).
QSqlDriver.UpdateStatement	An SQL UPDATE statement (e.g., UPDATE TABLE t set f = 1 ).
QSqlDriver.InsertStatement	An SQL INSERT statement (e.g., INSERT INTO t (f) values (1) ).
QSqlDriver.DeleteStatement	An SQL DELETE statement (e.g., DELETE FROM t ).

另请参阅

sqlStatement()

PySide2.QtSql.QSqlDriver. IdentifierType ¶

This enum contains a list of SQL identifier types.

常量	描述
QSqlDriver.FieldName	A SQL field name
QSqlDriver.TableName	A SQL table name

PySide2.QtSql.QSqlDriver. NotificationSource ¶

This enum contains a list of SQL notification sources.

常量	描述
QSqlDriver.UnknownSource	The notification source is unknown
QSqlDriver.SelfSource	The notification source is this connection
QSqlDriver.OtherSource	The notification source is another connection

PySide2.QtSql.QSqlDriver. DbmsType ¶

This enum contains DBMS types.

常量	描述
QSqlDriver.UnknownDbms
QSqlDriver.MSSqlServer
QSqlDriver.MySqlServer
QSqlDriver.PostgreSQL
QSqlDriver.Oracle
QSqlDriver.Sybase
QSqlDriver.SQLite
QSqlDriver.Interbase
QSqlDriver.DB2

PySide2.QtSql.QSqlDriver. beginTransaction ( ) ¶

返回类型

bool

This function is called to begin a transaction. If successful, return true, otherwise return false. The default implementation does nothing and returns false .

另请参阅

commitTransaction() rollbackTransaction()

PySide2.QtSql.QSqlDriver. cancelQuery ( ) ¶

返回类型

bool

Tries to cancel the running query, if the underlying driver has the capability to cancel queries. Returns true on success, otherwise false.

This function can be called from a different thread.

If you use this function as a slot, you need to use a DirectConnection from a different thread.

Reimplement this function to support canceling running queries in your own QSqlDriver subclass. It must be implemented in a thread-safe manner.

另请参阅

hasFeature()

PySide2.QtSql.QSqlDriver. close ( ) ¶

Derived classes must reimplement this pure virtual function in order to close the database connection. Return true on success, false on failure.

另请参阅

open() setOpen()

PySide2.QtSql.QSqlDriver. commitTransaction ( ) ¶

返回类型

bool

This function is called to commit a transaction. If successful, return true, otherwise return false. The default implementation does nothing and returns false .

另请参阅

beginTransaction() rollbackTransaction()

PySide2.QtSql.QSqlDriver. createResult ( ) ¶

返回类型

QSqlResult

Creates an empty SQL result on the database. Derived classes must reimplement this function and return a QSqlResult object appropriate for their database to the caller.

PySide2.QtSql.QSqlDriver. dbmsType ( ) ¶

返回类型

DbmsType

Returns the current DBMS type for the database connection.

PySide2.QtSql.QSqlDriver. escapeIdentifier ( identifier , type ) ¶

参数

• identifier – unicode

• type – IdentifierType

返回类型

unicode

返回 identifier escaped according to the database rules. identifier can either be a table name or field name, dependent on type .

The default implementation does nothing.

另请参阅

isIdentifierEscaped()

PySide2.QtSql.QSqlDriver. formatValue ( field [ , trimStrings=false ] ) ¶

参数

• field – QSqlField

• trimStrings – bool

返回类型

unicode

Returns a string representation of the field value for the database. This is used, for example, when constructing INSERT and UPDATE statements.

The default implementation returns the value formatted as a string according to the following rules:

• 若 field is character data, the value is returned enclosed in single quotation marks, which is appropriate for many SQL databases. Any embedded single-quote characters are escaped (replaced with two single-quote characters). If trimStrings is true (the default is false), all trailing whitespace is trimmed from the field.

• 若 field is date/time data, the value is formatted in ISO format and enclosed in single quotation marks. If the date/time data is invalid, “NULL” is returned.

• 若 field is bytearray data, and the driver can edit binary fields, the value is formatted as a hexadecimal string.

• For any other field type, toString() is called on its value and the result of this is returned.

另请参阅

toString()

PySide2.QtSql.QSqlDriver. hasFeature ( f ) ¶

参数

f – DriverFeature

返回类型

bool

返回 true if the driver supports feature feature ；否则返回 false .

Note that some databases need to be open() before this can be determined.

另请参阅

DriverFeature

PySide2.QtSql.QSqlDriver. isIdentifierEscaped ( identifier , type ) ¶

参数

• identifier – unicode

• type – IdentifierType

返回类型

bool

Returns whether identifier is escaped according to the database rules. identifier can either be a table name or field name, dependent on type .

Reimplement this function if you want to provide your own implementation in your QSqlDriver 子类，

另请参阅

stripDelimiters() escapeIdentifier()

PySide2.QtSql.QSqlDriver. isOpen ( ) ¶

返回类型

bool

返回 true if the database connection is open; otherwise returns false.

PySide2.QtSql.QSqlDriver. isOpenError ( ) ¶

返回类型

bool

返回 true if the there was an error opening the database connection; otherwise returns false .

PySide2.QtSql.QSqlDriver. lastError ( ) ¶

返回类型

QSqlError

返回 QSqlError object which contains information about the last error that occurred on the database.

另请参阅

setLastError()

PySide2.QtSql.QSqlDriver. notification ( name ) ¶

参数

name – unicode

注意

此函数被弃用。

PySide2.QtSql.QSqlDriver. notification ( name , source , payload ) ¶

参数

• name – unicode

• source – NotificationSource

• payload – object

PySide2.QtSql.QSqlDriver. numericalPrecisionPolicy ( ) ¶

返回类型

NumericalPrecisionPolicy

Returns the current default precision policy for the database connection.

另请参阅

NumericalPrecisionPolicy setNumericalPrecisionPolicy() numericalPrecisionPolicy() setNumericalPrecisionPolicy()

PySide2.QtSql.QSqlDriver. open ( db [ , user="" [ , password="" [ , host="" [ , port=-1 [ , connOpts="" ] ] ] ] ] ) ¶

参数

• db – unicode

• user – unicode

• password – unicode

• host – unicode

• port – int

• connOpts – unicode

返回类型

bool

Derived classes must reimplement this pure virtual function to open a database connection on database db , using user name user , password password , host host , port port and connection options options .

The function must return true on success and false on failure.

另请参阅

setOpen()

PySide2.QtSql.QSqlDriver. primaryIndex ( tableName ) ¶

参数

tableName – unicode

返回类型

QSqlIndex

Returns the primary index for table tableName . Returns an empty QSqlIndex if the table doesn’t have a primary index. The default implementation returns an empty index.

PySide2.QtSql.QSqlDriver. record ( tableName ) ¶

参数

tableName – unicode

返回类型

QSqlRecord

返回 QSqlRecord populated with the names of the fields in table tableName . If no such table exists, an empty record is returned. The default implementation returns an empty record.

PySide2.QtSql.QSqlDriver. rollbackTransaction ( ) ¶

返回类型

bool

This function is called to rollback a transaction. If successful, return true, otherwise return false. The default implementation does nothing and returns false .

另请参阅

beginTransaction() commitTransaction()

PySide2.QtSql.QSqlDriver. setLastError ( e ) ¶

参数

e – QSqlError

This function is used to set the value of the last error, error , that occurred on the database.

另请参阅

lastError()

PySide2.QtSql.QSqlDriver. setNumericalPrecisionPolicy ( precisionPolicy ) ¶

参数

precisionPolicy – NumericalPrecisionPolicy

Sets the default numerical precision policy used by queries created by this driver to precisionPolicy .

Note: Setting the default precision policy to precisionPolicy doesn’t affect any currently active queries.

另请参阅

NumericalPrecisionPolicy numericalPrecisionPolicy() setNumericalPrecisionPolicy() numericalPrecisionPolicy()

PySide2.QtSql.QSqlDriver. setOpen ( o ) ¶

参数

o – bool

This function sets the open state of the database to open . Derived classes can use this function to report the status of open() .

另请参阅

open() setOpenError()

PySide2.QtSql.QSqlDriver. setOpenError ( e ) ¶

参数

e – bool

This function sets the open error state of the database to error . Derived classes can use this function to report the status of open() . Note that if error is true the open state of the database is set to closed (i.e., isOpen() 返回 false ).

另请参阅

isOpenError() open() setOpen()

PySide2.QtSql.QSqlDriver. sqlStatement ( type , tableName , rec , preparedStatement ) ¶

参数

• type – StatementType

• tableName – unicode

• rec – QSqlRecord

• preparedStatement – bool

返回类型

unicode

Returns a SQL statement of type type for the table tableName with the values from rec 。若 preparedStatement is true, the string will contain placeholders instead of values.

The generated flag in each field of rec determines whether the field is included in the generated statement.

This method can be used to manipulate tables without having to worry about database-dependent SQL dialects. For non-prepared statements, the values will be properly escaped.

In the WHERE statement, each non-null field of rec specifies a filter condition of equality to the field value, or if prepared, a placeholder. However, prepared or not, a null field specifies the condition IS NULL and never introduces a placeholder. The application must not attempt to bind data for the null field during execution. The field must be set to some non-null value if a placeholder is desired. Furthermore, since non-null fields specify equality conditions and SQL NULL is not equal to anything, even itself, it is generally not useful to bind a null to a placeholder.

PySide2.QtSql.QSqlDriver. stripDelimiters ( identifier , type ) ¶

参数

• identifier – unicode

• type – IdentifierType

返回类型

unicode

返回 identifier with the leading and trailing delimiters removed, identifier can either be a table name or field name, dependent on type 。若 identifier does not have leading and trailing delimiter characters, identifier is returned without modification.

Reimplement this function if you want to provide your own implementation in your QSqlDriver 子类，

另请参阅

isIdentifierEscaped()

PySide2.QtSql.QSqlDriver. subscribeToNotification ( name ) ¶

参数

name – unicode

返回类型

bool

This function is called to subscribe to event notifications from the database. name identifies the event notification.

If successful, return true, otherwise return false.

The database must be open when this function is called. When the database is closed by calling close() all subscribed event notifications are automatically unsubscribed. Note that calling open() on an already open database may implicitly cause close() to be called, which will cause the driver to unsubscribe from all event notifications.

When an event notification identified by name is posted by the database the notification() 信号被发射。

Reimplement this function if you want to provide event notification support in your own QSqlDriver 子类，

另请参阅

unsubscribeFromNotification() subscribedToNotifications() hasFeature()

PySide2.QtSql.QSqlDriver. subscribedToNotifications ( ) ¶

返回类型

字符串列表

Returns a list of the names of the event notifications that are currently subscribed to.

Reimplement this function if you want to provide event notification support in your own QSqlDriver 子类，

另请参阅

subscribeToNotification() unsubscribeFromNotification()

PySide2.QtSql.QSqlDriver. tables ( tableType ) ¶

参数

tableType – TableType

返回类型

字符串列表

Returns a list of the names of the tables in the database. The default implementation returns an empty list.

tableType argument describes what types of tables should be returned. Due to binary compatibility, the string contains the value of the enum QSql::TableTypes as text. An empty string should be treated as Tables for backward compatibility.

PySide2.QtSql.QSqlDriver. unsubscribeFromNotification ( name ) ¶

参数

name – unicode

返回类型

bool

This function is called to unsubscribe from event notifications from the database. name identifies the event notification.

If successful, return true, otherwise return false.

The database must be open when this function is called. All subscribed event notifications are automatically unsubscribed from when the close() 函数被调用。

After calling this function the notification() signal will no longer be emitted when an event notification identified by name is posted by the database.

Reimplement this function if you want to provide event notification support in your own QSqlDriver 子类，

另请参阅

subscribeToNotification() subscribedToNotifications()