SPI_is_cursor_plan#
SPI_is_cursor_plan
SPI_is_cursor_plan — возвращает true
, если оператор,
подготовленный с помощью функции SPI_prepare
, может быть использован с
функцией SPI_cursor_open
Синтаксис
bool SPI_is_cursor_plan(SPIPlanPtr plan
)
Описание
SPI_is_cursor_plan
возвращает true
,
если оператор, подготовленный с помощью SPI_prepare
, может быть передан
в качестве аргумента в SPI_cursor_open
, или
false
, если это не так. Критерии состоят в том, что
plan
представляет собой одну отдельную команду и что эта
команда возвращает кортежи вызывающей стороне; например, разрешается использование SELECT
,
если он не содержит предложения INTO
, и
разрешается использование UPDATE
только если он содержит предложение RETURNING
.
Аргументы
SPIPlanPtr
plan
подготовленный оператор (возвращаемое функцией
SPI_prepare
)
Возвращаемое значение
true
или false
для указания, может ли plan
создать курсор или нет, с SPI_result
установленным в ноль.
Если невозможно определить ответ (например, если plan
равен NULL
или недопустим, или если вызывается, когда нет подключения к SPI), то SPI_result
устанавливается в соответствующий код ошибки, и возвращается false
.