pg_describe_cursor
Prev | 4.3.Query Execution Commands | Next

## pg_describe_cursor

pg_describe_cursor — 遊走子(玄関口)に関する情報を得る Get information about a cursor (portal)

## 構文 Synopsis

    pg_describe_cursor conn cursorName

## 説明 Description

`pg_describe_cursor` は開扉遊走子(又は､玄関口､ PostgreSQL 説明書に使われた用語)に関する情報を得る｡遊走子は SQL DECLARE 命令によって生成される｡結果の構造が返される｡ pg_result により遊走子に関する情報を得る為に結果の構造が返される｡ `pg_describe_cursor` gets information about an open cursor (or portal, the term used by the PostgreSQL documentation). A cursor is created with the SQL DECLARE command. A result structure is returned, for use with pg_result to get information about the cursor.

## 引数 Arguments

`conn`

  遊走子が開かれる接続の把持子｡ The handle of the connection on which the cursor is open.

`cursorName`

  情報を得るべき遊走子の名前｡ 　 The name of the cursor to get information about.

## 返される値 Return Value

pg_result を使って遊走子に関する情報を得るべぎ結果の把持子を返す｡ Returns a result handle which can be used with pg_result to obtain information about the cursor.

## 註意 Notes

成功すると､ PGRES_COMMAND_OK の状態をを有する結果の構造を返す｡結果の構造はデータの行を全く有さず､属性(列)情報のみを有する｡もし､この様な遊走子がない場合､結果の構造は PGRES_FATAL_ERROR [譯註 致命的不都合]を有する｡その他の不都合状態では Tcl 不都合が発せられるかもしれない｡ On success, a result structure which has status `PGRES_COMMAND_OK` will be returned. The result structure will have no data rows, only attribute (column) information. If no such cursor exists, the result structure will have status `PGRES_FATAL_ERROR`. A Tcl error may be thrown under other error conditions.

返された結果の構造から情報を得る為には pg_result を使われたい､又､完了した後は pg_result -clear によって結果の把持子を解放することを確認されたい｡ Use pg_result to get information from the returned result structure, and be sure to free the returned result handle with `pg_result -clear` when you are done with it.

この命令は PostgreSQL libpq function PQdescribePrepared を使うか模擬する｡ This command uses or emulates the PostgreSQL libpq function `PQdescribePortal`.

この命令は pgtclng-1.7.0 と pgintcl-3.1.0 に追加された｡ This command was added in pgtclng-1.7.0 and in pgintcl-3.1.0.

## 用例 Example

遊走子を宣言しその列の名前を得る｡ 　 Declare a cursor and get the names of its columns:

    pg_execute $conn "DECLARE mycursor CURSOR FOR SELECT * FROM mytable"
    set result [pg_describe_cursor $conn mycursor]
    if {[pg_result $result -status] eq "PGRES_COMMAND_OK"} {
      puts "Cursor columns are: [pg_result $result -attributes]"
    }

Prev | Up | Next
pg_exec_prepared | Home | pg_describe_prepared