Класс 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, или недействительный вариант, если ручки нет.

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

В этом примере извлекается ручка для подключения к 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().