SPI_cursor_open_with_paramlist#

SPI_cursor_open_with_paramlist

SPI_cursor_open_with_paramlist

SPI_cursor_open_with_paramlist — настройка курсора с использованием параметров

Синтаксис

Portal SPI_cursor_open_with_paramlist(const char *name,
                                      SPIPlanPtr plan,
                                      ParamListInfo params,
                                      bool read_only)

Описание

SPI_cursor_open_with_paramlist настраивает курсор (внутренне, портал), который будет выполнять оператор, подготовленный с помощью SPI_prepare. Эта функция эквивалентна функции SPI_cursor_open, за исключением того, что информация о значениях параметров, которые будут переданы в запрос, представлена по-другому. Представление ParamListInfo может быть удобным для передачи значений, которые уже доступны в этом формате. Оно также поддерживает использование динамических наборов параметров с помощью функций-перехватчиков, указанных в ParamListInfo.

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

Аргументы

const char * name

имя портала или NULL для того, чтобы система выбрала имя

SPIPlanPtr plan

подготовленный оператор (возвращаемое функцией SPI_prepare)

ParamListInfo params

структура данных, содержащая типы параметров и их значения; NULL, если нет

bool read_only

true для выполнения только для чтения

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

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