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 标准中进行了规定。

提交更正

如果您在文档中发现任何不正确、与您对特定功能的实际体验不符或需要进一步说明的内容,请使用 此表单 报告文档问题。