Класс QSqlResult

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

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

Открытые функции

Защищенные типы

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

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

Обычно используется QSqlQuery, а не QSqlResult, так как QSqlQuery предоставляет оболочку для конкретных реализаций баз данных QSqlResult.

Если вы реализуете собственный драйвер SQL (наследуясь от QSqlDriver), вам нужно предоставить свой подкласс QSqlResult, который реализует все чистые виртуальные функции и другие виртуальные функции, которые вам нужны.

См. также QSqlDriver.

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

перечисление QSqlResult::BindingSyntax

Этот тип перечисления определяет различные синтаксисы для указания маркеров в подготовленных запросах.

См. также 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 в текущей записи (строке).

Примечание: Связывание неопределённого 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] QVector<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: в режиме только для чтения, дескриптор QSqlResult может измениться после вызова fetch(), fetchFirst(), fetchLast(), fetchNext(), fetchPrevious(), nextResult().

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

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

QSqlQuery query = ...
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)

Подготавливает заданный 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)

Подготавливает заданный 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. Если forward истинно, разрешён только fetchNext() для навигации по результатам. Режим только для вперёд требует гораздо меньше памяти, так как результаты не должны кешироваться. По умолчанию эта функция отключена.

Установка режима только для вперёд в ложное значение является рекомендацией для движка базы данных, который имеет последнее слово в отношении того, является ли результат набора только для вперёд или прокручиваемым. 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 должен быть истинным, если оператор является SELECT оператором; в противном случае он должен быть ложным.

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

[pure virtual protected] int QSqlResult::size()

Возвращает размер SELECT результата или -1, если его невозможно определить или если запрос не является SELECT оператором.

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