Qt:Документация 4.3.2/qsqldriver

Материал из Wiki.crossplatform.ru

Перейти к: навигация, поиск
40px Внимание: Актуальная версия перевода документации находится здесь

__NOTOC__

Image:qt-logo.png

Главная · Все классы · Основные классы · Классы по группам · Модули · Функции

Image:trolltech-logo.png

Содержание

[править] QSqlDriver Class Reference
[модуль QtSql ]

The QSqlDriver class is an abstract base class for accessing specific SQL databases. More... 

 #include <QSqlDriver>

Inherits QObject.

[править] Открытые типы

  • enum DriverFeature { Transactions, QuerySize, BLOB, Unicode, ..., LowPrecisionNumbers }
  • enum IdentifierType { FieldName, TableName }
  • enum StatementType { WhereStatement, SelectStatement, UpdateStatement, InsertStatement, DeleteStatement }

[править] Открытые функции

  • QSqlDriver ( QObject * parent = 0 )
  • ~QSqlDriver ()
  • virtual bool beginTransaction ()
  • virtual void close () = 0
  • virtual bool commitTransaction ()
  • virtual QSqlResult * createResult () const = 0
  • virtual QString escapeIdentifier ( const QString & identifier, IdentifierType type ) const
  • virtual QString formatValue ( const QSqlField & field, bool trimStrings = false ) const
  • virtual QVariant handle () const
  • virtual bool hasFeature ( DriverFeature feature ) const = 0
  • virtual bool isOpen () const
  • bool isOpenError () const
  • QSqlError lastError () const
  • virtual bool open ( const QString & db, const QString & user = QString(), const QString & password = QString(), const QString & host = QString(), int port = -1, const QString & options = QString() ) = 0
  • virtual QSqlIndex primaryIndex ( const QString & tableName ) const
  • virtual QSqlRecord record ( const QString & tableName ) const
  • virtual bool rollbackTransaction ()
  • virtual QString sqlStatement ( StatementType type, const QString & tableName, const QSqlRecord & rec, bool preparedStatement ) const
  • virtual QStringList tables ( QSql::TableType tableType ) const
  • 29 открытых функций унаследованных от QObject

[править] Защищенные функции

  • 7 защищенных функций унаследованных от QObject

[править] Дополнительные унаследованные члены

  • 1 свойство унаследованное от QObject
  • 1 открытый слот унаследованный от QObject
  • 1 сигнал унаследованный от QObject
  • 5 статических открытых члена унаследованных от QObject

[править] Подробное описание

The QSqlDriver class is an abstract base class for accessing specific SQL databases.

This class should not be used directly. Use QSqlDatabase instead.

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 for more information.

See also QSqlDatabase and QSqlResult.

[править] Описание типов членов

[править]
enum QSqlDriver::DriverFeature

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


Constant Value Description
QSqlDriver::Transactions 0 Whether the driver supports SQL transactions.
QSqlDriver::QuerySize 1 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 QSqlQuery::size() will return -1.
QSqlDriver::BLOB 2 Whether the driver supports Binary Large Object fields.
QSqlDriver::Unicode 3 Whether the driver supports Unicode strings if the database server does.
QSqlDriver::PreparedQueries 4 Whether the driver supports prepared query execution.
QSqlDriver::NamedPlaceholders 5 Whether the driver supports the use of named placeholders.
QSqlDriver::PositionalPlaceholders 6 Whether the driver supports the use of positional placeholders.
QSqlDriver::LastInsertId 7 Whether the driver supports returning the Id of the last touched row.
QSqlDriver::BatchOperations 8 Whether the driver supports batched operations, see QSqlResult::execBatch()
QSqlDriver::SimpleLocking 9 Whether the driver disallows a write lock on a table while other queries have a read lock on it.
QSqlDriver::LowPrecisionNumbers 10 Whether the driver allows fetching numerical values with low precision.

More information about supported features can be found in the Qt SQL driver documentation.

See also hasFeature().

[править]
enum QSqlDriver::IdentifierType

This enum contains a list of SQL identifier types.


Constant Value Description
QSqlDriver::FieldName 0 A SQL field name
QSqlDriver::TableName 1 A SQL table name

[править]
enum QSqlDriver::StatementType

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


Constant Value Description
QSqlDriver::WhereStatement 0 An SQL WHERE statement (e.g., WHERE f = 5).
QSqlDriver::SelectStatement 1 An SQL SELECT statement (e.g., SELECT f FROM t).
QSqlDriver::UpdateStatement 2 An SQL UPDATE statement (e.g., UPDATE TABLE t set f = 1).
QSqlDriver::InsertStatement 3 An SQL INSERT statement (e.g., INSERT INTO t (f) values (1)).
QSqlDriver::DeleteStatement 4 An SQL DELETE statement (e.g., DELETE FROM t).

See also sqlStatement().

[править] Описание функций-членов

[править]
QSqlDriver::QSqlDriver ( QObject * parent = 0 )

Constructs a new driver with the given parent.

[править]
QSqlDriver::~QSqlDriver ()

Destroys the object and frees any allocated resources.

[править]
bool QSqlDriver::beginTransaction () [virtual]

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

See also commitTransaction() and rollbackTransaction().

[править]
void QSqlDriver::close () [pure virtual]

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

See also open() and setOpen().

[править]
bool QSqlDriver::commitTransaction () [virtual]

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

See also beginTransaction() and rollbackTransaction().

[править]
QSqlResult * QSqlDriver::createResult () const [pure virtual]

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.

[править]
QString QSqlDriver::escapeIdentifier ( const QString & identifier, IdentifierType type ) const [virtual]

Returns the 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.

[править]
QString QSqlDriver::formatValue ( const QSqlField & field, bool trimStrings = false ) const [virtual]

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:

  • If 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.
  • If 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.
  • If 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.

See also QVariant::toString().

[править]
QVariant QSqlDriver::handle () const [virtual]

Returns the low-level database handle wrapped in a QVariant or an invalid variant if there is no handle.

Warning: Use this with uttermost care and only if you know what you're doing.

Warning: The handle returned here can become a stale pointer if the connection is modified (for example, if you close the connection).

Warning: The handle can be NULL if the connection is not open yet.

The handle returned here is database-dependent, you should query the type name of the variant before accessing it.

This example retrieves the handle for a connection to sqlite: 

 QSqlDatabase db = ...;
 QVariant v = db.driver()->handle();
 if (v.isValid() &amp;&amp; qstrcmp(v.typeName(), "sqlite3*")) {
     // v.data() returns a pointer to the handle
     sqlite3 *handle = *static_cast<sqlite3 **>(v.data());
     if (handle != 0) { // check that it is not NULL
         ...
     }
 }

This snippet returns the handle for PostgreSQL or MySQL: 

 if (v.typeName() == "PGconn*") {
     PGconn *handle = *static_cast<PGconn **>(v.data());
     if (handle != 0) ...
 }
 
 if (v.typeName() == "MYSQL*") {
     MYSQL *handle = *static_cast<MYSQL **>(v.data());
     if (handle != 0) ...
 }

See also QSqlResult::handle().

[править]
bool QSqlDriver::hasFeature ( DriverFeature feature ) const [pure virtual]

Returns true if the driver supports feature feature; otherwise returns false.

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

See also DriverFeature.

[править]
bool QSqlDriver::isOpen () const [virtual]

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

[править]
bool QSqlDriver::isOpenError () const

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

[править]
QSqlError QSqlDriver::lastError () const

Returns a QSqlError object which contains information about the last error that occurred on the database.

See also setLastError().

[править]
bool QSqlDriver::open ( const QString & db, const QString & user = QString(), const QString & password = QString(), const QString & host = QString(), int port = -1, const QString & options = QString() ) [pure virtual]

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.

See also setOpen().

[править]
QSqlIndex QSqlDriver::primaryIndex ( const QString & tableName ) const [virtual]

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.

[править]
QSqlRecord QSqlDriver::record ( const QString & tableName ) const [virtual]

Returns a 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.

[править]
bool QSqlDriver::rollbackTransaction () [virtual]

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

See also beginTransaction() and commitTransaction().

[править]
void QSqlDriver::setLastError ( const QSqlError & error ) [virtual protected]

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

See also lastError().

[править]
void QSqlDriver::setOpen ( bool open ) [virtual protected]

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

See also open() and setOpenError().

[править]
void QSqlDriver::setOpenError ( bool error ) [virtual protected]

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() returns false).

See also isOpenError(), open(), and setOpen().

[править]
QString QSqlDriver::sqlStatement ( StatementType type, const QString & tableName, const QSqlRecord & rec, bool preparedStatement ) const [virtual]

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

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.

[править]
QStringList QSqlDriver::tables ( QSql::TableType tableType ) const [virtual]

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

The 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 QSql::Tables for backward compatibility.

Copyright © 2007 Trolltech Trademarks
Qt 4.3.2
Источник — «http://www.wiki.crossplatform.ru/index.php/Qt:%D0%94%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%86%D0%B8%D1%8F_4.3.2/qsqldriver»