説明

<command>GET DESCRIPTOR</command> retrieves information about a query result set from an SQL descriptor area and stores it into host variables. A descriptor area is typically populated using <command>FETCH</command> or <command>SELECT</command> before using this command to transfer the information into host language variables. GET DESCRIPTORはSQL記述子領域から問い合わせ結果セットに関する情報を取り出し、それをホスト変数に格納します。 記述子領域は通常、このコマンドを使用してホスト言語変数に情報を転送する前に、FETCHまたはSELECTを用いて値が投入されます。

This command has two forms: The first form retrieves descriptor <quote>header</quote> items, which apply to the result set in its entirety. One example is the row count. The second form, which requires the column number as additional parameter, retrieves information about a particular column. Examples are the column name and the actual column value. このコマンドには２つの構文があります。 １番目の構文では、そのまま結果セットに適用されている記述子の「ヘッダ」項目を取り出します。 行数が１つの例です。 列番号を追加のパラメータとして必要とする２番目の構文では特定の列に関する情報を取り出します。 例えば、列名と列の実際の値です。

パラメータ

例

An example to retrieve the number of columns in a result set: この例は結果セット内の列数を取り出します。

EXEC SQL GET DESCRIPTOR d :d_count = COUNT;

An example to retrieve a data length in the first column: この例は最初の列のデータ長を取り出します。

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

An example to retrieve the data body of the second column as a string: この例は、２番目の列のデータ本体を文字列として取り出します。

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

Here is an example for a whole procedure of executing <literal>SELECT current_database();</literal> and showing the number of columns, the column data length, and the column 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;


    /* Declare, open a cursor, and assign a descriptor to the cursor  */

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


    /* Get a number of total columns */

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


    /* Get length of a returned column */

    /* 返された列の長さを得る */
    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);


    /* Fetch the returned column as a string */

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


    /* Closing */

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

    EXEC SQL DEALLOCATE DESCRIPTOR d;
    EXEC SQL DISCONNECT ALL;

    return 0;
}

When the example is executed, the result will look like this: この例を実行すると、結果は以下のようになります。

d_count                 = 1
d_returned_octet_length = 6
d_data                  = testdb

互換性

<command>GET DESCRIPTOR</command> is specified in the SQL standard. GET DESCRIPTORは標準SQLで規定されています。

関連項目