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 / 9.0 / 8.4 / 8.3 / 8.2 / 8.1 / 8.0 / 7.4 / 7.3

34.4. 使用主机变量 #

第 34.3 节 中,您看到了如何从嵌入式 SQL 程序中执行 SQL 语句。其中一些语句只使用固定值,没有提供将用户提供的值插入语句或让程序处理查询返回的值的方法。这些类型的语句在实际应用中并没有实际意义。本节将详细解释如何使用一个简单的机制,称为主机变量,在 C 程序和嵌入式 SQL 语句之间传递数据。在嵌入式 SQL 程序中,我们将 SQL 语句视为 C 程序代码中的访客,而 C 程序代码则是宿主语言。因此,C 程序的变量被称为主机变量

另一种在 PostgreSQL 后端和 ECPG 应用程序之间交换值的方法是使用 SQL 描述符,在 第 34.7 节 中描述。

34.4.1. 概述 #

在 C 程序和 SQL 语句之间传递数据在嵌入式 SQL 中特别简单。您无需让程序将数据粘贴到语句中,这会带来各种复杂问题,例如正确引用值,而只需在 SQL 语句中写入 C 变量的名称,并在其前面加上冒号。例如

EXEC SQL INSERT INTO sometable VALUES (:v1, 'foo', :v2);

此语句引用了名为 v1v2 的两个 C 变量,并使用了一个常规的 SQL 字符串字面量,以说明您不受限于使用一种数据类型或另一种数据类型。

这种在 SQL 语句中插入 C 变量的方式适用于 SQL 语句中需要值表达式的地方。

34.4.2. 声明部分 #

要将程序生成的数据传递到数据库,例如作为查询中的参数,或者将数据库生成的数据传递回程序,需要在特殊标记的部分声明打算包含此数据的 C 变量,以便嵌入式 SQL 预处理器可以识别它们。

此部分以

EXEC SQL BEGIN DECLARE SECTION;

结尾

EXEC SQL END DECLARE SECTION;

在这些行之间,必须是正常的 C 变量声明,例如

int   x = 4;
char  foo[16], bar[16];

如您所见,您可以选择为变量分配一个初始值。变量的作用域由其声明部分在程序中的位置决定。您还可以使用以下语法声明变量,它隐式地创建了一个声明部分

EXEC SQL int i = 4;

您可以在程序中设置任意数量的声明部分。

这些声明也会像普通的 C 变量一样被回显到输出文件中,因此您无需再次声明它们。不在 SQL 命令中使用的变量可以在这些特殊部分之外正常声明。

结构体或联合体的定义也必须列在 DECLARE 部分中。否则,预处理器无法处理这些类型,因为它不知道定义。

34.4.3. 获取查询结果 #

现在,您应该能够将程序生成的数据传递到 SQL 命令中。但是如何获取查询的结果呢?为此,嵌入式 SQL 提供了通常命令 SELECTFETCH 的特殊变体。这些命令有一个特殊的 INTO 子句,用于指定要存储检索值的哪个主机变量。 SELECT 用于仅返回单行的查询,FETCH 用于使用游标返回多行的查询。

这是一个示例

/*
 * assume this table:
 * CREATE TABLE test1 (a int, b varchar(50));
 */

EXEC SQL BEGIN DECLARE SECTION;
int v1;
VARCHAR v2;
EXEC SQL END DECLARE SECTION;

 ...

EXEC SQL SELECT a, b INTO :v1, :v2 FROM test;

因此,INTO 子句出现在选择列表和 FROM 子句之间。选择列表中的元素数量和 INTO 之后(也称为目标列表)的列表中的元素数量必须相等。

这是一个使用 FETCH 命令的示例

EXEC SQL BEGIN DECLARE SECTION;
int v1;
VARCHAR v2;
EXEC SQL END DECLARE SECTION;

 ...

EXEC SQL DECLARE foo CURSOR FOR SELECT a, b FROM test;

 ...

do
{
    ...
    EXEC SQL FETCH NEXT FROM foo INTO :v1, :v2;
    ...
} while (...);

在此,INTO 子句出现在所有正常子句之后。

34.4.4. 类型映射 #

当 ECPG 应用程序在 PostgreSQL 服务器和 C 应用程序之间交换值时,例如从服务器获取查询结果或执行带有输入参数的 SQL 语句时,需要在 PostgreSQL 数据类型和主机语言变量类型(具体来说是 C 语言数据类型)之间进行转换。ECPG 的主要目的之一是自动处理这种情况(在大多数情况下)。

在这方面,有两种类型的数据类型:一些简单的 PostgreSQL 数据类型,例如 integertext,可以直接由应用程序读取和写入。其他 PostgreSQL 数据类型,例如 timestampnumeric,只能通过特殊的库函数访问;请参见 第 34.4.4.2 节

表 34.1 显示了哪些 PostgreSQL 数据类型对应于哪些 C 数据类型。当您希望发送或接收给定 PostgreSQL 数据类型的值时,您应该在声明部分声明一个对应 C 数据类型的 C 变量。

表 34.1. PostgreSQL 数据类型和 C 变量类型之间的映射

PostgreSQL 数据类型 主机变量类型
smallint short
integer int
bigint long long int
decimal decimal[a]
numeric numeric[a]
real float
double precision double
smallserial short
serial int
bigserial long long int
oid unsigned int
character(n), varchar(n), text char[n+1], VARCHAR[n+1]
name char[NAMEDATALEN]
timestamp timestamp[a]
interval interval[a]
date date[a]
boolean bool[b]
bytea char *, bytea[n]

[a] 此类型只能通过特殊的库函数访问;请参见 第 34.4.4.2 节

[b]ecpglib.h 中声明(如果未原生声明)


34.4.4.1. 处理字符字符串 #

要处理 SQL 字符串数据类型,例如 varchartext,有两种可能的声明主机变量的方法。

一种方法是使用 char[],它是 char 的数组,这是在 C 中处理字符数据的最常见方法。

EXEC SQL BEGIN DECLARE SECTION;
    char str[50];
EXEC SQL END DECLARE SECTION;

请注意,您必须自行处理长度。如果您使用此主机变量作为查询的目标变量,该查询返回的字符串长度超过 49 个字符,则会发生缓冲区溢出。

另一种方法是使用 VARCHAR 类型,它是 ECPG 提供的特殊类型。对类型 VARCHAR 的数组的定义将转换为每个变量的命名 struct。类似于以下的声明

VARCHAR var[180];

将转换为

struct varchar_var { int len; char arr[180]; } var;

成员 arr 承载字符串,包括一个终止零字节。因此,要在 VARCHAR 主机变量中存储字符串,必须使用包括终止零字节的长度声明主机变量。成员 len 保存存储在 arr 中的字符串的长度,不包括终止零字节。当主机变量用作查询的输入时,如果 strlen(arr)len 不同,则使用较短的长度。

VARCHAR 可以用大写或小写形式编写,但不能混合大小写。

charVARCHAR 主机变量也可以保存其他 SQL 类型的值,这些值将以字符串形式存储。

34.4.4.2. 访问特殊数据类型 #

ECPG 包含一些特殊类型,可以帮助您轻松地与 PostgreSQL 服务器上的某些特殊数据类型进行交互。特别是,它实现了对 numericdecimaldatetimestampinterval 类型的支持。这些数据类型不能有效地映射到原始主机变量类型(如 intlong long intchar[]),因为它们具有复杂的内部结构。应用程序通过在特殊类型中声明主机变量并在 pgtypes 库中的函数的帮助下访问它们来处理这些类型。pgtypes 库(在 第 34.6 节 中有详细介绍)包含用于处理这些类型的基本函数,这样您就不需要向 SQL 服务器发送查询来执行诸如将时间间隔添加到时间戳的操作。

以下小节将介绍这些特殊数据类型。有关 pgtypes 库函数的更多详细信息,请参见 第 34.6 节

34.4.4.2.1. timestamp、date #

以下是处理 ECPG 主机应用程序中的 timestamp 变量的模式。

首先,程序必须包含 timestamp 类型的头文件

#include <pgtypes_timestamp.h>

接下来,在声明部分将主机变量声明为 timestamp 类型

EXEC SQL BEGIN DECLARE SECTION;
timestamp ts;
EXEC SQL END DECLARE SECTION;

在将值读入主机变量后,使用 pgtypes 库函数对其进行处理。在以下示例中,timestamp 值使用 PGTYPEStimestamp_to_asc() 函数转换为文本(ASCII)形式

EXEC SQL SELECT now()::timestamp INTO :ts;

printf("ts = %s\n", PGTYPEStimestamp_to_asc(ts));

此示例将显示以下结果

ts = 2010-06-27 18:03:56.949343

此外,DATE 类型可以以相同的方式处理。程序必须包含 pgtypes_date.h,将主机变量声明为日期类型,并使用 PGTYPESdate_to_asc() 函数将 DATE 值转换为文本形式。有关 pgtypes 库函数的更多详细信息,请参见 第 34.6 节

34.4.4.2.2. interval #

interval 类型的处理与 timestampdate 类型类似。但是,需要显式地为 interval 类型值分配内存。换句话说,变量的内存空间必须在堆内存中分配,而不是在堆栈内存中分配。

以下是一个示例程序

#include <stdio.h>
#include <stdlib.h>
#include <pgtypes_interval.h>

int
main(void)
{
EXEC SQL BEGIN DECLARE SECTION;
    interval *in;
EXEC SQL END DECLARE SECTION;

    EXEC SQL CONNECT TO testdb;
    EXEC SQL SELECT pg_catalog.set_config('search_path', '', false); EXEC SQL COMMIT;

    in = PGTYPESinterval_new();
    EXEC SQL SELECT '1 min'::interval INTO :in;
    printf("interval = %s\n", PGTYPESinterval_to_asc(in));
    PGTYPESinterval_free(in);

    EXEC SQL COMMIT;
    EXEC SQL DISCONNECT ALL;
    return 0;
}
34.4.4.2.3. numeric、decimal #

numericdecimal 类型的处理与 interval 类型类似:它需要定义一个指针,在堆上分配一些内存空间,并使用 pgtypes 库函数访问变量。有关 pgtypes 库函数的更多详细信息,请参见 第 34.6 节

没有专门为 decimal 类型提供的函数。应用程序必须使用 pgtypes 库函数将其转换为 numeric 变量,以便进行进一步处理。

以下是一个处理 numericdecimal 类型变量的示例程序。

#include <stdio.h>
#include <stdlib.h>
#include <pgtypes_numeric.h>

EXEC SQL WHENEVER SQLERROR STOP;

int
main(void)
{
EXEC SQL BEGIN DECLARE SECTION;
    numeric *num;
    numeric *num2;
    decimal *dec;
EXEC SQL END DECLARE SECTION;

    EXEC SQL CONNECT TO testdb;
    EXEC SQL SELECT pg_catalog.set_config('search_path', '', false); EXEC SQL COMMIT;

    num = PGTYPESnumeric_new();
    dec = PGTYPESdecimal_new();

    EXEC SQL SELECT 12.345::numeric(4,2), 23.456::decimal(4,2) INTO :num, :dec;

    printf("numeric = %s\n", PGTYPESnumeric_to_asc(num, 0));
    printf("numeric = %s\n", PGTYPESnumeric_to_asc(num, 1));
    printf("numeric = %s\n", PGTYPESnumeric_to_asc(num, 2));

    /* Convert decimal to numeric to show a decimal value. */
    num2 = PGTYPESnumeric_new();
    PGTYPESnumeric_from_decimal(dec, num2);

    printf("decimal = %s\n", PGTYPESnumeric_to_asc(num2, 0));
    printf("decimal = %s\n", PGTYPESnumeric_to_asc(num2, 1));
    printf("decimal = %s\n", PGTYPESnumeric_to_asc(num2, 2));

    PGTYPESnumeric_free(num2);
    PGTYPESdecimal_free(dec);
    PGTYPESnumeric_free(num);

    EXEC SQL COMMIT;
    EXEC SQL DISCONNECT ALL;
    return 0;
}
34.4.4.2.4. bytea #

bytea 类型的处理与 VARCHAR 类似。对 bytea 类型的数组的定义将转换为每个变量的命名结构。类似于

bytea var[180];

将转换为

struct bytea_var { int len; char arr[180]; } var;

成员 arr 承载二进制格式数据。它还可以处理 '\0' 作为数据的一部分,与 VARCHAR 不同。数据将从十六进制格式转换为十六进制格式,并由 ecpglib 发送/接收。

注意

bytea 变量仅在 bytea_output 设置为 hex 时可以使用。

34.4.4.3. 具有非基本类型的宿主变量 #

作为宿主变量,您还可以使用数组、typedef、结构和指针。

34.4.4.3.1. 数组 #

数组作为宿主变量有两种用例。第一个是将一些文本字符串存储在 char[]VARCHAR[] 中的方式,如 第 34.4.4.1 节 中所述。第二个用例是在不使用游标的情况下从查询结果中检索多行。如果没有数组,要处理包含多行的查询结果,需要使用游标和 FETCH 命令。但是使用数组宿主变量,可以一次接收多行。数组的长度必须定义为能够容纳所有行,否则可能会发生缓冲区溢出。

以下示例扫描 pg_database 系统表并显示所有可用数据库的 OID 和名称

int
main(void)
{
EXEC SQL BEGIN DECLARE SECTION;
    int dbid[8];
    char dbname[8][16];
    int i;
EXEC SQL END DECLARE SECTION;

    memset(dbname, 0, sizeof(char)* 16 * 8);
    memset(dbid, 0, sizeof(int) * 8);

    EXEC SQL CONNECT TO testdb;
    EXEC SQL SELECT pg_catalog.set_config('search_path', '', false); EXEC SQL COMMIT;

    /* Retrieve multiple rows into arrays at once. */
    EXEC SQL SELECT oid,datname INTO :dbid, :dbname FROM pg_database;

    for (i = 0; i < 8; i++)
        printf("oid=%d, dbname=%s\n", dbid[i], dbname[i]);

    EXEC SQL COMMIT;
    EXEC SQL DISCONNECT ALL;
    return 0;
}

此示例显示以下结果。(确切的值取决于本地环境。)

oid=1, dbname=template1
oid=11510, dbname=template0
oid=11511, dbname=postgres
oid=313780, dbname=testdb
oid=0, dbname=
oid=0, dbname=
oid=0, dbname=
34.4.4.3.2. 结构 #

成员名称与查询结果的列名称匹配的结构可用于一次检索多个列。结构使您能够在单个宿主变量中处理多个列值。

以下示例从 pg_database 系统表检索可用数据库的 OID、名称和大小,并使用 pg_database_size() 函数。在此示例中,使用成员名称与 SELECT 结果中的每列匹配的结构变量 dbinfo_t 来检索一行结果,而无需在 FETCH 语句中放置多个宿主变量。

EXEC SQL BEGIN DECLARE SECTION;
    typedef struct
    {
       int oid;
       char datname[65];
       long long int size;
    } dbinfo_t;

    dbinfo_t dbval;
EXEC SQL END DECLARE SECTION;

    memset(&dbval, 0, sizeof(dbinfo_t));

    EXEC SQL DECLARE cur1 CURSOR FOR SELECT oid, datname, pg_database_size(oid) AS size FROM pg_database;
    EXEC SQL OPEN cur1;

    /* when end of result set reached, break out of while loop */
    EXEC SQL WHENEVER NOT FOUND DO BREAK;

    while (1)
    {
        /* Fetch multiple columns into one structure. */
        EXEC SQL FETCH FROM cur1 INTO :dbval;

        /* Print members of the structure. */
        printf("oid=%d, datname=%s, size=%lld\n", dbval.oid, dbval.datname, dbval.size);
    }

    EXEC SQL CLOSE cur1;

此示例显示以下结果。(确切的值取决于本地环境。)

oid=1, datname=template1, size=4324580
oid=11510, datname=template0, size=4243460
oid=11511, datname=postgres, size=4324580
oid=313780, datname=testdb, size=8183012

结构宿主变量 吸收 与结构的字段数量相同的列。额外的列可以分配给其他宿主变量。例如,上面的程序也可以像这样重新构建,并将 size 变量放在结构之外

EXEC SQL BEGIN DECLARE SECTION;
    typedef struct
    {
       int oid;
       char datname[65];
    } dbinfo_t;

    dbinfo_t dbval;
    long long int size;
EXEC SQL END DECLARE SECTION;

    memset(&dbval, 0, sizeof(dbinfo_t));

    EXEC SQL DECLARE cur1 CURSOR FOR SELECT oid, datname, pg_database_size(oid) AS size FROM pg_database;
    EXEC SQL OPEN cur1;

    /* when end of result set reached, break out of while loop */
    EXEC SQL WHENEVER NOT FOUND DO BREAK;

    while (1)
    {
        /* Fetch multiple columns into one structure. */
        EXEC SQL FETCH FROM cur1 INTO :dbval, :size;

        /* Print members of the structure. */
        printf("oid=%d, datname=%s, size=%lld\n", dbval.oid, dbval.datname, size);
    }

    EXEC SQL CLOSE cur1;
34.4.4.3.3. Typedef #

使用 typedef 关键字将新类型映射到现有类型。

EXEC SQL BEGIN DECLARE SECTION;
    typedef char mychartype[40];
    typedef long serial_t;
EXEC SQL END DECLARE SECTION;

注意,您也可以使用

EXEC SQL TYPE serial_t IS long;

此声明不需要是声明部分的一部分;也就是说,您也可以像正常的 C 语句一样编写 typedef。

您声明为 typedef 的任何单词都不能在同一个程序中的后面的 EXEC SQL 命令中用作 SQL 关键字。例如,这将无法正常工作

EXEC SQL BEGIN DECLARE SECTION;
    typedef int start;
EXEC SQL END DECLARE SECTION;
...
EXEC SQL START TRANSACTION;

ECPG 将报告 START TRANSACTION 的语法错误,因为它不再将 START 识别为 SQL 关键字,而只识别为 typedef。(如果您遇到此类冲突,并且重命名 typedef 似乎不切实际,您可以使用 动态 SQL 编写 SQL 命令。)

注意

在 v16 之前的 PostgreSQL 版本中,使用 SQL 关键字作为 typedef 名称很可能会导致与使用 typedef 本身相关的语法错误,而不是将名称用作 SQL 关键字。新的行为不太可能在将现有 ECPG 应用程序重新编译到具有新关键字的新 PostgreSQL 版本时出现问题。

34.4.4.3.4. 指针 #

您可以声明指向最常见类型的指针。但是请注意,您不能在没有自动分配的情况下将指针用作查询的目标变量。有关自动分配的更多信息,请参见 第 34.7 节

EXEC SQL BEGIN DECLARE SECTION;
    int   *intp;
    char **charp;
EXEC SQL END DECLARE SECTION;

34.4.5. 处理非基本 SQL 数据类型 #

本节包含有关如何在 ECPG 应用程序中处理非标量和用户定义的 SQL 级数据类型的相关信息。请注意,这不同于处理上一节中介绍的非基本类型的宿主变量。

34.4.5.1. 数组 #

ECPG 不直接支持多维 SQL 级数组。一维 SQL 级数组可以映射到 C 数组宿主变量,反之亦然。但是,在创建语句时,ecpg 无法识别列的类型,因此无法检查 C 数组是否输入到相应的 SQL 级数组中。在处理 SQL 语句的输出时,ecpg 拥有必要的信息,因此会检查两者是否都是数组。

如果查询分别访问数组的 元素,则这将避免在 ECPG 中使用数组。然后,应使用可以映射到元素类型的宿主变量。例如,如果列类型是 integer 数组,则可以使用 int 类型的宿主变量。同样,如果元素类型是 varchartext,则可以使用 char[]VARCHAR[] 类型的宿主变量。

以下是一个示例。假设有以下表格

CREATE TABLE t3 (
    ii integer[]
);

testdb=> SELECT * FROM t3;
     ii
-------------
 {1,2,3,4,5}
(1 row)

以下示例程序检索数组的第 4 个元素,并将其存储到 int 类型的宿主变量中

EXEC SQL BEGIN DECLARE SECTION;
int ii;
EXEC SQL END DECLARE SECTION;

EXEC SQL DECLARE cur1 CURSOR FOR SELECT ii[4] FROM t3;
EXEC SQL OPEN cur1;

EXEC SQL WHENEVER NOT FOUND DO BREAK;

while (1)
{
    EXEC SQL FETCH FROM cur1 INTO :ii ;
    printf("ii=%d\n", ii);
}

EXEC SQL CLOSE cur1;

此示例显示以下结果

ii=4

要将多个数组元素映射到数组类型宿主变量中的多个元素,必须分别管理数组列的每个元素和宿主变量数组的每个元素,例如

EXEC SQL BEGIN DECLARE SECTION;
int ii_a[8];
EXEC SQL END DECLARE SECTION;

EXEC SQL DECLARE cur1 CURSOR FOR SELECT ii[1], ii[2], ii[3], ii[4] FROM t3;
EXEC SQL OPEN cur1;

EXEC SQL WHENEVER NOT FOUND DO BREAK;

while (1)
{
    EXEC SQL FETCH FROM cur1 INTO :ii_a[0], :ii_a[1], :ii_a[2], :ii_a[3];
    ...
}

再次注意

EXEC SQL BEGIN DECLARE SECTION;
int ii_a[8];
EXEC SQL END DECLARE SECTION;

EXEC SQL DECLARE cur1 CURSOR FOR SELECT ii FROM t3;
EXEC SQL OPEN cur1;

EXEC SQL WHENEVER NOT FOUND DO BREAK;

while (1)
{
    /* WRONG */
    EXEC SQL FETCH FROM cur1 INTO :ii_a;
    ...
}

在这种情况下将无法正常工作,因为您无法直接将数组类型列映射到数组宿主变量。

另一种解决方法是将数组存储在其外部字符串表示形式中,存储在 char[]VARCHAR[] 类型的宿主变量中。有关此表示形式的更多详细信息,请参见 第 8.15.2 节。请注意,这意味着数组无法在主机程序中自然地作为数组访问(没有进一步处理来解析文本表示形式)。

34.4.5.2. 复合类型 #

ECPG 不直接支持复合类型,但可以使用简单的解决方法。可用的解决方法类似于上面针对数组描述的解决方法:要么分别访问每个属性,要么使用外部字符串表示形式。

对于以下示例,假设有以下类型和表格

CREATE TYPE comp_t AS (intval integer, textval varchar(32));
CREATE TABLE t4 (compval comp_t);
INSERT INTO t4 VALUES ( (256, 'PostgreSQL') );

最明显的解决方案是分别访问每个属性。以下程序通过分别选择 comp_t 类型的每个属性来检索示例表中的数据

EXEC SQL BEGIN DECLARE SECTION;
int intval;
varchar textval[33];
EXEC SQL END DECLARE SECTION;

/* Put each element of the composite type column in the SELECT list. */
EXEC SQL DECLARE cur1 CURSOR FOR SELECT (compval).intval, (compval).textval FROM t4;
EXEC SQL OPEN cur1;

EXEC SQL WHENEVER NOT FOUND DO BREAK;

while (1)
{
    /* Fetch each element of the composite type column into host variables. */
    EXEC SQL FETCH FROM cur1 INTO :intval, :textval;

    printf("intval=%d, textval=%s\n", intval, textval.arr);
}

EXEC SQL CLOSE cur1;

为了增强此示例,可以在 FETCH 命令中将用于存储值的宿主变量收集到一个结构中。有关结构形式的宿主变量的更多详细信息,请参见 第 34.4.4.3.2 节。要切换到结构,可以对示例进行如下修改。两个宿主变量 intvaltextval 成为 comp_t 结构的成员,并且该结构在 FETCH 命令中指定。

EXEC SQL BEGIN DECLARE SECTION;
typedef struct
{
    int intval;
    varchar textval[33];
} comp_t;

comp_t compval;
EXEC SQL END DECLARE SECTION;

/* Put each element of the composite type column in the SELECT list. */
EXEC SQL DECLARE cur1 CURSOR FOR SELECT (compval).intval, (compval).textval FROM t4;
EXEC SQL OPEN cur1;

EXEC SQL WHENEVER NOT FOUND DO BREAK;

while (1)
{
    /* Put all values in the SELECT list into one structure. */
    EXEC SQL FETCH FROM cur1 INTO :compval;

    printf("intval=%d, textval=%s\n", compval.intval, compval.textval.arr);
}

EXEC SQL CLOSE cur1;

尽管在 FETCH 命令中使用了结构,但仍然在 SELECT 子句中逐个指定了属性名称。这可以通过使用 * 来请求复合类型值的全部属性来增强。

...
EXEC SQL DECLARE cur1 CURSOR FOR SELECT (compval).* FROM t4;
EXEC SQL OPEN cur1;

EXEC SQL WHENEVER NOT FOUND DO BREAK;

while (1)
{
    /* Put all values in the SELECT list into one structure. */
    EXEC SQL FETCH FROM cur1 INTO :compval;

    printf("intval=%d, textval=%s\n", compval.intval, compval.textval.arr);
}
...

通过这种方式,复合类型可以几乎无缝地映射到结构中,即使 ECPG 本身不理解复合类型。

最后,还可以将复合类型值存储在其外部字符串表示形式中,存储在 char[]VARCHAR[] 类型的宿主变量中。但是,这样就不能轻松地从主机程序中访问值字段。

34.4.5.3. 用户定义的基本类型 #

ECPG 不直接支持新的用户定义的基本类型。您可以使用外部字符串表示和类型为 char[]VARCHAR[] 的宿主变量,对于许多类型来说,这种解决方案确实合适且足够。

以下是一个使用 第 36.13 节 例子中的 complex 数据类型的示例。该类型的外部字符串表示形式为 (%f,%f),它在 第 36.13 节 中的 complex_in()complex_out() 函数中定义。以下示例将复数类型值 (1,1)(3,3) 插入到列 ab 中,并在之后从表中选择它们。

EXEC SQL BEGIN DECLARE SECTION;
    varchar a[64];
    varchar b[64];
EXEC SQL END DECLARE SECTION;

    EXEC SQL INSERT INTO test_complex VALUES ('(1,1)', '(3,3)');

    EXEC SQL DECLARE cur1 CURSOR FOR SELECT a, b FROM test_complex;
    EXEC SQL OPEN cur1;

    EXEC SQL WHENEVER NOT FOUND DO BREAK;

    while (1)
    {
        EXEC SQL FETCH FROM cur1 INTO :a, :b;
        printf("a=%s, b=%s\n", a.arr, b.arr);
    }

    EXEC SQL CLOSE cur1;

此示例显示以下结果

a=(1,1), b=(3,3)

另一种解决方法是避免在 ECPG 中直接使用用户定义类型,而是创建一个函数或强制转换,在用户定义类型和 ECPG 可以处理的原始类型之间进行转换。但是请注意,类型转换(尤其是隐式转换)应该非常小心地引入类型系统。

例如,

CREATE FUNCTION create_complex(r double, i double) RETURNS complex
LANGUAGE SQL
IMMUTABLE
AS $$ SELECT $1 * complex '(1,0')' + $2 * complex '(0,1)' $$;

在定义了这个之后,下面的

EXEC SQL BEGIN DECLARE SECTION;
double a, b, c, d;
EXEC SQL END DECLARE SECTION;

a = 1;
b = 2;
c = 3;
d = 4;

EXEC SQL INSERT INTO test_complex VALUES (create_complex(:a, :b), create_complex(:c, :d));

与以下效果相同

EXEC SQL INSERT INTO test_complex VALUES ('(1,2)', '(3,4)');

34.4.6. 指示器 #

上面的例子没有处理空值。实际上,如果检索示例从数据库中获取空值,它们将引发错误。为了能够将空值传递给数据库或从数据库中检索空值,您需要为包含数据的每个宿主变量附加第二个宿主变量规范。这个第二个宿主变量称为 指示器,它包含一个标志,用于指示数据是否为空,在这种情况下,实际宿主变量的值将被忽略。以下是一个正确处理空值检索的示例

EXEC SQL BEGIN DECLARE SECTION;
VARCHAR val;
int val_ind;
EXEC SQL END DECLARE SECTION:

 ...

EXEC SQL SELECT b INTO :val :val_ind FROM test1;

如果值不为空,则指示器变量 val_ind 将为零;如果值为空,则指示器变量 val_ind 将为负数。(请参阅 第 34.16 节 以启用 Oracle 特定的行为。)

指示器还有另一个功能:如果指示器值为正,则表示该值不为空,但在存储到宿主变量时被截断了。

如果将参数 -r no_indicator 传递给预处理器 ecpg,则它将在 no-indicator 模式下工作。在无指示器模式下,如果没有指定指示器变量,则空值将被指示(在输入和输出时)为字符字符串类型的空字符串,以及整数类型的最低可能值(例如,intINT_MIN)。

提交更正

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