GET DESCRIPTOR

GET DESCRIPTOR —从 SQLDescriptors 区域获取信息

Synopsis

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

Description

GET DESCRIPTOR从 SQLDescriptors 区域检索有关查询结果集的信息，并将其存储到主机变量中。在使用此命令将信息传输到宿主语言变量之前，通常使用FETCH或SELECT填充 Descriptors 区域。

此命令有两种形式：第一种形式检索 Descriptors“Headers”项，这些项完整地应用于结果集。一个例子是行数。第二种形式需要列号作为附加参数，它检索有关特定列的信息。示例包括列名和实际列值。

Parameters

• descriptor_name

  • Descriptors 名称。

• descriptor_header_item

  • 标识要检索的头信息项的令牌。当前仅支持COUNT，以获取结果集中的列数。

• column_number

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

• descriptor_item

  • 令牌，用于标识要检索的有关列的信息。有关支持的项目的列表，请参见Section 35.7.1。

• cvariable

  • 一个主机变量，它将接收从 Descriptors 区域检索到的数据。

Examples

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

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

Compatibility

在 SQL 标准中指定了GET DESCRIPTOR。

See Also

ALLOCATE DESCRIPTOR, SET DESCRIPTOR