ДОКУМЕНТАЦИЯ

Выберите версию, форк и язык для СУБД Digital Q.DataBase, чтобы прочитать или скачать всю документацию.

Новости

01.09.2026

СУБД Digital Q.DataBase можно развернуть из готового Docker-образа

25.08.2026

СУБД Digital Q.DataBase: 8 ядер бесплатно — до 1 сентября!

Документация

Диасофт
Авторские права © 2016–2025 ООО "Диасофт Экосистема"

Скачать всю документацию:

pdf (13 mБ) EPUB (13 mБ) CHM (14 МБ)

5.10.1.21. SPI_cursor_parse_open

Содержание

5.10.1.21. SPI_cursor_parse_open

SPI_cursor_parse_open — создаёт курсор, используя строку запроса и параметры

Синтаксис

Portal SPI_cursor_parse_open(const char *name,
                             const char *command,
                             const SPIParseOpenOptions * options)

Описание

SPI_cursor_parse_open создаёт курсор (внутренне — портал), который будет выполнять указанную строку запроса. Это сопоставимо с SPI_prepare_cursor за которым следует SPI_cursor_open_with_paramlist, за исключением того, что ссылки на параметры внутри строки запроса обрабатываются исключительно путём передачи ParamListInfo объекта.

Для однократного выполнения запроса этой функции следует отдавать предпочтение перед SPI_prepare_cursor с последующим вызовом SPI_cursor_open_with_paramlist. Если одна и та же команда должна выполняться с множеством различных параметров, любой из методов может оказаться быстрее, в зависимости от стоимости перепланирования в сравнении с эффективностью специализированных планов.

Объект options->params обычно должен помечать каждый параметр флагом PARAM_FLAG_CONST , так как для запроса всегда используется одноразовый план.

Переданные данные параметров будут скопированы в портал курсора, поэтому их можно освободить, пока курсор всё ещё существует.

Аргументы

const char * name: имя портала или NULL чтобы позволить системе выбрать имя
const char * command: строка команды
const SPIParseOpenOptions * options: структура, содержащая необязательные аргументы

Вызывающие функции должны всегда полностью обнулять options структуру, а затем заполнять те поля, которые необходимо установить. Это обеспечивает прямую совместимость кода, так как любые поля, которые будут добавлены в структуру в будущем, будут вести себя обратно совместимым образом, если они равны нулю. Текущие доступные options поля:

ParamListInfo params: структура данных, содержащая типы и значения параметров запроса; NULL, если они отсутствуют
int cursorOptions: целочисленная битовая маска параметров курсора; ноль обеспечивает поведение по умолчанию
bool read_only: true для выполнения в режиме «только чтение»

Возвращаемое значение

Указатель на портал, содержащий курсор. Обратите внимание, что стандартное соглашение о возврате ошибок отсутствует; о любой ошибке будет сообщено через elog.

Наверх