# 获取描述符

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

# 概要

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

# 描述

获取描述符从 SQL 描述符区域检索有关查询结果集的信息并将其存储到主机变量中。描述符区域通常使用拿来或者选择在使用此命令将信息传输到宿主语言变量之前。

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

# 参数

描述符名称

描述符名称。

描述符标题项

标识要检索哪个标头信息项的标记。仅有的数数,获取结果集中的列数,目前支持。

列号

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

描述符项

标识要检索的有关列的哪些信息项的标记。看第 36.7.1 节获取支持的项目列表。

变量

一个主机变量,它将接收从描述符区域检索到的数据。

# 例子

检索结果集中列数的示例:

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;

这是一个执行整个过程的示例选择当前数据库();并显示列数、列数据长度和列数据:

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

# 兼容性

获取描述符在 SQL 标准中指定。

# 也可以看看

分配描述符,设置描述符