Postgresql 中文操作指南

ecpg

ecpg — 嵌入式 SQL C 预处理器

Synopsis

ecpg [ option …​] file …​

Description

ecpg 是 C 程序的嵌入式 SQL 预处理器。它将带有嵌入式 SQL 语句的 C 程序转换为常规 C 代码，方法是用特殊函数调用替换 SQL 调用。然后，可以使用任何 C 编译器工具链处理输出文件。

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

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

此参考页面不描述嵌入式 SQL 语言。有关该主题的更多信息，请参见 Chapter 36 。

Options

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 可以是以下项之一：

  • -t

    • 打开事务自动提交。在此模式下，每个 SQL 命令都自动提交，除非它位于明确的事务块内。在默认模式中，只有当发出 EXEC SQL COMMIT 时才提交命令。

  • -v

    • 打印包括版本和“包含”路径在内的附加信息。

  • —​version

    • 打印 ecpg 版本并退出。

  • -?_—​help_

    • 显示有关 ecpg 命令行参数的帮助，然后退出。

  • no_indicator

    • 不要使用指示符，而是使用特殊值来表示空值。历史上曾有使用此方法的数据库。

  • prepare

    • 在使用所有语句之前先准备它们。Libecpg 将保留已准备语句的缓存，并在再次执行语句时重用语句。如果缓存已满，libecpg 将释放使用最少的语句。

  • questionmarks

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

Notes

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

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

可以使用 pg_config 找到适用于安装的这些目录的任何一个目录的值。

Examples

如果您有一个名为 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