受支持版本: 当前版本 (18) / 17 / 16 / 15 / 14
开发版本: devel

ecpg

ecpg — 嵌入式 SQL C 预处理器

Synopsis

ecpg [option...] file...

描述

ecpg是供 C 程序使用的嵌入式 SQL 预处理器。它会把嵌入了 SQL 语句的 C 程序转换成普通 C 代码,方法是将 SQL 调用替换为特殊的函数调用。生成的输出文件随后可以由任何 C 编译器工具链处理。

ecpg会将命令行中给出的每个输入文件转换成对应的 C 输出文件。 若输入文件名没有任何扩展名,则假定其扩展名为.pgc。随后会把该文件的扩展名替换为 .c,以构造输出文件名。 不过,也可以用-o选项覆盖输出文件名。

如果输入文件名只是-ecpg就会从标准输入 读取程序(并写到标准输出,除非使用-o覆盖该行为)。

本参考页不描述嵌入式 SQL 语言。有关该主题的更多信息,见Chapter 34

选项

ecpg接受以下命令行参数:

-c #

自动从 SQL 代码生成某些 C 代码。目前,这适用于EXEC SQL TYPE

-C mode #

设置兼容模式。mode可以是INFORMIXINFORMIX_SE,或ORACLE

-D symbol[=value] #

定义一个预处理器符号,等效于EXEC SQL DEFINE指令。如果未指定value, 则该符号会被定义为值1

-h #

处理头文件。指定该选项时,输出文件扩展名变为.h而不是.c, 默认输入文件扩展名也变为.pgh而不是.pgc。此外,还会强制启用-c选项。

-i #

也解析系统 include 文件。

-I directory #

指定一个附加的 include 路径,用于查找通过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 命令位于显式事务块中,否则每条 SQL 命令都会自动提交。在默认模式下,只有发出EXEC SQL COMMIT时才会提交命令。

-v #

打印附加信息,包括版本和 include 路径。

--version #

打印ecpg版本并退出。

-?
--help #

显示关于ecpg命令行参数的帮助信息,并退出。

注解

在编译预处理后的 C 代码文件时,编译器必须能够在PostgreSQL的 include 目录中找到ECPG头文件。因此,调用编译器时你可能需要使用-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

提交更正

如果您发现文档中有不正确的内容、与您使用特定功能的经验不符或需要进一步说明,请使用此表单来报告文档问题。