SPI_is_cursor_plan
名前
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が返されます。