★PostgreSQLカンファレンス2024 12月6日開催/チケット販売中★
他のバージョンの文書 16 | 15 | 14 | 13 | 12 | 11 | 10 | 9.6 | 9.5 | 9.4 | 9.3 | 9.2 | 9.1 | 9.0 | 8.4 | 8.3 | 8.2 | 8.1 | 8.0 | 7.4 | 7.3 | 7.2

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_plantrueを返します。 渡すことができない場合はfalseを返します。 この基準は、planが単一のコマンドであり、かつ、そのコマンドが呼び出し元にタプルを返すことです。 例えば、INTO句を含んでいないSELECTは可能です。 そして、RETURNING句を含む場合のみUPDATEも可能です。

引数

SPIPlanPtr plan

SPI_prepareで返される)準備済み文

戻り値

planがカーソルを生成することができるかどうかを示すtrueもしくはfalseです。 そしてSPI_resultをゼロに設定します。 解答を決定することができない場合(例えばplanNULL、または無効な場合、もしくはSPI未接続時に呼び出された場合)はSPI_resultに適切なエラーコードが設定され、falseが返されます。