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

## pg_describe_prepared

pg_describe_prepared — 準備された宣言文について情報を得る Get information about a prepared statement

## 構文 Synopsis

    pg_describe_prepared conn statementName

## 説明 Description

`pg_describe_prepared` は準備された宣言文について情報を得る｡準備された宣言文は SQL PREPARE によって生成される｡結果の構造は､準備された宣言文について情報を得る為に pg_resultと伴に使う為に､返される｡ `pg_describe_prepared` gets information about a prepared statement. A prepared statement is created with the SQL PREPARE command. A result structure is returned, for use with pg_result to get information about the prepared statement.

## 引数 Arguments

`conn`

  準備された宣言文が定義される接続の把持子｡ The handle of the connection on which the prepared statement is defined.

`statementName`

  情報を得るべき準備された宣言文の名前｡ The name of the prepared statement to get information about.

## 返り値 Return Value

pg_result によって情報を得るべき準備された宣言文の把持子を返す｡ Returns a result handle which can be used with pg_result to obtain information about the prepared statement.

## 註意 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, and parameter information. If no such prepared statement 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` によって結果の把持子を解放することを確認されたい｡準備された宣言文の媒介変数に関する情報を得るには pg_result 指示項目 `-numParams` と `-paramTypes` を使われたい｡ 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. To get information about the prepared statement's parameters, use the pg_result options `-numParams` and `-paramTypes`.

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

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

## 用例 Example

準備された宣言文を生成し､その結果の列とその媒介変数に関する情報を得る｡ Create a prepared statement, and get information about its result columns and its parameters:

    pg_execute $conn "PREPARE myst AS SELECT * FROM mytable \
        WHERE key BETWEEN \$1 AND \$2"
    set result [pg_describe_prepared $conn myst]
    if {[pg_result $result -status] eq "PGRES_COMMAND_OK"} {
      puts "Prepared statement columns are: [pg_result $result -attributes]"
      puts "Prepared statement has [pg_result $result -numParams] parameters."
      puts "Prepared statement parameter types: [pg_result $result -paramTypes]"
    }

Prev | Up | Next
pg_describe_cursor | Home | pg_result