CREATE FUNCTION

説明

CREATE FUNCTION によって Postgres ユーザがデータベースに 関数を登録することができます。続いて、このユーザは その関数の所有者であるとみなされます。

使用方法

単純な SQL 関数を作成するのは以下のようにします。

CREATE FUNCTION one() RETURNS int4
    AS 'SELECT 1 AS RESULT'
    LANGUAGE 'sql';
SELECT one() AS answer;

     answer 
--------
      1
    
   

この例はユーザ作成の共有ライブラリからルーチンを呼び出すことにより C 関数を作成します。この特定のルーチンはチェック桁数を計算し、 もし巻数パラメータ中のチェック桁数が正しければ TRUE を返します。 これは CHECK 制約の中で使われることが意図されています。

CREATE FUNCTION ean_checkdigit(bpchar, bpchar) RETURNS boolean
    AS '/usr1/proj/bray/sql/funcs.so' LANGUAGE 'c';
    
CREATE TABLE product (
    id        char(8) PRIMARY KEY,
    eanprefix char(8) CHECK (eanprefix ~ '[0-9]{2}-[0-9]{5}')
                      REFERENCES brandname(ean_prefix),
    eancode   char(6) CHECK (eancode ~ '[0-9]{6}'),
    CONSTRAINT ean    CHECK (ean_checkdigit(eanprefix, eancode))
);
  

この例は、ユーザ定義型 complex と内部型 point 間での 型変換を行なう関数を作成します。その関数は C のソースからコンパイル された動的にロードされるオブジェクトによって実装されています。 Postgres が型変換関数を自動的に 見つけるためには、SQL 関数が返り値の型と同じ名前を持っていなければ ならないため、オーバーロードは避けることができません。その関数名 は SQL 定義中の AS 句の二番目の形式を 使ってオーバーロードされます。

CREATE FUNCTION point(complex) RETURNS point
    AS '/home/bernie/pgsql/lib/complex.so', 'complex_to_point'
    LANGUAGE 'c';
  

その関数の C 宣言は以下です。

Point * complex_to_point (Complex *z)
{
	Point *p;

	p = (Point *) palloc(sizeof(Point));
	p->x = z->x;
	p->y = z->y;
		
	return p;
}
  

互換性

CREATE FUNCTION name
    ( [ [ IN | OUT | INOUT ] type [, ...] ] )
     RETURNS rtype
     LANGUAGE 'langname'
     ESPECIFIC routine
     SQL-statement