PostgreSQL 9.1.1文書
前のページ | 巻戻し |  | 早送り | 次のページ

# 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`が返されます。

前のページ | ホーム | 次のページ
SPI_getargtypeid | 上に戻る | SPI_execute_plan