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 / 7.2 / 7.1

ecpg

ecpg — 嵌入式 SQL C 预处理器

概要

ecpg [选项...] 文件...

描述

ecpg 是用于 C 程序的嵌入式 SQL 预处理器。它通过将嵌入式 SQL 语句替换为特殊函数调用,将包含嵌入式 SQL 语句的 C 程序转换为普通 C 代码。输出文件可以使用任何 C 编译器工具链进行处理。

ecpg 将把命令行上给出的每个输入文件转换为相应的 C 输出文件。如果输入文件名没有扩展名,则假定为 .pgc。文件的扩展名将被替换为 .c 以构建输出文件名。但可以使用 -o 选项覆盖输出文件名。

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

此参考页不描述嵌入式 SQL 语言。有关该主题的更多信息,请参阅 第 34 章

选项

ecpg 接受以下命令行参数

-c

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

-C 模式

设置兼容模式。 模式 可以是 INFORMIXINFORMIX_SEORACLE

-D 符号[=]

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

-h

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

-i

解析系统包含文件。

-I 目录

指定一个额外的包含路径,用于查找通过 EXEC SQL INCLUDE 包含的文件。默认值为 .(当前目录)、/usr/local/includePostgreSQL 包含目录(在编译时定义,默认值为:/usr/local/pgsql/include)和 /usr/include,按照此顺序。

-o 文件名

指定 ecpg 将所有输出写入给定的 文件名。写入 -o - 以将所有输出发送到标准输出。

-r 选项

选择运行时行为。 选项 可以是以下之一

no_indicator

不使用指示器,而是使用特殊值来表示空值。历史上,有些数据库使用这种方法。

prepare

在使用语句之前准备所有语句。Libecpg 将保存准备好的语句的缓存,并在再次执行语句时重复使用。如果缓存已满,libecpg 将释放最少使用的语句。

questionmarks

出于兼容性原因,允许问号作为占位符。这曾经是很久以前的默认值。

-t

打开事务的自动提交。在此模式下,除非位于显式事务块内,否则每个 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

提交更正

如果您在文档中发现任何不正确的地方,与您对特定功能的体验不符,或者需要进一步说明,请使用 此表格 报告文档问题。