2024年9月26日:PostgreSQL 17 发布!
支持的版本:当前 (17) / 16 / 15 / 14 / 13 / 12
开发版本:devel
不受支持的版本: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 填充描述符区域。

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

参数

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 标准中指定。

提交更正

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