2025年9月25日: PostgreSQL 18 发布!
支持的版本:当前 (18) / 17 / 16 / 15 / 14 / 13
开发版本:devel
不支持的版本: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

ecpg

ecpg — C 语言嵌入式 SQL 预处理器

概要

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/include、编译时定义的 PostgreSQL 包含目录(默认:/usr/local/pgsql/include)以及 /usr/include

-o 文件名

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

-r 选项

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

no_indicator

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

prepare

在使用所有语句之前预先准备它们。Libecpg 将维护一个预备语句缓存,并在再次执行语句时重用它。如果缓存已满,libecpg 将释放使用最少的语句。

questionmarks

出于兼容性考虑,允许使用问号作为占位符。这曾经是很久以前的默认设置。

-t

启用事务自动提交。在此模式下,除非显式事务块,否则每个 SQL 命令都会自动提交。在默认模式下,命令仅在发出 EXEC SQL COMMIT 时提交。

-v

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

--version

打印 ecpg 版本并退出。

-?
--help

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

注释

编译预处理后的 C 代码文件时,编译器需要能够找到 ECPG 头文件在 PostgreSQL 包含目录中。因此,调用编译器时可能需要使用 -I 选项(例如,-I/usr/local/pgsql/include)。

使用带有嵌入式 SQL 的 C 代码的程序必须链接 libecpg 库,例如使用链接器选项 -L/usr/local/pgsql/lib -lecpg

安装适用的上述任一目录的值可以通过 pg_config 获取。

示例

如果您的嵌入式 SQL C 源文件名为 prog1.pgc,您可以使用以下命令序列来创建可执行程序:

ecpg prog1.pgc
cc -I/usr/local/pgsql/include -c prog1.c
cc -o prog1 prog1.o -L/usr/local/pgsql/lib -lecpg

提交更正

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