选择 打开 改范围 完整检索页
受支持版本: 当前版本 (18) / 17 / 16 / 15 / 14
开发版本: 19 / devel
不受支持的版本: 13 / 12 / 11 / 10
当前 PostgreSQL 版本不在支持生命周期内。
您可以参阅当前版本的对应页面,或其他在上面列出的活跃大版本。

37.16. 扩展构建基础设施 #

如果你打算分发自己的 PostgreSQL 扩展模块, 那么为它们搭建一个可移植的构建系统会相当困难。因此, PostgreSQL 安装提供了一套称为 PGXS 的扩展构建基础设施,使简单的扩展模块可以针对 已安装好的服务器直接构建。PGXS 主要面向包含 C 代码 的扩展,不过它也能用于纯 SQL 扩展。注意, PGXS 并不打算成为一个可以用来构建任意与 PostgreSQL 交互软件的通用构建系统框架;它 只是把简单服务器扩展模块的常见构建规则自动化。对于更复杂的软件包,你 可能还是需要自己编写构建系统。

要使用PGXS基础设施构建扩展,必须编写一个简单的 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 中列出对象文件)

还可以设置以下变量:

EXTENSION

扩展名称;对于每个名称,你都必须提供一个 extension.control 文 件,它将安装到 prefix/share/extension

MODULEDIR

prefix/share 下的子目录, 用于安装 DATA 和 DOCS 文件(若未设置,则在设置了 EXTENSION 时默认为 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 的额外开关

NO_INSTALLCHECK

不定义 installcheck 目标,适用于测试需要特殊配置, 或者不使用 pg_regress 的情况

EXTRA_CLEAN

make clean 中要额外删除的文件

PG_CPPFLAGS

将被添加到 CPPFLAGS 前面

PG_CFLAGS

将被添加到 CFLAGS 后面

PG_CXXFLAGS

将被添加到 CXXFLAGS 后面

PG_LDFLAGS

将被添加到 LDFLAGS 前面

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 命令行上设置都可以。

如果希望将构建目录单独放置,也可以运行make,并将工作目录设在扩展源码树之外。这种做法也称为VPATH构建。具体方法如下:

mkdir build_dir
cd build_dir
make -f /path/to/extension/source/tree/Makefile
make -f /path/to/extension/source/tree/Makefile install

另外,你也可以像核心代码那样为 VPATH 构建准备一个目录。其中一种方法是 使用核心脚本 config/prep_buildtree。准备好之后, 就可以像下面这样通过设置 make 变量 VPATH 来构建:

make VPATH=/path/to/extension/source/tree
make VPATH=/path/to/extension/source/tree install

这种方式适用于更多种目录布局。

REGRESS 变量中列出的脚本用于对模块做回归测试,可 在执行完 make install 之后,通过 make installcheck 来运行。要让它工作,你必须有一个 正在运行的 PostgreSQL 服务器。列在 REGRESS 中的脚本文件必须位于扩展目录下名为 sql/ 的子目录中。这些文件必须具有 .sql 扩展名,而该扩展名不应出现在 makefile 的 REGRESS 列表中。对于每个测试,还应在名为 expected/ 的子目录中有一个包含期望输出的文件,其主 干名相同,扩展名为 .outmake installcheck 会用 psql 执行每个测试脚本,并把得到的输出与对应的期望文件比较。任何差异都会以 diff -c 格式写入 regression.diffs 文件。注意,如果尝试运行一个缺少 期望文件的测试,将被报告为 trouble,所以请确保所有期望 文件都已准备好。

Tip

创建期望文件最简单的方法是先建立空文件,然后运行一次测试(当然这会报告差异)。检查 results/ 目录中的实际结果文件;如果它们与你对测试的预期一致,就把它们复制到 expected/ 中。