[11/15開催: PostgreSQL Conference Japan 2019 参加受付中] 
他のバージョンの文書 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

GET DESCRIPTOR

GET DESCRIPTOR — SQL記述子領域から情報を入手します。

概要

GET DESCRIPTOR descriptor_name :cvariable = descriptor_header_item [, ... ]
GET DESCRIPTOR descriptor_name VALUE column_number :cvariable = descriptor_item [, ... ]

説明

GET DESCRIPTORはSQL記述子領域から問い合わせ結果セットに関する情報を取り出し、それをホスト変数に格納します。 記述子領域は通常、このコマンドを使用してホスト言語変数に情報を転送する前に、FETCHまたはSELECTを用いて値が投入されます。

このコマンドには2つの構文があります。 1番目の構文では、そのまま結果セットに適用されている記述子のヘッダ項目を取り出します。 行数が1つの例です。 列番号を追加のパラメータとして必要とする2番目の構文では特定の列に関する情報を取り出します。 例えば、列名と列の実際の値です。

パラメータ

descriptor_name

記述子の名前です。

descriptor_header_item

どのヘッダ情報を取り出すかを識別するトークンです。 結果セット内の列数を入手するCOUNTのみが現在サポートされています。

column_number

情報を取り出す列の番号です。 1から数えます。

descriptor_item

どの列に関する情報を取り出すかを識別するトークンです。 サポートされる項目のリストについては36.7.1を参照してください。

cvariable

記述子領域から取り出したデータを受け取るホスト変数です。

この例は結果セット内の列数を取り出します。

EXEC SQL GET DESCRIPTOR d :d_count = COUNT;

この例は最初の列のデータ長を取り出します。

EXEC SQL GET DESCRIPTOR d VALUE 1 :d_returned_octet_length = RETURNED_OCTET_LENGTH;

この例は、2番目の列のデータ本体を文字列として取り出します。

EXEC SQL GET DESCRIPTOR d VALUE 2 :d_data = DATA;

以下は、SELECT current_database();を実行し、列数、列のデータ長、列のデータを表示する手続き全体を示す例です。

int
main(void)
{
EXEC SQL BEGIN DECLARE SECTION;
    int  d_count;
    char d_data[1024];
    int  d_returned_octet_length;
EXEC SQL END DECLARE SECTION;

    EXEC SQL CONNECT TO testdb AS con1 USER testuser;
    EXEC SQL SELECT pg_catalog.set_config('search_path', '', false); EXEC SQL COMMIT;
    EXEC SQL ALLOCATE DESCRIPTOR d;


    /* カーソルを宣言して開いて、記述子をそのカーソルに割り当てる */
    EXEC SQL DECLARE cur CURSOR FOR SELECT current_database();
    EXEC SQL OPEN cur;
    EXEC SQL FETCH NEXT FROM cur INTO SQL DESCRIPTOR d;


    /* 全列数を得る */
    EXEC SQL GET DESCRIPTOR d :d_count = COUNT;
    printf("d_count                 = %d\n", d_count);


    /* 返された列の長さを得る */
    EXEC SQL GET DESCRIPTOR d VALUE 1 :d_returned_octet_length = RETURNED_OCTET_LENGTH;
    printf("d_returned_octet_length = %d\n", d_returned_octet_length);


    /* 返された列を文字列として取得する */
    EXEC SQL GET DESCRIPTOR d VALUE 1 :d_data = DATA;
    printf("d_data                  = %s\n", d_data);


    /* 閉じる */
    EXEC SQL CLOSE cur;
    EXEC SQL COMMIT;

    EXEC SQL DEALLOCATE DESCRIPTOR d;
    EXEC SQL DISCONNECT ALL;

    return 0;
}

この例を実行すると、結果は以下のようになります。

d_count                 = 1
d_returned_octet_length = 6
d_data                  = testdb

互換性

GET DESCRIPTORは標準SQLで規定されています。

関連項目

ALLOCATE DESCRIPTOR, SET DESCRIPTOR