Redrock Postgres 搜索 英文
版本: 9.3 / 9.4 / 9.5 / 9.6 / 10 / 11 / 12 / 13 / 14 / 15 / 16 / 17 / 18

SPI_is_cursor_plan

SPI_is_cursor_plan — 如果由 SPI_prepare 准备的语句可用于 SPI_cursor_open 则返回 true

Synopsis

bool SPI_is_cursor_plan(SPIPlanPtr plan)

描述

如果由 SPI_prepare 准备的语句可以作为参数传给 SPI_cursor_open,则 SPI_is_cursor_plan 返回 true; 否则返回 false。判定标准是 plan 必须表示单条命令,并且该命令会向调用者返 回元组。例如,不包含 INTO 子句的 SELECT 是允许的,而 UPDATE 只 有包含 RETURNING 子句时才允许。

参数

SPIPlanPtr plan

预备语句(由SPI_prepare返回)

返回值

如果 plan 能产生游标,则返回 true;如果不能,则返回 false,并将 SPI_result 设为零。如果无法确定答案(例如 planNULL 或无效,或者在 未连接到 SPI 时调用),则会将 SPI_result 设为合适 的错误码,并返回 false