Класс QSqlResult
Класс QSqlResult предоставляет абстрактный интерфейс для доступа к данным из конкретных баз данных SQL. Подробнее...
| Заголовок: | #include <QSqlResult> |
| CMake: | find_package(Qt6 COMPONENTS Sql REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Sql) |
| qmake: | QT += sql |
Открытые функции
| virtual | ~QSqlResult() |
| virtual QVariant | handle() const |
Защищенные типы
| Перечисление | BindingSyntax { PositionalBinding, NamedBinding } |
Защищенные функции
| QSqlResult(const QSqlDriver *db) | |
| void | addBindValue(const QVariant &val, QSql::ParamType paramType) |
| int | at() const |
| virtual void | bindValue(int index, const QVariant &val, QSql::ParamType paramType) |
| virtual void | bindValue(const QString &placeholder, const QVariant &val, QSql::ParamType paramType) |
| QSql::ParamType | bindValueType(int index) const |
| QSql::ParamType | bindValueType(const QString &placeholder) const |
| QSqlResult::BindingSyntax | bindingSyntax() const |
| QVariant | boundValue(int index) const |
| QVariant | boundValue(const QString &placeholder) const |
| int | boundValueCount() const |
| QString | boundValueName(int index) const |
| QList<QVariant> & | boundValues() const |
| void | clear() |
| virtual QVariant | data(int index) = 0 |
| const QSqlDriver * | driver() const |
| virtual bool | exec() |
| QString | executedQuery() const |
| virtual bool | fetch(int index) = 0 |
| virtual bool | fetchFirst() = 0 |
| virtual bool | fetchLast() = 0 |
| virtual bool | fetchNext() |
| virtual bool | fetchPrevious() |
| bool | hasOutValues() const |
| bool | isActive() const |
| bool | isForwardOnly() const |
| virtual bool | isNull(int index) = 0 |
| bool | isSelect() const |
| bool | isValid() const |
| QSqlError | lastError() const |
| virtual QVariant | lastInsertId() const |
| QString | lastQuery() const |
| virtual int | numRowsAffected() = 0 |
| virtual bool | prepare(const QString &query) |
| virtual QSqlRecord | record() const |
| virtual bool | reset(const QString &query) = 0 |
| void | resetBindCount() |
| virtual bool | savePrepare(const QString &query) |
| virtual void | setActive(bool active) |
| virtual void | setAt(int index) |
| virtual void | setForwardOnly(bool forward) |
| virtual void | setLastError(const QSqlError &error) |
| virtual void | setQuery(const QString &query) |
| virtual void | setSelect(bool select) |
| virtual int | size() = 0 |
Подробное описание
Обычно, вместо QSqlResult используется QSqlQuery, так как QSqlQuery предоставляет оболочку для баз данных, реализующих QSqlResult.
Если вы реализуете собственный драйвер SQL (наследуя QSqlDriver), вам потребуется предоставить собственный подкласс QSqlResult, который реализует все чисто виртуальные функции и другие необходимые виртуальные функции.
См. также QSqlDriver.
Документация по типам членов
Перечисление QSqlResult::BindingSyntax
Это перечисление определяет различные синтаксисы для указания заглушек в подготовленных запросах.
| Постоянная | Значение | Описание |
|---|---|---|
QSqlResult::PositionalBinding |
0 |
Используйте синтаксис позиционных заглушек в стиле ODBC, с "?" в качестве заглушек. |
QSqlResult::NamedBinding |
1 |
Используйте синтаксис в стиле Oracle с именованными заглушками (например, ":id") |
См. также bindingSyntax().
Документация по функциям-членам
[protected] QSqlResult::QSqlResult(const QSqlDriver *db)
Создаёт QSqlResult с использованием драйвера базы данных db. Объект инициализируется в неактивном состоянии.
См. также isActive() и driver().
[virtual] QSqlResult::~QSqlResult()
Уничтожает объект и освобождает все выделенные ресурсы.
[protected] void QSqlResult::addBindValue(const QVariant &val, QSql::ParamType paramType)
Связывает значение val типа параметра paramType с ближайшей доступной позицией в текущей записи (строке).
См. также bindValue().
[protected] int QSqlResult::at() const
Возвращает текущую (нумерованную с нуля) позицию строки результата. Может возвращать специальные значения QSql::BeforeFirstRow или QSql::AfterLastRow.
См. также setAt() и isValid().
[virtual protected] void QSqlResult::bindValue(int index, const QVariant &val, QSql::ParamType paramType)
Связывает значение val типа параметра paramType с позицией index в текущей записи (строке).
См. также addBindValue().
[virtual protected] void QSqlResult::bindValue(const QString &placeholder, const QVariant &val, QSql::ParamType paramType)
Это перегруженный метод.
Связывает значение val типа параметра paramType с именем placeholder в текущей записи (строке).
Примечание: Связывание неопределённого плейсхолдера приведёт к неопределённому поведению.
См. также QSqlQuery::bindValue().
[protected] QSql::ParamType QSqlResult::bindValueType(int index) const
Возвращает тип параметра для значения, связанного с позицией index.
См. также boundValue().
[protected] QSql::ParamType QSqlResult::bindValueType(const QString &placeholder) const
Это перегруженный метод.
Возвращает тип параметра для значения, связанного с заданным именем placeholder.
[protected] QSqlResult::BindingSyntax QSqlResult::bindingSyntax() const
Возвращает синтаксис связывания, используемый подготовленными запросами.
[protected] QVariant QSqlResult::boundValue(int index) const
Возвращает значение, связанное с позицией index в текущей записи (строке).
См. также bindValue() и boundValues().
[protected] QVariant QSqlResult::boundValue(const QString &placeholder) const
Это перегруженный метод.
Возвращает значение, связанное с заданным именем placeholder в текущей записи (строке).
См. также bindValueType().
[protected] int QSqlResult::boundValueCount() const
Возвращает количество связанных значений в результате.
См. также boundValues().
[protected] QString QSqlResult::boundValueName(int index) const
Возвращает имя связанного значения по позиции index в текущей записи (строке).
См. также boundValue().
[protected] QList<QVariant> &QSqlResult::boundValues() const
Возвращает список связанных значений результата для текущей записи (строки).
См. также boundValueCount().
[protected] void QSqlResult::clear()
Очищает весь набор результатов и освобождает все связанные ресурсы.
[pure virtual protected] QVariant QSqlResult::data(int index)
Возвращает данные для поля index в текущей строке в виде QVariant. Эта функция вызывается только если результат в активном состоянии, находится на корректной записи и index неотрицательное. Производные классы должны переопределять эту функцию и возвращать значение поля index или QVariant(), если значение определить невозможно.
[protected] const QSqlDriver *QSqlResult::driver() const
Возвращает драйвер, связанный с результатом. Это объект, переданный в конструктор.
[virtual protected] bool QSqlResult::exec()
Выполняет запрос, возвращая true, если успешно; иначе возвращает false.
См. также prepare().
[protected] QString QSqlResult::executedQuery() const
Возвращает запрос, который был фактически выполнен. Он может отличаться от запроса, который был передан, например, если были использованы связанные значения с подготовленным запросом и базу данных не поддерживает подготовленные запросы.
См. также exec() и setQuery().
[pure virtual protected] bool QSqlResult::fetch(int index)
Перемещает результат на произвольную (нумерованную с нуля) строку index.
Эта функция вызывается только если результат в активном состоянии. Производные классы должны переопределить эту функцию и установить результат на строку index, и вызвать setAt() с соответствующим значением. Вернуть true для обозначения успеха, или false для обозначения неудачи.
См. также isActive(), fetchFirst(), fetchLast(), fetchNext() и fetchPrevious().
[pure virtual protected] bool QSqlResult::fetchFirst()
Перемещает результат на первую запись (строка 0) в результате.
Эта функция вызывается только если результат в активном состоянии. Производные классы должны переопределить эту функцию и установить результат на первую запись, и вызвать setAt() с соответствующим значением. Вернуть true для обозначения успеха, или false для обозначения неудачи.
См. также fetch() и fetchLast().
[pure virtual protected] bool QSqlResult::fetchLast()
Перемещает результат на последнюю запись (последняя строка) в результате.
Эта функция вызывается только если результат в активном состоянии. Производные классы должны переопределить эту функцию и установить результат на последнюю запись, и вызвать setAt() с соответствующим значением. Вернуть true для обозначения успеха, или false для обозначения неудачи.
См. также fetch() и fetchFirst().
[virtual protected] bool QSqlResult::fetchNext()
Перемещает результат на следующую доступную запись (строку) в результате.
Эта функция вызывается только если результат в активном состоянии. Стандартная реализация вызывает fetch() со следующим индексом. Производные классы могут переопределить эту функцию и установить результат на следующую запись каким-либо другим способом, и вызвать setAt() с соответствующим значением. Вернуть true для обозначения успеха, или false для обозначения неудачи.
См. также fetch() и fetchPrevious().
[virtual protected] bool QSqlResult::fetchPrevious()
Перемещает результат на предыдущую запись (строку) в результате.
Эта функция вызывается только если результат в активном состоянии. Стандартная реализация вызывает fetch() с предыдущим индексом. Производные классы могут переопределить эту функцию и установить результат на предыдущую запись каким-либо другим способом, и вызвать setAt() с соответствующим значением. Вернуть true для обозначения успеха, или false для обозначения неудачи.
[virtual] QVariant QSqlResult::handle() const
Возвращает низкоуровневую ручку базы данных для этого набора результатов, обернутую в QVariant, или некорректный QVariant, если ручка отсутствует.
Предупреждение: Используйте с большой осторожностью и только если вы знаете, что делаете.
Предупреждение: Возвращённая ручка может стать устаревшей ссылкой, если результат был изменён (например, если вы очистили его).
Предупреждение: Ручка может быть NULL, если результат ещё не был выполнен.
Предупреждение: PostgreSQL: в режиме только вперед (forward-only) дескриптор QSqlResult может измениться после вызова fetch(), fetchFirst(), fetchLast(), fetchNext(), fetchPrevious(), nextResult().
Возвращаемый здесь дескриптор зависит от базы данных, перед доступом к нему необходимо проверить тип значения.
В этом примере извлекается дескриптор для результата sqlite:
QSqlDatabase db = QSqlDatabase::database("sales");
QSqlQuery query("SELECT NAME, DOB FROM EMPLOYEES", db);
QVariant v = query.result()->handle();
if (v.isValid() && qstrcmp(v.typeName(), "sqlite3_stmt*") == 0) {
// v.data() returns a pointer to the handle
sqlite3_stmt *handle = *static_cast<sqlite3_stmt **>(v.data());
if (handle) {
// ...
}
} Этот фрагмент возвращает дескриптор для PostgreSQL или MySQL:
if (qstrcmp(v.typeName(), "PGresult*") == 0) {
PGresult *handle = *static_cast<PGresult **>(v.data());
if (handle) {
// ...
}
}
if (qstrcmp(v.typeName(), "MYSQL_STMT*") == 0) {
MYSQL_STMT *handle = *static_cast<MYSQL_STMT **>(v.data());
if (handle) {
// ...
}
} См. также QSqlDriver::handle().
[protected] bool QSqlResult::hasOutValues() const
Возвращает true , если хотя бы одно из связанных значений запроса является QSql::Out или QSql::InOut; в противном случае возвращает false.
См. также bindValueType().
[protected] bool QSqlResult::isActive() const
Возвращает true , если результат содержит записи для извлечения; в противном случае возвращает false.
[protected] bool QSqlResult::isForwardOnly() const
Возвращает true , если можно прокручивать результат только вперед; в противном случае возвращает false.
См. также setForwardOnly().
[pure virtual protected] bool QSqlResult::isNull(int index)
Возвращает true , если поле в позиции index в текущей строке имеет значение NULL; в противном случае возвращает false.
[protected] bool QSqlResult::isSelect() const
Возвращает true , если текущий результат получен из SELECT оператора; в противном случае возвращает false.
См. также setSelect().
[protected] bool QSqlResult::isValid() const
Возвращает true , если результат находится на допустимой записи (т.е. результат не находится перед первой или после последней записью); в противном случае возвращает false.
См. также at().
[protected] QSqlError QSqlResult::lastError() const
Возвращает последнюю ошибку, связанную с результатом.
См. также setLastError().
[virtual protected] QVariant QSqlResult::lastInsertId() const
Возвращает идентификатор объекта последней вставленной строки, если база данных его поддерживает. Недействительный QVariant будет возвращен, если запрос не вставил значение или если база данных не сообщает об идентификаторе. Если одной операцией вставки затронуто несколько строк, поведение не определено.
Обратите внимание, что для баз данных Oracle будет возвращен ROWID строки, а для баз данных MySQL - поле автоинкремента строки.
См. также QSqlDriver::hasFeature().
[protected] QString QSqlResult::lastQuery() const
Возвращает текущий текст SQL-запроса или пустую строку, если его нет.
См. также setQuery().
[pure virtual protected] int QSqlResult::numRowsAffected()
Возвращает количество строк, затронутых последним выполненным запросом, или -1, если это невозможно определить или если запрос является SELECT оператором.
См. также size().
[virtual protected] bool QSqlResult::prepare(const QString &query)
Подготавливает заданный запрос к выполнению; запрос обычно использует плейсхолдеры, чтобы его можно было выполнять повторно. Возвращает true, если запрос успешно подготовлен; в противном случае возвращает false.
См. также exec().
[virtual protected] QSqlRecord QSqlResult::record() const
Возвращает текущую запись, если запрос активен; в противном случае возвращает пустую QSqlRecord.
Реализация по умолчанию всегда возвращает пустую QSqlRecord.
См. также isActive().
[pure virtual protected] bool QSqlResult::reset(const QString &query)
Устанавливает результат для использования SQL-запроса query для последующего извлечения данных.
Производные классы должны переопределить эту функцию и применить query к базе данных. Эта функция вызывается только после того, как результат установлен в неактивное состояние и расположен перед первой записью нового результата. Производные классы должны возвращать true, если запрос выполнился успешно и готов к использованию, или false в противном случае.
См. также setQuery().
[protected] void QSqlResult::resetBindCount()
Сбрасывает количество параметров связывания.
[virtual protected] bool QSqlResult::savePrepare(const QString &query)
Подготавливает заданный запрос, используя функциональность базовой базы данных по возможности. Возвращает true , если запрос успешно подготовлен; в противном случае возвращает false.
Примечание: Этот метод должен был называться «safePrepare».
См. также prepare().
[virtual protected] void QSqlResult::setActive(bool active)
Эта функция предназначена для производных классов для установки внутреннего активного состояния в active.
См. также isActive().
[virtual protected] void QSqlResult::setAt(int index)
Эта функция предназначена для производных классов для установки внутреннего (нулевого) индекса строки в index.
См. также at().
[virtual protected] void QSqlResult::setForwardOnly(bool forward)
Устанавливает режим только вперед (forward only) в forward. Если forward равно true, для навигации по результатам разрешен только fetchNext(). Режим только вперед требует значительно меньше памяти, так как результаты не нужно кэшировать. По умолчанию эта функция отключена.
Установка forward only в false — это рекомендация для движка базы данных, который в конечном счете решает, является ли набор результатов только вперед или прокручиваемым. isForwardOnly() всегда возвращает правильный статус набора результатов.
Примечание: Вызов setForwardOnly после выполнения запроса приведет к неожиданным результатам в лучшем случае и к сбоям в худшем.
Примечание: Чтобы убедиться, что запрос с только вперед завершился успешно, приложение должно проверять lastError() не только после выполнения запроса, но и после навигации по результатам запроса.
Предупреждение: PostgreSQL: во время навигации по результатам запроса в режиме только вперед не выполняйте другие SQL-команды в той же соединении с базой данных. Это приведет к потере результатов запроса.
См. также isForwardOnly(), fetchNext(), и QSqlQuery::setForwardOnly().
[virtual protected] void QSqlResult::setLastError(const QSqlError &error)
Эта функция предназначена для производных классов для установки последней ошибки в error.
См. также lastError().
[virtual protected] void QSqlResult::setQuery(const QString &query)
Устанавливает текущий запрос для результата на query. Вам необходимо вызвать reset() для выполнения запроса в базе данных.
См. также reset() и lastQuery().
[virtual protected] void QSqlResult::setSelect(bool select)
Эта функция предназначена для производных классов, чтобы указать, является ли текущий оператор SQL SELECT оператором. Параметр select должен быть true, если оператор является SELECT оператором; в противном случае он должен быть false.
См. также isSelect().
[pure virtual protected] int QSqlResult::size()
Возвращает размер SELECT результата или -1, если это невозможно определить или если запрос не является SELECT оператором.
См. также numRowsAffected().
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-6.2/qsqlresult.html