PostgreSQLでのサーバーサイドプログラミングの概要

Postgresサーバーに事前定義されたコードを実行させる方法はたくさんあります。以下は、Postgresサーバーに事前定義されたロジックを保存させる方法の例を含む包括的なリストです。これは後でアプリケーションから使用できます。

SQL関数

Postgresを使用すると、サポートされている言語で関数本体を記述できる「ユーザー定義関数」を作成できます。 「SQL関数」は、通常のSQLで記述されたユーザー定義関数であり、複雑なクエリとSQLステートメントのシーケンスをカプセル化する最も簡単な方法です。

次にいくつかの例を示します。

-- update item price and record the change
CREATE FUNCTION update_price(item text, newprice numeric) RETURNS void AS $$
    UPDATE items SET price=$2 WHERE name=$1;
    INSERT INTO audit (event, new_price, at, item)
      VALUES ('price changed', $2, now(), $1);
$$ LANGUAGE SQL;

-- a function from uuid-osp
CREATE FUNCTION uuid_timestamp_bits(uuid) RETURNS varbit AS
$$ SELECT ('x' || substr($1::text, 15, 4) || substr($1::text, 10, 4) ||
           substr($1::text, 1, 8) || substr($1::text, 20, 4))::bit(80)
          & x'0FFFFFFFFFFFFFFF3FFF' $$
LANGUAGE SQL STRICT IMMUTABLE;

SQL関数は、基本型、複合型、および行を受け入れて返すことができます。また、可変数の引数、引数および多態性引数のデフォルト値もサポートしています。テーブルからのSELECTを模倣して、複数の行を返すこともできます。また、何も返却する必要はありません。

ただし、関数本体にはSQLステートメントのみを含めることができます。これは、フロー制御ステートメント（if、while、…）、変数などがないことを意味します。

CREATE FUNCTIONコマンドは、関数を作成するために使用されます。いつものように、ALTERとDROPthemを実行できます。

これは、さらに掘り下げるのに最適な場所です：https：//www.postgresql.org/docs/current/xfunc-sql.html

C関数

SQL関数は最も簡単に記述でき、最も強力ではありませんが、逆に、関数はCで記述でき、ほとんど何でもできます。このような関数はCでコーディングし、Postgresによって動的にロードできる共有ライブラリとして構築する必要があります。

共有ライブラリをロードする場所、関数の名前と署名をPostgresに指示する必要があります：

CREATE FUNCTION sum(integer, integer) RETURNS integer
    AS 'myfuncs', 'sum'
    LANGUAGE C STRICT;

これは、共有ライブラリmyfuncs.so は、事前定義された検索パスに存在し、Postgresによって呼び出すことができるエントリポイントを含みます。エントリポイントの1つは、関数として呼び出すことができる「合計」です。

Cの実際のコードは長すぎてここに含めることはできませんが、ドキュメントですべてを読むことができます。サーバープログラミングインターフェイス（SPI）と組み合わせると、他の方法で実行できるほとんどすべての操作を実行できます。

たとえば、ここで定義されているC関数を使用すると、HTTPリクエストを実行できます。

SELECT status, content_type FROM http_get('https://postgresql.org/');

このような共有ライブラリをC++やGoなどの他の言語で記述して、「C」リンケージを使用して共有ライブラリを構築することもできます。

PL/pgSQL関数

SQLとC以外に、手続き型言語で関数を記述できます。 。このような4つの言語はコアPostgreSQLでサポートされています– pgSQL、Python、Perl、Tcl。手続き型言語自体のサポートはC共有ライブラリから提供され、 mod_perlのように動作します。 またはmod_python アパッチ時代から。

pgSQL は、PostgreSQLの保存された関数が記述されている、標準的な、最も使用されているSQLのような言語です。 template1にインストールされているため、デフォルトで使用できます。 。

PL / pgSQLは、変数、式、および制御ステートメントを備えた本格的な言語です。特にSQLデータを操作するためのカーソルなどの機能が含まれています。ここに詳細に記載されています。

次に例を示します：

CREATE FUNCTION repeat(times integer, s text)
    RETURNS text
    AS $$
DECLARE
    result text;
BEGIN
    result := '';
    FOR i IN 1..times LOOP
        result := result || s;
    END LOOP;
    RETURN result;
END;
$$
LANGUAGE plpgsql
IMMUTABLE;

-- psql> SELECT repeat(10, '*');
--    repeat
-- ------------
--  **********
-- (1 row)

sudo apt install postgresql-plpython-11

CREATE EXTENSION plpythonu;

CREATE FUNCTION pymax (a integer, b integer)
  RETURNS integer
AS $$
  if a > b:
    return a
  return b
$$ LANGUAGE plpythonu;

CREATE FUNCTION perl_max (integer, integer) RETURNS integer AS $$
    my ($x, $y) = @_;
    if (not defined $x) {
        return undef if not defined $y;
        return $y;
    }
    return $x if not defined $y;
    return $x if $x > $y;
    return $y;
$$ LANGUAGE plperl;

CREATE FUNCTION tcl_max(integer, integer) RETURNS integer AS $$
    if {[argisnull 1]} {
        if {[argisnull 2]} { return_null }
        return $2
    }
    if {[argisnull 2]} { return $1 }
    if {$1 > $2} {return $1}
    return $2
$$ LANGUAGE pltcl;

SELECT stddev_pop(grade) FROM students;

-- from https://wiki.postgresql.org/wiki/Aggregate_Median
CREATE OR REPLACE FUNCTION _final_median(NUMERIC[])
   RETURNS NUMERIC AS
$$
   SELECT AVG(val)
   FROM (
     SELECT val
     FROM unnest($1) val
     ORDER BY 1
     LIMIT  2 - MOD(array_upper($1, 1), 2)
     OFFSET CEIL(array_upper($1, 1) / 2.0) - 1
   ) sub;
$$
LANGUAGE 'sql' IMMUTABLE;
 
CREATE AGGREGATE median(NUMERIC) (
  SFUNC=array_append,
  STYPE=NUMERIC[],
  FINALFUNC=_final_median,
  INITCOND='{}'
);

SELECT median(grade) FROM students;

CREATE OPERATOR + (
    leftarg = complex,
    rightarg = complex,
    function = complex_add,
    commutator = +
);

-- first create the function
CREATE FUNCTION log_update() RETURNS TRIGGER AS $$
    INSERT INTO audit (event, new_price, at, item)
      VALUES ('price changed', NEW.price, now(), OLD.item);
$$
LANGUAGE plpgsql;

-- then create the trigger
CREATE TRIGGER audit_price_changes
    AFTER UPDATE ON items
    FOR EACH ROW
    WHEN (OLD.price IS DISTINCT FROM NEW.price)
    EXECUTE FUNCTION log_update();

-- create function first
CREATE FUNCTION nodrop() RETURNS event_trigger LANGUAGE plpgsql AS $$
BEGIN
    IF EXISTS(
      SELECT 1
      FROM pg_event_trigger_dropped_objects() AS T
      WHERE T.schema_name = 'audit')
    THEN
      RAISE EXCEPTION 'not allowed to drop objects in audit schema';
    END IF;
END $$;

-- create event trigger
CREATE EVENT TRIGGER trigger_nodrop
    ON sql_drop
    EXECUTE FUNCTION nodrop();

-- make inserts into "items" table a no-op
CREATE RULE rule1 AS ON INSERT TO items DO INSTEAD NOTHING;

-- make inserts go elsewhere
CREATE RULE rule2 AS ON INSERT TO items DO INSTEAD
    INSERT INTO items_pending_review VALUES (NEW.name, NEW.price);

CREATE PROCEDURE check_commit(v integer)
LANGUAGE plpgsql AS $$
BEGIN
    IF v % 2 = 0 THEN
        COMMIT;
    ELSE
        ROLLBACK;
    END IF;
END $$;

-- call it
CALL check_commit(10);