SPI_cursor_open
SPI_cursor_open — открыть курсор для оператора, созданного функцией SPI_prepare
Синтаксис
Portal SPI_cursor_open(const char *name
, SPIPlanPtrplan
, Datum *values
, const char *nulls
, boolread_only
)
Описание
SPI_cursor_open
открывает курсор (внутри называемый порталом), через который будет выполняться оператор, подготовленный функцией SPI_prepare
. Параметры этой функции имеют тот же смысл, что и соответствующие параметры SPI_execute_plan
.
Применение курсора по сравнению с непосредственным выполнением оператора даёт двойную выгоду. Во-первых, строки результата можно получать в небольших количествах, без риска исчерпать всю память при выполнении запросов, возвращающих много строк. Во-вторых, портал может существовать и после завершения текущей процедуры (на самом деле он может просуществовать до конца текущей транзакции). Возвратив имя портала в код, вызывающий процедуру, можно организовать выдачу результата в виде набора строк.
Переданные значения параметров копируются в портал курсора, так что их можно освободить и во время существования курсора.
Аргументы
const char *
name
имя портала, либо
NULL
, чтобы имя выбрала системаSPIPlanPtr
plan
подготовленный оператор (возвращаемый функцией
SPI_prepare
)Datum *
values
Массив фактических значений параметров. Его размер должен равняться числу аргументов оператора.
const char *
nulls
Массив, описывающий, в каких параметрах передаётся NULL. Должен иметь размер, равный числу аргументов оператора.
Если в
nulls
передаётсяNULL
,SPI_cursor_open
считает, что ни один из параметров не равен NULL. В противном случае элемент массиваnulls
должен содержать' '
, если значение соответствующего параметра не NULL, либо'n'
, если это значение — NULL. (В последнем случае значение, переданное в соответствующем элементеvalues
, не учитывается.) Заметьте, чтоnulls
— это не текстовая строка, а просто массив: ноль ('\0'
) в конце не нужен.bool
read_only
true
для режима выполнения «только чтение»
Возвращаемое значение
Указатель на портал, содержащий курсор. Заметьте, что соглашение о возврате ошибок отсутствует; все ошибки выдаются через elog
.
SPI_cursor_open
SPI_cursor_open — set up a cursor using a statement created with SPI_prepare
Synopsis
Portal SPI_cursor_open(const char *name
, SPIPlanPtrplan
, Datum *values
, const char *nulls
, boolread_only
)
Description
SPI_cursor_open
sets up a cursor (internally, a portal) that will execute a statement prepared by SPI_prepare
. The parameters have the same meanings as the corresponding parameters to SPI_execute_plan
.
Using a cursor instead of executing the statement directly has two benefits. First, the result rows can be retrieved a few at a time, avoiding memory overrun for queries that return many rows. Second, a portal can outlive the current procedure (it can, in fact, live to the end of the current transaction). Returning the portal name to the procedure's caller provides a way of returning a row set as result.
The passed-in parameter data will be copied into the cursor's portal, so it can be freed while the cursor still exists.
Arguments
const char *
name
name for portal, or
NULL
to let the system select a nameSPIPlanPtr
plan
prepared statement (returned by
SPI_prepare
)Datum *
values
An array of actual parameter values. Must have same length as the statement's number of arguments.
const char *
nulls
An array describing which parameters are null. Must have same length as the statement's number of arguments.
If
nulls
isNULL
thenSPI_cursor_open
assumes that no parameters are null. Otherwise, each entry of thenulls
array should be' '
if the corresponding parameter value is non-null, or'n'
if the corresponding parameter value is null. (In the latter case, the actual value in the correspondingvalues
entry doesn't matter.) Note thatnulls
is not a text string, just an array: it does not need a'\0'
terminator.bool
read_only
true
for read-only execution
Return Value
Pointer to portal containing the cursor. Note there is no error return convention; any error will be reported via elog
.