SPI_is_cursor_plan

名前

SPI_is_cursor_plan -- SPI_prepareで準備された計画がSPI_cursor_openで使用できる場合にtrueを返す

概要

bool SPI_is_cursor_plan(void * plan)

説明

SPI_prepareで準備された計画がSPI_cursor_openへの引数として渡すことができる場合、SPI_is_cursor_plantrueを返します。 渡すことができない場合はfalseを返します。 この基準は、planが単一のコマンドであり、かつ、そのコマンドが呼び出し元にタプルを返すことです。 たとえば、INTO句を含んでいないSELECTは可能です。 そして、RETURNING句を含む場合のみUPDATEも可能です。

引数

void * plan

SPI_prepareで返される)実行計画です。

戻り値

planがカーソルを生成することができるかどうかを示すtrueもしくは falseです。 planNULLの場合はSPI_ERROR_ARGUMENTが返ります。