PostgreSQL 擴(kuò)展的構(gòu)建基礎(chǔ)設(shè)施

如果你正在考慮發(fā)布你的PostgreSQL擴(kuò)展模塊，為它們建立一個(gè)可移植的構(gòu)建系統(tǒng)實(shí)在是相當(dāng)困難。因此PostgreSQL安裝為擴(kuò)展提供了一種被稱為PGXS構(gòu)建基礎(chǔ)設(shè)施，因此簡(jiǎn)單的擴(kuò)展模塊能夠在一個(gè)已經(jīng)安裝的服務(wù)器上簡(jiǎn)單地編譯。PGXS主要是為了包括 C 代碼的擴(kuò)展而設(shè)計(jì)，不過它也能用于純 SQL 的擴(kuò)展。注意PGXS并不想成為一種用于構(gòu)建任何與PostgreSQL交互的軟件的通用構(gòu)建系統(tǒng)框架。它只是簡(jiǎn)單地把簡(jiǎn)單服務(wù)器擴(kuò)展模塊的公共構(gòu)建規(guī)則自動(dòng)化。對(duì)于更復(fù)雜的包，你可能需要編寫你自己的構(gòu)建系統(tǒng)。

要把PGXS基礎(chǔ)設(shè)施用于你的擴(kuò)展，你必須編寫一個(gè)簡(jiǎn)單的 makefile。在這個(gè) makefile 中，你需要設(shè)置一些變量并且把它們包括在全局的PGXS makefile 中。這里有一個(gè)例子，它構(gòu)建一個(gè)名為isbn_issn的擴(kuò)展模塊，其中包括一個(gè)含有 C 代碼的共享庫(kù)、一個(gè)擴(kuò)展控制文件、一個(gè) SQL 腳本、一個(gè)包括文件（僅當(dāng)其他模塊可能需要通過調(diào)用而不是SQL訪問這個(gè)擴(kuò)展的函數(shù)時(shí)才需要）以及一個(gè)文檔文件：

MODULES = isbn_issn
EXTENSION = isbn_issn
DATA = isbn_issn--1.0.sql
DOCS = README.isbn_issn
HEADERS_isbn_issn = isbn_issn.h

PG_CONFIG = pg_config
PGXS := $(shell $(PG_CONFIG) --pgxs)
include $(PGXS)

最后三行應(yīng)該總是相同的。在這個(gè)文件的前面部分，你要對(duì)變量賦值或者增加自定義的make規(guī)則。

設(shè)置這三個(gè)變量之一來指定要構(gòu)建什么：

還可以設(shè)置下列變量：

把這個(gè) makefile 作為Makefile放在保存你擴(kuò)展的目錄中。然后你可以執(zhí)行make進(jìn)行編譯，并且接著make install來安裝你的模塊。默認(rèn)情況下，該模塊會(huì)為在你的PATH中找到的第一個(gè)pg_config程序所對(duì)應(yīng)的 PostgreSQL安裝編譯和安裝。你可以通過在 makefile 中或者make命令行中設(shè)置PG_CONFIG指向另一個(gè)pg_config程序來使用一個(gè)不同的安裝。

如果你想保持編譯目錄獨(dú)立，你也可以在你的擴(kuò)展所屬的源代碼樹之外的目錄中運(yùn)行 make。 這個(gè)過程也被稱為一個(gè) VPATH 編譯。下面是做法：

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

此外，你可以以對(duì)核心代碼所作的方式一樣為 VPATH 設(shè)置一個(gè)目錄。一種方式是使用核心腳本 config/prep_buildtree。一旦這樣做，你可以這樣設(shè)置 make變量VPATH：

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

這個(gè)過程可以在很多種目錄布局下工作。

列舉在REGRESS變量中的腳本會(huì)被用來對(duì)你的擴(kuò)展進(jìn)行回歸測(cè)試，回歸測(cè)試可以在做完make install之后用make installcheck調(diào)用。要讓這能夠工作，你必須已經(jīng)有一個(gè)運(yùn)行著的PostgreSQL服務(wù)器。列舉在REGRESS中的腳本文件必須在你擴(kuò)展目錄的名為 sql/的子目錄中出現(xiàn)。這些文件必須帶有擴(kuò)展.sql，但擴(kuò)展不能被包括在 makefile 的REGRESS列表中。對(duì)每一個(gè)測(cè)試還應(yīng)該在名為expected/的子目錄中有一個(gè)包含預(yù)期輸出的文件，它具有和腳本文件相同的詞干并帶有擴(kuò)展.out。make installcheck會(huì)用 psql執(zhí)行每一個(gè)測(cè)試腳本，并且將得到結(jié)果輸出與相應(yīng)的預(yù)期輸出比較。任何區(qū)別都將以diff -c格式寫入到文件regression.diffs中。注意嘗試運(yùn)行一個(gè)不帶預(yù)期文件的測(cè)試將被報(bào)告為“故障”，因此確保你擁有所有的預(yù)期文件。

ISOLATION變量中列出的腳本用于測(cè)試強(qiáng)調(diào)與模塊并發(fā)會(huì)話的行為，可以在make install之后通過make installcheck 調(diào)用。 要實(shí)現(xiàn)這個(gè)工作，你必須有一個(gè)正在運(yùn)行的PostgreSQL服務(wù)器。 ISOLATION中列出的腳本文件必須顯示在擴(kuò)展名目錄中名為 specs/的子目錄中。 這些文件必須具備擴(kuò)展名.spec，并且不得包含在 makefile 中的ISOLATION列表中。 對(duì)于每個(gè)測(cè)試，在名為expected/的子目錄中還應(yīng)該有一個(gè)包含預(yù)期輸出的文件，并且具有相同的詞干和擴(kuò)展名 .out。 make installcheck執(zhí)行每個(gè)測(cè)試腳本，并將結(jié)果輸出與匹配的預(yù)期文件進(jìn)行比較。 任何差異都將以diff -c的格式寫入到output_iso/regression.diffs文件中。 請(qǐng)注意，嘗試運(yùn)行缺少其預(yù)期文件的測(cè)試將會(huì)報(bào)告“trouble”，因此請(qǐng)確保你具有全部的預(yù)期文件。

TAP_TESTS 啟用TAP測(cè)試. 每個(gè)運(yùn)行中的數(shù)據(jù)都存在于名為 tmp_check/的子目錄中。 更多詳細(xì)信息，請(qǐng)參閱第 32.4 節(jié)