Класс QSqlDriver

Класс QSqlDriver — это абстрактный базовый класс для доступа к конкретным базам данных SQL. Подробнее...

• Список всех членов, включая унаследованные
• Устаревшие члены

Типы публичного доступа

Публичные функции

Сигналы

Защищенные функции

Подробное описание

Этот класс не следует использовать напрямую. Используйте QSqlDatabase вместо него.

Если вы хотите создать собственные драйверы SQL, вы можете наследовать от этого класса и переопределить его чистые виртуальные функции и те виртуальные функции, которые вам нужны. См. Как создать собственный драйвер базы данных для получения дополнительной информации.

См. также QSqlDatabase и QSqlResult.

Документация по типам членов

Перечисление QSqlDriver::DriverFeature

Это перечисление содержит список функций, которые может поддерживать драйвер. Используйте hasFeature(), чтобы проверить, поддерживается ли функция.

Более подробную информацию о поддерживаемых функциях можно найти в документации драйвера Qt SQL Qt SQL driver.

См. такжеhasFeature().

enum QSqlDriver::IdentifierType

Этот перечисление содержит список типов идентификаторов SQL.

enum QSqlDriver::NotificationSource

Это перечисление содержит список источников уведомлений SQL.

enum QSqlDriver::StatementType

Это перечисление содержит список типов операторов SQL (или разделов), которые может создавать драйвер.

См. такжеsqlStatement().

Документация по функциям-членам

QSqlDriver::QSqlDriver(QObject *parent = nullptr)

Создаёт новый драйвер с заданным parent.

[signal] void QSqlDriver::notification(const QString &name, QSqlDriver::NotificationSource source, const QVariant &payload)

Этот сигнал излучается, когда база данных публикует уведомление об событии, на которое драйвер подписан. name идентифицирует уведомление об событии, source указывает источник сигнала, payload содержит дополнительные данные, необязательно предоставляемые с уведомлением.

Примечание: Сигнал notification перегружен в этом классе. Для подключения к этому сигналу с помощью синтаксиса указателя на функцию Qt предоставляет удобную вспомогательную функцию для получения указателя на функцию, как показано в этом примере:

connect(sqlDriver, QOverload<const QString &, QSqlDriver::NotificationSource, const QVariant &>::of(&QSqlDriver::notification),
    [=](const QString &name, QSqlDriver::NotificationSource source, const QVariant &payload){ /* ... */ });

Эта функция была введена в Qt 5.0.

См. такжеsubscribeToNotification().

[virtual] QSqlDriver::~QSqlDriver()

Удаляет объект и освобождает выделенные ресурсы.

[virtual] bool QSqlDriver::beginTransaction()

Эта функция вызывается для начала транзакции. Если успешно, возвращает true, в противном случае возвращает false. Реализация по умолчанию ничего не делает и возвращает false.

См. такжеcommitTransaction() и rollbackTransaction().

[pure virtual] void QSqlDriver::close()

Производные классы должны переопределить эту чисто виртуальную функцию для закрытия подключения к базе данных. Возвращает true при успехе, false при ошибке.

См. такжеopen() и setOpen().

[virtual] bool QSqlDriver::commitTransaction()

Эта функция вызывается для подтверждения транзакции. Если успешно, возвращает true, в противном случае возвращает false. Реализация по умолчанию ничего не делает и возвращает false.

См. такжеbeginTransaction() и rollbackTransaction().

[pure virtual] QSqlResult *QSqlDriver::createResult() const

Создаёт пустой результат SQL в базе данных. Производные классы должны переопределить эту функцию и вернуть объект QSqlResult, соответствующий их базе данных.

[virtual] QString QSqlDriver::escapeIdentifier(const QString &identifier, QSqlDriver::IdentifierType type) const

Возвращает identifier, экранированный в соответствии с правилами базы данных. identifier может быть именем таблицы или именем поля, в зависимости от type.

Реализация по умолчанию ничего не делает.

См. такжеisIdentifierEscaped().

[virtual] QString QSqlDriver::formatValue(const QSqlField &field, bool trimStrings = false) const

Возвращает строковое представление значения field для базы данных. Это используется, например, при построении операторов INSERT и UPDATE.

Реализация по умолчанию возвращает значение, отформатированное как строка в соответствии со следующими правилами:

• Если поле содержит символьные данные, значение возвращается в одинарных кавычках, что подходит для многих баз данных SQL. Любые вложенные символы одинарной кавычки экранируются (заменяются двумя символами одинарной кавычки). Если trimStrings имеет значение true (по умолчанию false), все хвостовые пробелы удаляются из поля.
• Если поле содержит данные даты/времени, значение форматируется в формате ISO и заключается в одинарные кавычки. Если данные даты/времени некорректны, возвращается "NULL".
• Если поле содержит данные типа bytearray, и драйвер может редактировать двоичные поля, значение форматируется как шестнадцатеричная строка.
• Для любого другого типа поля вызывается toString() для его значения, и результат этого вызова возвращается.

См. также QVariant::toString().

[virtual] QVariant QSqlDriver::handle() const

Возвращает низкоуровневую ручку базы данных, заключённую в QVariant, или недействительный вариант, если ручки нет.

Предупреждение: Используйте с большой осторожностью и только если вы знаете, что делаете.

Предупреждение: Возвращаемая ручка может стать устаревшей ссылкой, если подключение изменено (например, если вы закрываете подключение).

Предупреждение: Ручка может быть NULL, если подключение ещё не открыто.

Возвращаемая ручка зависит от базы данных, вы должны запросить имя типа варианта перед доступом к нему.

В этом примере извлекается ручка для подключения к sqlite:

QSqlDatabase db = QSqlDatabase::database();
QVariant v = db.driver()->handle();
if (v.isValid() && (qstrcmp(v.typeName(), "sqlite3*") == 0)) {
    // v.data() returns a pointer to the handle
    sqlite3 *handle = *static_cast<sqlite3 **>(v.data());
    if (handle) {
        // ...
    }
}

Этот фрагмент возвращает ручку для PostgreSQL или MySQL:

if (qstrcmp(v.typeName(), "PGconn*") == 0) {
    PGconn *handle = *static_cast<PGconn **>(v.data());
    if (handle) {
        // ...
    }
}

if (qstrcmp(v.typeName(), "MYSQL*") == 0) {
    MYSQL *handle = *static_cast<MYSQL **>(v.data());
    if (handle) {
        // ...
    }
}

См. также QSqlResult::handle().

[pure virtual] bool QSqlDriver::hasFeature(QSqlDriver::DriverFeature feature) const

Возвращает true, если драйвер поддерживает функцию feature; в противном случае возвращает false.

Обратите внимание, что некоторым базам данных необходимо быть открытыми() перед тем, как это можно определить.

См. также DriverFeature.

[virtual] bool QSqlDriver::isIdentifierEscaped(const QString &identifier, QSqlDriver::IdentifierType type) const

Возвращает значение, указывающее, экранировано ли identifier в соответствии с правилами базы данных. identifier может быть именем таблицы или именем поля, в зависимости от type.

Переопределите эту функцию, если хотите предоставить собственную реализацию в вашем подклассе QSqlDriver.

См. также stripDelimiters() и escapeIdentifier().

[virtual] bool QSqlDriver::isOpen() const

Возвращает true, если подключение к базе данных открыто; в противном случае возвращает false.

bool QSqlDriver::isOpenError() const

Возвращает true, если при открытии подключения к базе данных произошла ошибка; в противном случае возвращает false.

QSqlError QSqlDriver::lastError() const

Возвращает объект QSqlError, содержащий информацию об ошибке, произошедшей в базе данных последней.

См. также setLastError().

QSql::NumericalPrecisionPolicy QSqlDriver::numericalPrecisionPolicy() const

Возвращает текущую политику точности для подключения к базе данных.

Эта функция была добавлена в Qt 4.6.

См. также QSql::NumericalPrecisionPolicy, setNumericalPrecisionPolicy(), QSqlQuery::numericalPrecisionPolicy(), и QSqlQuery::setNumericalPrecisionPolicy().

[pure virtual] 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())

Производные классы должны переопределить эту чистую виртуальную функцию, чтобы открыть подключение к базе данных db, используя имя пользователя user, пароль password, хост host, порт port и параметры подключения options.

Функция должна возвращать true при успехе и false при неудаче.

См. также setOpen().

[virtual] QSqlIndex QSqlDriver::primaryIndex(const QString &tableName) const

Возвращает первичный индекс для таблицы tableName. Возвращает пустой QSqlIndex, если таблица не имеет первичного индекса. Реализация по умолчанию возвращает пустой индекс.

[virtual] QSqlRecord QSqlDriver::record(const QString &tableName) const

Возвращает QSqlRecord, заполненный именами полей в таблице tableName. Если такая таблица не существует, возвращается пустой record. Реализация по умолчанию возвращает пустой record.

[virtual] bool QSqlDriver::rollbackTransaction()

Эта функция используется для отката транзакции. Если успешно, возвращает true, иначе возвращает false. Реализация по умолчанию ничего не делает и возвращает false.

См. также beginTransaction() и commitTransaction().

[virtual protected] void QSqlDriver::setLastError(const QSqlError &error)

Эта функция используется для установки значения последней ошибки, error, произошедшей в базе данных.

См. также lastError().

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

Устанавливает политику точности чисел по умолчанию, используемую запросами, созданными этим драйвером, на precisionPolicy.

Примечание: Установка политики точности по умолчанию на precisionPolicy не влияет на активные запросы.

Эта функция была добавлена в Qt 4.6.

См. также QSql::NumericalPrecisionPolicy, numericalPrecisionPolicy(), QSqlQuery::setNumericalPrecisionPolicy(), и QSqlQuery::numericalPrecisionPolicy().

[virtual protected] void QSqlDriver::setOpen(bool open)

Эта функция устанавливает состояние открытия базы данных на open. Производные классы могут использовать эту функцию для отслеживания статуса open().

См. также open() и setOpenError().

[virtual protected] void QSqlDriver::setOpenError(bool error)

Эта функция устанавливает состояние ошибки открытия базы данных на error. Производные классы могут использовать эту функцию для отслеживания статуса open(). Обратите внимание, что если error имеет значение true, состояние открытия базы данных устанавливается в закрытое (т.е., isOpen() возвращает false).

См. также isOpenError(), open(), и setOpen().

[virtual] QString QSqlDriver::sqlStatement(QSqlDriver::StatementType type, const QString &tableName, const QSqlRecord &rec, bool preparedStatement) const

Возвращает SQL-запрос типа type для таблицы tableName со значениями из rec. Если preparedStatement имеет значение true, строка будет содержать заглушки вместо значений.

Флаг, сгенерированный в каждом поле rec, определяет, включается ли поле в сгенерированный запрос.

Этот метод может быть использован для манипулирования таблицами без необходимости беспокоиться о зависимых от базы данных диалектах SQL. Для запросов без подготовки значения будут правильно экранированы.

В операторе WHERE каждое ненулевое поле rec задаёт условие фильтрации равенства значению поля или, при подготовке, заглушке. Однако, подготовленный или нет, нулевое поле задаёт условие IS NULL и никогда не вводит заглушку. Приложение не должно пытаться привязать данные к нулевому полю во время выполнения. Поле должно быть установлено на ненулевое значение, если требуется заглушка. Более того, поскольку ненулевые поля задают условия равенства, и SQL NULL не равен ничему, даже самому себе, привязка нуля к заглушке обычно не полезна.

[virtual] QString QSqlDriver::stripDelimiters(const QString &identifier, QSqlDriver::IdentifierType type) const

Возвращает идентификатор с удалёнными начальными и конечными разделителями; идентификатор может быть именем таблицы или именем поля, в зависимости от типа. Если у идентификатора нет начальных и конечных символов-разделителей, идентификатор возвращается без изменений.

Переопределите эту функцию, если хотите предоставить собственную реализацию в своём подклассе QSqlDriver.

Эта функция была добавлена в Qt 4.5.

См. также isIdentifierEscaped().

[virtual] bool QSqlDriver::subscribeToNotification(const QString &name)

Эта функция вызывается для подписки на уведомления о событиях из базы данных. name идентифицирует уведомление о событии.

В случае успеха возвращает true, в противном случае — false.

База данных должна быть открыта при вызове этой функции. Когда база данных закрывается путём вызова close(), все подписанные уведомления о событиях автоматически отписываются. Обратите внимание, что вызов open() на уже открытой базе данных может неявно вызвать close(), что заставит драйвер отписаться от всех уведомлений о событиях.

Когда уведомление о событии, идентифицированное по name, публикуется базой данных, посылается сигнал notification().

Переопределите эту функцию, если хотите добавить поддержку уведомлений о событиях в свой подкласс QSqlDriver.

Эта функция была добавлена в Qt 4.4.

См. также unsubscribeFromNotification(), subscribedToNotifications() и QSqlDriver::hasFeature().

[virtual] QStringList QSqlDriver::subscribedToNotifications() const

Возвращает список имён уведомлений о событиях, на которые в данный момент подписаны.

Переопределите эту функцию, если хотите добавить поддержку уведомлений о событиях в свой подкласс QSqlDriver.

Эта функция была добавлена в Qt 4.4.

См. также subscribeToNotification() и unsubscribeFromNotification().

[virtual] QStringList QSqlDriver::tables(QSql::TableType tableType) const

Возвращает список имён таблиц в базе данных. По умолчанию возвращает пустой список.

Аргумент tableType описывает, какие типы таблиц должны быть возвращены. Из-за бинарной совместимости строка содержит значение перечисления QSql::TableTypes в виде текста. Для обратной совместимости пустая строка должна обрабатываться как QSql::Tables.

[virtual] bool QSqlDriver::unsubscribeFromNotification(const QString &name)

Эта функция вызывается для отписки от уведомлений о событиях из базы данных. name идентифицирует уведомление о событии.

В случае успеха возвращает true, в противном случае — false.

База данных должна быть открыта при вызове этой функции. Все подписанные уведомления о событиях автоматически отписываются при вызове функции close().

После вызова этой функции сигнал notification() больше не будет генерироваться, когда база данных публикует уведомление о событии, идентифицированное по name.

Переопределите эту функцию, если хотите добавить поддержку уведомлений о событиях в свой подкласс QSqlDriver.

Эта функция была добавлена в Qt 4.4.

См. также subscribeToNotification() и subscribedToNotifications().