2025年9月25日: PostgreSQL 18 釋出!
支援版本: 當前 (18) / 17 / 16 / 15 / 14 / 13
開發版本: 開發版
不支援版本: 12 / 11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1

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 描述符區域檢索關於查詢結果集的資訊,並將其儲存到主機變數中。通常在使用此命令將資訊傳輸到宿主語言變數之前,會先使用 FETCHSELECT 命令來填充描述符區域。

此命令有兩種形式:第一種形式檢索適用於整個結果集的描述符“header”項。行計數就是其中一個例子。第二種形式需要額外的列編號作為引數,它檢索關於特定列的資訊。例如,列名和實際的列值。

引數

descriptor_name #

描述符的名稱。

descriptor_header_item #

用於標識要檢索的頭部資訊項的標記。目前僅支援 COUNT,用於獲取結果集中的列數。

column_number #

要檢索資訊的列的編號。計數從 1 開始。

descriptor_item #

用於標識要檢索的關於列的資訊項的標記。有關支援的項的列表,請參閱 第 34.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;

以字串形式檢索第二列資料體的示例

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;

    /* 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;
}

執行該示例後,結果將如下所示:

d_count                 = 1
d_returned_octet_length = 6
d_data                  = testdb

相容性

GET DESCRIPTOR 命令在 SQL 標準中進行了規定。

提交更正

如果您在文件中發現任何不正確、與您對特定功能的實際體驗不符或需要進一步說明的內容,請使用 此表單 報告文件問題。