ecpg — 嵌入式 SQL C 预处理器
ecpg [option...] file...
ecpg 是 C 程序的嵌入式 SQL 预处理器。它通过用特殊的函数调用替换 SQL 调用,把带有嵌入式 SQL 语句的 C 程序转换为普通的 C 代码。输出的文件随后可以用任何 C 编译器工具链进行处理。
ecpg 会把命令行上给出的每个输入文件转换为相应的 C 输出文件。如果输入文件名没有任何扩展名,则假定其为 .pgc。该文件的扩展名会被替换为 .c,以构成输出文件名。但可以使用 -o 选项覆盖输出文件名。
如果输入文件名就是 -,ecpg 会从标准输入读取程序(并写到标准输出,除非用 -o 覆盖了这一点)。
本参考页不描述嵌入式 SQL 语言。有关该主题的更多信息,请参见 Chapter 34。
ecpg 接受下列命令行参数:
-c
从 SQL 代码自动生成某些 C 代码。目前这适用于 EXEC SQL TYPE。
-C mode 设置一种兼容模式。mode 可以是 INFORMIX、INFORMIX_SE 或 ORACLE。
-D symbol[=value] 定义一个预处理器符号,等同于 EXEC SQL DEFINE 指令。如果没有指定 value,该符号会被定义为值 1。
-h 处理头文件。指定此选项后,输出文件的扩展名会变成 .h 而不是 .c,并且默认的输入文件扩展名是 .pgh 而不是 .pgc。此外,-c 选项会被强制打开。
-i同时解析系统包含文件。
-I directory 指定一个附加的包含路径,用于查找通过 EXEC SQL INCLUDE 包含的文件。默认值依次是 .(当前目录)、/usr/local/include、编译时定义的 PostgreSQL include 目录(默认为 /usr/local/pgsql/include)以及 /usr/include。
-o filename 指定 ecpg 应把它的全部输出写到给定的 filename。写成 -o - 会把所有输出发送到标准输出。
-r option
选择运行时行为。Option 可以是下列之一:
no_indicator不使用指示器,而是使用特殊的值来表示空值。历史上曾有一些数据库采用这种方法。
prepare在使用之前先把所有语句预编译。Libecpg 会维护一个已预编译语句的缓存,如果某条语句再次执行就会重用它。如果缓存满了,libecpg 会释放使用最少的语句。
questionmarks出于兼容性原因,允许使用问号作为占位符。很久以前这曾是默认行为。
-t 打开事务的自动提交。在这种模式下,每条 SQL 命令都会被自动提交,除非它位于一个显式事务块内。在默认模式下,只有发出 EXEC SQL COMMIT 时命令才会被提交。
-v打印附加信息,包括版本和 "include" 路径。
--version打印 ecpg 的版本并退出。
-?--help显示关于 ecpg 命令行参数的帮助信息,然后退出。
编译预处理后的 C 代码文件时,编译器需要能够找到 ECPG 头文件,它们位于 PostgreSQL 的 include 目录中。因此,在调用编译器时你可能必须使用 -I 选项(例如 -I/usr/local/pgsql/include)。
使用带有嵌入式 SQL 的 C 代码的程序必须与 libecpg 库链接,例如使用链接器选项 -L/usr/local/pgsql/lib -lecpg。
对于特定的安装,这些目录的适当取值可以用 pg_config 查询得到。
如果你有一个名为 prog1.pgc 的嵌入式 SQL C 源文件,可以用下面的命令序列创建一个可执行程序:
ecpg prog1.pgc cc -I/usr/local/pgsql/include -c prog1.c cc -o prog1 prog1.o -L/usr/local/pgsql/lib -lecpg