SPI_is_cursor_plan — SPI_prepare
で準備された文がSPI_cursor_open
で使用できる場合にtrue
を返す
bool SPI_is_cursor_plan(SPIPlanPtr plan
)
SPI_prepare
で準備済み文がSPI_cursor_open
への引数として渡すことができる場合、SPI_is_cursor_plan
はtrue
を返します。
渡すことができない場合はfalse
を返します。
この基準は、plan
が単一のコマンドであり、かつ、そのコマンドが呼び出し元にタプルを返すことです。
例えば、INTO
句を含んでいないSELECT
は可能です。
そして、RETURNING
句を含む場合のみUPDATE
も可能です。
SPIPlanPtr plan
(SPI_prepare
で返される)準備済み文
plan
がカーソルを生成することができるかどうかを示すtrue
もしくはfalse
です。
そしてSPI_result
をゼロに設定します。
解答を決定することができない場合(例えばplan
がNULL
、または無効な場合、もしくはSPI未接続時に呼び出された場合)はSPI_result
に適切なエラーコードが設定され、false
が返されます。