pgsql.cc 提供对 postgresql.org 官网内容的中文翻译,由 Pigsty 团队维护。
如果你打算分发自己的 PostgreSQL 扩展模块, 那么为它们搭建一个可移植的构建系统可能相当困难。因此, PostgreSQL 安装提供了一套称为 PGXS 的扩展构建基础设施,使简单的扩展模块可以针对 已安装好的服务器直接构建。PGXS 主要面向包含 C 代码 的扩展,不过它也能用于纯 SQL 扩展。注意, PGXS 并不打算成为一个可以用来构建任意与 PostgreSQL 交互软件的通用构建系统框架;它 只是把简单服务器扩展模块的常见构建规则自动化。对于更复杂的软件包,你 可能还是需要自己编写构建系统。
要为你的扩展使用PGXS基础设施,必须编写一个简单的 makefile。在 makefile 中,你需要设置一些变量,并在最后包含全局的PGXSmakefile。下面的示例构建一个扩展模块,名为isbn_issn,由包含一些 C 代码的共享库、扩展控制文件、SQL 脚本以及文档文本文件组成:
MODULES = isbn_issn EXTENSION = isbn_issn DATA = isbn_issn--1.0.sql DOCS = README.isbn_issn PG_CONFIG = pg_config PGXS := $(shell $(PG_CONFIG) --pgxs) include $(PGXS)
最后三行应该总是相同的。在文件更前面的部分,你可以为变量赋值或者添加自定义的make规则。
设定下列三个变量中的一个,以指定要构建的内容:
MODULES要从同名源文件构建的共享库对象列表(列表中不要包含库后缀)
MODULE_big要从多个源文件构建的共享库(在 OBJS 中列出目标 文件)
PROGRAM要构建的可执行程序(在 OBJS 中列出目标文件)
The following variables can also be set:
EXTENSION扩展名称;对于每个名称,你都必须提供一个 文 件,它将安装到 extension.controlprefix/share/extension
MODULEDIR 下的子目录, 用于安装 DATA 和 DOCS 文件(若未设置,则在设置了 prefix/shareEXTENSION 时默认为 extension,否则默认为 contrib)
DATA要安装到 的任意文件prefix/share/$MODULEDIR
DATA_built要安装到 的任意文件,但它们需要先被构建prefix/share/$MODULEDIR
DATA_TSEARCH要安装到 下的任意文件prefix/share/tsearch_data
DOCS要安装到 下的任意文件prefix/doc/$MODULEDIR
SCRIPTS要安装到 的脚本文件(不是二进制文件)prefix/bin
SCRIPTS_built要安装到 的脚本文件(不是二进制文件),但它们需要先被构建prefix/bin
REGRESS回归测试用例列表(不带后缀),详见下文
REGRESS_OPTS传递给 pg_regress 的额外开关
EXTRA_CLEAN在 make clean 中要额外删除的文件
PG_CPPFLAGS将被添加到 CPPFLAGS
PG_LIBS将被加入 PROGRAM 的链接命令行
SHLIB_LINK将被加入 MODULE_big 的链接命令行
PG_CONFIG要针对其进行构建的 PostgreSQL 安装所对应 的 pg_config 程序路径(通常只写 pg_config,表示使用你 PATH 中找到的第一个)
把这个 makefile 命名为 Makefile,并放在保存扩展的目录中。 然后你就可以执行 make 进行编译,再执行 make install 安装你的模块。默认情况下,该扩展会针 对你 PATH 中找到的第一个 pg_config 所对应的 PostgreSQL 安装进行编译和安装。你也可以使 用不同的安装,只需让 PG_CONFIG 指向它的 pg_config 程序,无论是在 makefile 中设置,还是在 make 命令行上设置都可以。
更改PG_CONFIG只在针对PostgreSQL 8.3 或更新版本构建时有效。对于更老的发行版本,把它设置为pg_config之外的任何值都不起作用;你必须修改你的PATH来选择要针对其构建的安装。
在 REGRESS 变量中列出的脚本用于对模块做回归测试,可 在执行完 make install 之后,通过 make installcheck 来运行。要让它工作,你必须有一个 正在运行的 PostgreSQL 服务器。列在 REGRESS 中的脚本文件必须位于扩展目录下名为 sql/ 的子目录中。这些文件必须具有 .sql 扩展名,而该扩展名不能出现在 makefile 的 REGRESS 列表中。对于每个测试,还应在名为 expected/ 的子目录中有一个包含期望输出的文件,其主 干名相同,扩展名为 .out。 make installcheck 会用 psql 执行每个测试脚本,并把得到的输出与对应的期望文件比较。任何差异都会以 diff -c 格式写入 regression.diffs 文件。注意,如果尝试运行一个缺少 期望文件的测试,将被报告为 “trouble”,所以请确保所有期望 文件都已准备好。
创建期望文件最简单的方法是先建立空文件,然后运行一次测试(当然这会报告差异)。检查 results/ 目录中的实际结果文件;如果它们与你对测试的预期一致,就把它们复制到 expected/ 中。
译文有误、术语不当或页面显示问题,请到译文仓库 pgsty/pgdoc 报告译文问题。 英文原文本身的问题,请在当前版本的对应页面向上游反馈;上游不再修订已结束维护的版本。