Класс QSqlDriver

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

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

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

Функции публичного доступа

Сигналы

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

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

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

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

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

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

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

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

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

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

перечисление QSqlDriver::IdentifierType

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

перечисление QSqlDriver::NotificationSource

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

перечисление QSqlDriver::StatementType

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

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

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

QSqlDriver::QSqlDriver(QObject *parent = nullptr)

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

Уведомлениеvoid QSqlDriver::notification(const QString &name, QSqlDriver::NotificationSource source, const QVariant &payload)

Этот сигнал испускается, когда база данных публикует уведомление о событии, на которое драйвер подписан. name идентифицирует уведомление о событии, source указывает источник сигнала, 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().

[virtual, since 6.0] int QSqlDriver::maximumIdentifierLength(QSqlDriver::IdentifierType type) const

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

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

QSql::NumericalPrecisionPolicy QSqlDriver::numericalPrecisionPolicy() const

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

См. также 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 не влияет на активные запросы.

См. также 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 не равен ничему, даже самому себе, связывать NULL с плейсхолдером обычно не имеет смысла.

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

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

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

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

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

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

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

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

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

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

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

[virtual] QStringList QSqlDriver::subscribedToNotifications() const

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

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

См. также 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.

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