↑↓ 选择↵ 打开⌫ 切换范围完整搜索

PG.CENTER 连接 PostgreSQL 文档、百科与生态知识。由 Pigsty 维护。

支持中的版本: 当前版本 (18) / 17 / 16 / 15 / 14
开发中的版本: 19 / 20devel
已结束支持的版本: 13 / 12 / 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 / 7.2 / 7.1 / 7.0
预发布版本文档。 PostgreSQL 19beta4 为测试版本,最终发布内容可能有所不同。

ecpg

ecpg — 嵌入式 SQL C 预处理器

大纲

ecpg [option...] file...

描述

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

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

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

本参考页不描述嵌入式 SQL 语言。有关该主题的更多信息,见第 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 包含文件目录(默认:/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 #

打印附加信息,包括版本和包含文件搜索路径。

--version #

打印 ecpg 版本并退出。

-?
--help #

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

注解

在编译预处理后的 C 代码文件时,编译器必须能够在 PostgreSQL 的包含文件目录中找到 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

报告文档问题

阅读 上游文档. 反馈更正前请先核对 当前版本手册.