---

Orafce ホームページへようこそ

Oracle 互換関数

---

orafce の目的は Oracle Database で使用できる関数と互換性のある関数を PostgreSQL に実装することです。 日付関数 (next_day, last_day, trunc, round, ...), 文字列関数とパッケージ (DBMS_ALERT, DBMS_OUTPUT, UTL_FILE, DBMS_PIPE, ...) の大部分はすでに実装済みです。 Oracle 10g と同様の動作をするよう検証されています。 このモジュールは、Oracle から PostgreSQL へのデータベース移行で役に立ちます。

この orafce プロジェクトは PostgreSQL コミュニティによる pgFoundry の中のプロジェクトです。

• ダウンロード : ソースコードのほか、Windows 用バイナリもダウンロードできます。
• バグレポート
• メーリングリスト への参加

日本語以外のドキュメントは、下記のリンクを参照してください。

• 英語 (wiki)
• チェコ語 (wiki)

Oracle Database での動作については以下のリンクを参照してください。

• Oracle 10g R2 : ファンクション
• SHIFT the Oracle : 関数一覧

1. インストール
2. 注意：互換性の無い箇所
3. 一般関数
   1. 日付関数
   2. nlssort 関数
   3. 文字列関数
   4. その他の関数
4. DBMS_ALERT
5. DBMS_OUTPUT
6. UTL_FILE
7. DBMS_PIPE
8. DBMS_ASSERT
9. DBMS_UTILITY
10. PLVision フレームワーク
    1. PLVdate
    2. PLVstr
    3. PLVchr
    4. PLVsubst
    5. PLVlex
    6. PLUnit

インストール

インストール方法は、一般的な PostgreSQL の contrib モジュールと同様です。 orafce の書庫を contrib ディレクトリの中で展開し、orafce ディレクトリへ入ります。 make, make install を行ってライブラリがインストールします。 その後、データベースへ登録するために orafunc.sql スクリプトを実行します。

cp orafce-2.0.1-preview.tgz /usr/loca/src/pgsql/contrib
cd /usr/local/src/pgsql/contrib
tar xvfz orafce-2.0.8-pre.tgz
cd orafce
make
make install
# make installcheck
psql mojedb
\i orafunc.sql
SELECT next_day(current_date,'saturday');

注意：互換性の無い箇所

以下の処理に、Oracle との互換性が無いことが確認されています。 これらは ToDo 項目でもあります。

to_date() での spth 書式が存在しない。

現在 to_date() は PostgreSQL の関数を流用していますが、独自に再実装する必要があります。

to_date() での月、日のオーバーフローがエラーにならない。

例えば「13月」は、PostgreSQL では翌年1月になりますが、Oracle ではエラーになります。

一般関数

orafce は追加の一般関数を提供します。 PostgreSQL が既にサポートしている関数については「関数と演算子」を参照して下さい。

日付関数

orafce は追加の日付関数を提供します。 PostgreSQL が既にサポートしている日付関数については「日付/時刻関数と演算子」を参照して下さい。

SELECT add_months(date '2005-05-31',1);  -- > 2005-06-30
SELECT last_day(date '2005-05-24');      -- > 2005-05-31
SELECT next_day(date '2005-05-24', 'monday'); -- > 2005-05-30
SELECT next_day(date '2005-05-24', '月曜日'); -- > 2005-05-30
SELECT next_day(date '2005-05-24', 2); -- > 2005-05-30
SELECT months_between(date '1995-02-02', date '1995-01-01'); -- > 1.0322580645161
SELECT trunc(date '2005-07-12', 'iw');   -- > 2005-07-11
SELECT round(date '2005-07-12', 'yyyy'); -- > 2006-01-01

trunc(), round() 関数の引数の変換書式には、下記の表に示した書式が使用できます。

関数で端数が丸められる場合、年の場合は 7月1日、月の場合は 16日、週の場合は木曜日が境界になります。

nlssort 関数

ロケール (locale) に基づいた文字列の比較を行う場合、データベース (8.4～) またはデータベース・クラスタ (～8.3) 単位で同一のロケールを使用する必要があります。 nlssort 関数を使用すると、文字列の比較ごとに異なるロケールを使用する (COLLATE) ことができます。 使用するロケールは nlssort 関数の引数として渡すか、先に set_nls_sort で設定しておきます。

設定するロケールは必ずサーバの文字エンコーディングと一致させてください。 例えば、文字エンコーディングとして eucjp を使用している場合、ja_JP.utf-8 は不適切であり、ja_JP.eucJP を使う必要があります。

SELECT * FROM peoples ORDER BY nlsstring(surname, 'de_DE.UTF-8');
SELECT set_nls_sort('cs_CZ.UTF-8');
SELECT * FROM peoples ORDER BY nlsstring(surname);

文字列関数

PostgreSQL が既にサポートしている文字列関数については「文字列関数と演算子」を参照して下さい。

これらの関数は Oracle からの移植の際にできる限りコードの書き換えを避けたい場合にのみ使用してください。 より適切な方法は、標準SQLで規定されている関数に置き換えることです。

oracle.substr() は pg_catalog.substr() を残したままインストールされます。 デフォルトのスキーマ検索の順序では pg_catalog のほうが優先度が高いため、orafce 版の substr() を使うためには 設定パラメータ search_path を 'oracle, pg_catalog, "$user", public' と変更する必要があります。

その他の関数

nvl() や decode() は、Oracle からの移植の際にできる限りコードの書き換えを避けたい場合にのみ使用してください。 より適切な方法は、標準SQLで規定されている COALESCE や CASE に置き換えることです。

decode()に関する注意 : decode() 関数は、任意の型を引数として与えることができます。 しかし、PostgreSQL 母体の制限により、最初から全ての型を扱うことができません。 予め char, varchar, text, integer, bigint, numeric, time, date, timestamp, timestamp with time zone については定義されていますが、これ以外の型を返却したい場合には、orafce のインストール後に定義を追加してください。 circlr 型に対応した、引数5個のバージョン decode() の定義を以下に示します。 内部関数 ora_decode() 自体は任意の個数の任意の型に対応しており、引数の数や型によらず ora_decode を指定できます。 詳しくは orafunc.sql の decode() の定義も参考にして下さい。

CREATE  FUNCTION decode(anyelement, anyelement, circle, anyelement, circle)
RETURNS circle
AS 'MODULE_PATHNAME', 'ora_decode'
LANGUAGE C IMMUTABLE;

DBMS_ALERT

このパッケージは非同期のアラートを扱います。 この機能は PostgreSQL の LISTEN / NOTIFY と似ていますが、サーバ内でのみアラートを使用できます。

このパッケージが dbms_pipe パッケージと異なる点は、複数の受信者に対してメッセージを送信できることです。 dbms_pipe は 2つのセッション間の双方向通信に使用し、dbms_alert は1つのセッションから複数の別セッションへの単方向通信として使用するのに適しています。

-- session pavel
pavel# SELECT dbms_alert.register('ahoj');
pavel# SELECT * FROM dbms_alert.waitany(NULL);

-- session root
root# SELECT dbms_alert.signal('ahoj','Gertrudo');

メッセージは操作のたびに送信されます。 これは、トランザクションの完了時に送信が行われる LISTEN / NOTIFY や Oracle での動作と異なります。 動作の違いにより、以下のような問題が生じるかもしれません：

• メッセージを送信した後にトランザクションがロールバックした場合でも、受信者はメッセージを受け取る可能性があります。これを回避するには AFTER TRIGGER でメッセージを送信するようにします。
• メッセージを受信した直後では、送信者が行ったデータの変更が見えない可能性があります。送信者のトランザクションは、受信した時点ではまだコミットされていない場合があるためです。

DBMS_OUTPUT

このパッケージは Oracle の PL/SQL で使用される通知の機能を移植したものです。 PostgreSQL の PL/pgSQL にも同様の機能として RAISE NOTICE があります。

PostgreSQL はプロトコル層で通知メッセージを扱えます。 サーバが非同期メッセージを送信すると、クライアントはそのメッセージをすぐに受信します。 そのため、Oracle での動作と比較するとメッセージを受けとるタイミングが異なる場合があります。 (Oracle ではトランザクションの終了時にメッセージをまとめて受信します。)

-- new session
SELECT dbms_output.enable();
SELECT dbms_output.put_line('first_line');
SELECT dbms_output.put_line('next_line');
SELECT * from dbms_output.get_lines(0);

-- new sesion
SELECT dbms_output.serveroutput('on');
SELECT dbms_output.put_line('first_line');

Oracle と同様に、複数のメッセージがある場合にはまとめて送信されます。 受信者は 1回のシグナルで複数のメッセージを受信することになります。

UTL_FILE

このパッケージはテキストファイルの操作（読み書き）を提供します。 ファイルの操作はC言語のストリーム (FILE) 操作に似た形式です。 ファイルの読み書きが可能なディレクトリを制限できるため、適切なアクセス制限を行っていればこのパッケージを利用してもセキュリティ上の問題はありません。

• 予め utl_file.utl_file_dir テーブルでアクセスを許可するディレクトリのパスを指定する必要があります。
  • 指定したディレクトリと、それよりも下位のディレクトリへアクセスできるようになります。
  • Oracle と互換性の無い箇所です。Oracle では CREATE DIRECTORY を使用します。
• 提供する API は Oracle に倣っていますが若干の差異があり、PL/pgSQL での出力引数 (OUT, INOUT) の使い方が異なります。
• 1セッションで最大50個のファイルを同時に開くことができます。
• テキストの1行の長さは最大で 32kB です。
• セッションを終了するとそのセッションで使用していたすべてのファイルは自動的に閉じられます。また、1個ずつまたはすべてのファイルを明示的に閉じることもできます。

CREATE OR REPLACE FUNCTION read_file(loc text, filename text)
RETURNS SETOF text AS $$
DECLARE
  f utl_file.file_type;
BEGIN
  f := utl_file.fopen(loc, filename, 'r');
  LOOP
    RETURN NEXT utl_file.get_line(f);
  END LOOP;
EXCEPTION 
  WITH NO_DATA_FOUND THEN
    f := utl_file.fclose(f);
    RETURN;
  WITH OTHERS THEN
    IF utl_file.is_open(f) THEN
      f := utl_file.fclose(f);
    END IF;
    RAISE EXCEPTION '%', SQLERRM;
END;
$$ LANGUAGE plpgsql VOLATILE;

DBMS_PIPE

このパッケージは非同期のセッション間通信の機能を提供します。 PostgreSQL 単体ではセッション間通信に相当する機能はありません。 通信メッセージは空または任意の数の値を含みます。 値は共有メモリの許す限りいくつでも含むことができます。 このパッケージの用途は、試験 (デバッグレポートの転送) や、PL/pgSQL を使用するアプリケーションでクライアント･サーバ型のアーキテクチャを模すことです。 作成可能なパイプには private と public の2種類があります。 public パイプは誰でも操作することができます。

同様にセッション間通信機能を提供する dbms_alert パッケージとの主な違いは以下です：

• 複数のメッセージをまとめることはありません。
• 操作の完了を待ちません。
• メッセージを受信できるのは1つのセッションのみです。
• メッセージは型情報を持ったまま転送されます。(送信セッションと受信セッションで文字エンコーディングが異なる場合、アプリケーションで変換を行う必要があります。)

-- Session A
SELECT dbms_pipe.pack_message(CURRENT_DATE);
SELECT dbms_pipe.pack_message('Servus, Rupert');
SELECT dbms_pipe.send_message('boo',4,10);

-- Session B
SELECT dbms_pipe.receive_message('boo',4);
SELECT dbms_pipe.unpack_message_date();
SELECT dbms_pipe.unpack_message_text();

Oracle では OUT 引数の違いによる関数のオーバーロードが可能ですが、PostgreSQL ではできません。 そのため、unpack_message 関数を、関数名の末尾に _text, _date, _timestamp, _number, _bytea, _record が追加された複数の関数に分割しています。

RECORD 型を転送するサンプルコードを以下に示します。

CREATE TYPE info AS (x integer, y integer);

CREATE OR REPLACE FUNCTION send_info(x int, y int)
RETURNS void AS $$
DECLARE i info;
BEGIN i.x := x; i.y := y;
  PERFORM dbms_pipe.pack_message(i);
  PERFORM dbms_pipe.send_message('info');
END;
$$ LANGUAGE plpgsql;

CREATE OR REPLACE FUNCTION get_info() 
RETURNS info AS $$
DECLARE i info;
BEGIN
  PERFORM dbms_pipe.receive_message('boo');
  SELECT INTO i * FROM dbms_pipe.unpack_message_record() AS (x integer, y integer);
  RETURN i;
END;
$$ LANGUAGE plpgsql;

Oracle と比較して以下の違いがあります。

• パイプの容量制限はバイト数ではなくメッセージ数で指定します。
• タイムアウト値が 0 のメッセージを送信できます。
• 空のメッセージを送信できます。
• next_item_type 関数は TIMESTAMP (13) と RECORD(24) も返却します。
• RAW 型はサポートされません。代わりに BYTEA(23) が使用できます。

使用中のパイプの情報は dbms_pipe.db_pipes ビューから参照できます。

postgres=# SELECT * from dbms_pipe.db_pipes;
 name | items | size | limit | private | owner
------+-------+------+-------+---------+-------
 boo  |     1 |   32 |       | f       |
(1 row)

DBMS_ASSERT

このパッケージは SQL インジェクションを防ぐために使用されます。

DBMS_UTILITY

コールスタックを取得する関数を提供します。

PLVision フレームワーク

このパッケージは PLVision フレームワーク (サードパーティ制の PL/SQL 拡張ライブラリ) を部分的に実装しています。

PLVdate

このパッケージはカレンダーを操作する関数を含みます。 カレンダーは用途に応じて自由にカスタマイズできます（休日や土曜出勤など）。 For convenience the distribution contents calendars for Bohemian, all neighbour countries and some other. Our own holidays or spare-time days can be input in the calendar.

SELECT plvdate.plvdate.default_holydays('czech');
SELECT plvdate.add_bizdays(CURRENT_DATE, 10); 
SELECT plvdate.isbizday('2006-12-25');
SELECT plvdate.set_nonbizday('Friday');

PLVstr

PLVision には数十個の文字列と文字を操作する関数が含まれますが、orafce モジュールはその中から一般的な関数のみを実装しています。 含まないのは、PL 関数のソースコードを解析する関数などです。 提供される関数で特徴的なのは、文字列中の位置として負の値をサポートすることです。 位置として負の値を与えた場合、文字列の先頭からではなく、末尾から数えた位置を指定することになります。

plvstr.left('abcdef',2)      -> ab
plvstr.left('abcdef',-2)     -> abcd
plvstr.substr('abcdef',1,1)  -> a
plvstr.substr('abcdef',-1,1) -> f
plvstr.substr('abcde',-2,1)  -> d

PLVchr

PLVsubst

このパッケージは文字列中のシンボルを置換する関数を提供します。 用途としては、ヘルプ文字列、エラーメッセージ、ログなどの整形があります。 置換するシンボルの初期値は '%s' ですが、セッションごとに変更することもできます。 置換後の文字列は、配列または区切り文字 (初期値は ',') で連結した文字として与えます。

postgres=# SELECT plvsubst.string('My name is %s %s', ARRAY['Pavel','Sthule']);
          string
-------------------------
 My name is Pavel Sthule
(1 row)

PLVlex

このパッケージは1個の関数を含み、SQL 文字列のトークンを表として返します。 code 値は PostgreSQL のバージョンごとに異なる値になる場合もあります。

postgres=# SELECT * FROM plvlex.tokens('SELECT t.* FROM tabulka t WHERE t.i = 10',true, true);
 pos |  token  | code |  class  | separator | mod  
-----+---------+------+---------+-----------+------
   0 | select  |  527 | KEYWORD |           | 
   7 | t       |      | IDENT   |           | 
   8 | .       |   46 | OTHERS  |           | self
   9 | *       |   42 | OTHERS  |           | self
  11 | from    |  377 | KEYWORD |           | 
  16 | tabulka |      | IDENT   |           | 
  24 | t       |      | IDENT   |           | 
  26 | where   |  591 | KEYWORD |           | 
  32 | t.i     |      | IDENT   |           | 
  36 | =       |   61 | OTHERS  |           | self
  38 | 10      |      | NCONST  |           | i
(11 rows)

PLUnit

このパッケージは診断（ユニットテスト）用の関数を含みます。

バグ、非互換性、関数やパッケージの追加要望は、メーリングリスト または フォーラム へお願いします。