PostgreSQL 中文参考文档
🌐 英文原版 官方 ↗

GET DESCRIPTOR

GET DESCRIPTOR — 从一个 SQL 描述符区获取信息

Synopsis

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

描述

GET DESCRIPTOR 从一个 SQL 描述符区检索关于查询结果集的信息,并将其存入主变量。 在使用这条命令把信息传送到主语言变量之前,描述符区通常先用 FETCH 或 SELECT 填充。

这条命令有两种形式:第一种形式检索描述符的“头部”项, 它作用于整个结果集,例如行数。第二种形式要求提供列号作为附加 参数,检索关于特定列的信息,例如列名和实际的列值。

参数

descriptor_name #

一个描述符名称。

descriptor_header_item #

一个标记,标识要检索哪个头部信息项。当前只支持 COUNT,用于取得结果集中的列数。

column_number #

要检索其信息的列的编号。编号从 1 开始。

descriptor_item #

一个标记,标识要检索关于某列的哪个信息项。 受支持的信息项列表请参见 Section 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 标准中有规定。

另请参阅

ALLOCATE DESCRIPTOR, SET DESCRIPTOR