PostgreSQLでユーザー定義関数をつくってみよう

/*
ほとんどのPostgreSQLの内部型はpostgres.hに宣言されています。
一方、関数管理インタフェース（PG_FUNCTION_ARGSなど）はfmgr.hで宣言されています。
したがって、少なくともこの2つのファイルをincludeする必要があります。
https://www.postgresql.jp/document/14/html/xfunc-c.html#id-1.8.3.14.9

これらは /{path_to_pgsql}/pgsql/include/server 以下にあります。
（もしくは /usr/include/postgresql/(version)/server/ 以下にあります）
include時にはファイル名のみ書いておいて、
gccでコンパイル時に -I オプションで参照先ディレクトリを指定することができます。
*/
#include "postgres.h"
#include "fmgr.h"

/*
確実に、動的にロードされるモジュールが互換性がないサーバにロードされないように、
PostgreSQLは、そのファイルに適切な内容を持つ「マジックブロック」が含まれているかどうか検査します。
https://www.postgresql.jp/document/14/html/xfunc-c.html#id-1.8.3.14.6.11

2回以上記述するとエラーとなるので注意が必要です。複数ファイルを一つのsoファイルにまとめるときも全体で1回だけ記述します。
*/
PG_MODULE_MAGIC;

/*
現在、1つの呼び出し規約だけがC言語関数で使用されています(「version 1」)。
その呼び出し規約をサポートしていることは、以下に示すように、
その関数用に呼び出しマクロPG_FUNCTION_INFO_V1()を書くことで示されます。
https://www.postgresql.jp/document/14/html/xfunc-c.html#id-1.8.3.14.3
*/
PG_FUNCTION_INFO_V1(echo);

/*
Version-1呼び出し規約では、引数と結果の引き渡しの複雑さをなくすためにマクロを使用しています。
Version-1関数のC言語宣言は必ず下記のように行います。
Datum funcname(PG_FUNCTION_ARGS)
https://www.postgresql.jp/document/14/html/xfunc-c.html#id-1.8.3.14.8
*/
Datum echo(PG_FUNCTION_ARGS) {
	/*
	Version-1関数では、それぞれの実引数は、引数のデータ型に合ったPG_GETARG_xxx()マクロを使用して取り出されます。
	https://www.postgresql.jp/document/14/html/xfunc-c.html#id-1.8.3.14.8
    
	TEXT型はpostgresqlのカスタム型で pgsql/include/server/c.h で定義されています。制限なし可変長の文字列。
	*/
	text *input1 = PG_GETARG_TEXT_P(0);

	/*
	PG_RETURN_xxx()は、その引数として、実際に返す値を取ります。
	https://www.postgresql.jp/document/14/html/xfunc-c.html#id-1.8.3.14.8
	*/
	PG_RETURN_TEXT_P(input1);
}

#include "postgres.h"
#include "fmgr.h"

PG_MODULE_MAGIC;

PG_FUNCTION_INFO_V1(echo);

Datum echo(PG_FUNCTION_ARGS) {
	text *input1 = PG_GETARG_TEXT_P(0);
	PG_RETURN_TEXT_P(input1);
}

gcc echo.c -shared -o echo.so -I /{path_to_pgsql}/pgsql/include/server

CREATE DATABASE cfunction_study TEMPLATE template0;

CREATE OR REPLACE FUNCTION echo(text)
RETURNS text
AS '/{path_to_so_file}/echo.so'
LANGUAGE C
;

SELECT echo('Yes We Can.');

DROP TABLE IF EXISTS ramen_price;
CREATE TABLE ramen_price (
	ramen_name text NOT NULL,
	tax_excluded_price integer NOT NULL,
	keigen_rate_flg character(1) NOT NULL
);
INSERT INTO ramen_price	VALUES
	(
		'CUP RAMEN'
		,168
		,'1'
	)
	,(
		'OMISE NO RAMEN'
		,836
		,'0'
	)
;

    ramen_name    | tax_included_price
------------------+--------------------
 CUP RAMEN        |                181
 OMISE NO RAMEN   |                920
(2 rows)

gcc echo.c -shared -o echo.so -I /{path_to_pgsql}/pgsql/include/server

MODULES = add_tax

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

make

# postgresユーザーで実行（ほかのユーザーだと書き込み権限がないはず）
make install

CREATE OR REPLACE FUNCTION add_tax(int4, int4)
RETURNS int4
AS '/{path_to_pgsql}/pgsql/lib/add_tax.so'
LANGUAGE C
;

comment = 'add_tax is a function for adding consumption tax.'
default_version = '1.0'
module_pathname = '$libdir/add_tax'

CREATE OR REPLACE FUNCTION add_tax_extension(int4, int4)
RETURNS int4
AS 'MODULE_PATHNAME', 'add_tax'
LANGUAGE C
;

EXTENSION = add_tax
DATA = add_tax--1.0.sql

MODULES = add_tax
EXTENSION = add_tax
DATA = add_tax--1.0.sql

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

cfunction_study=# create extension add_tax;
CREATE EXTENSION
cfunction_study=# SELECT
        ramen_name
        ,add_tax_extension(
                tax_excluded_price
                ,keigen_rate_flg::integer -- 文字列比較より数値比較のほうが簡単なのでCAST
        ) AS tax_included_price
FROM ramen_price
;
    ramen_name    | tax_included_price
------------------+--------------------
 CUP RAMEN        |                181
 OMISE NO RAMEN   |                920
(2 rows)

cfunction_study=# \dx
                            List of installed extensions
  Name   | Version |   Schema   |                    Description
---------+---------+------------+---------------------------------------------------
 add_tax | 1.0     | public     | add_tax is a function for adding consumption tax.
 plpgsql | 1.0     | pg_catalog | PL/pgSQL procedural language
(2 rows)

cfunction_study=# \dx+ add_tax
       Objects in extension "add_tax"
             Object description
---------------------------------------------
 function add_tax_extension(integer,integer)
(1 row)