バージョンごとのドキュメント一覧

CREATE RULE

CREATE RULE <refpurpose>define a new rewrite rule</refpurpose> — 新しい書き換えルールを定義する

概要

CREATE [ OR REPLACE ] RULE name AS ON event
    TO table_name [ WHERE condition ]
    DO [ ALSO | INSTEAD ] { NOTHING | command | ( command ; command ... ) }


<phrase>where <replaceable class="parameter">event</replaceable> can be one of:</phrase>

ここでeventは以下のうちの1つです。

    SELECT | INSERT | UPDATE | DELETE

説明

<title>Description</title>

<command>CREATE RULE</command> defines a new rule applying to a specified table or view. <command>CREATE OR REPLACE RULE</command> will either create a new rule, or replace an existing rule of the same name for the same table. CREATE RULEにより、指定したテーブルまたはビューに適用するルールを新しく定義できます。 CREATE OR REPLACE RULEを使用すると、新しいルールの作成、または、同じテーブルの同じ名前の既存ルールの置き換えのいずれかを実行します。

The <productname>PostgreSQL</productname> rule system allows one to define an alternative action to be performed on insertions, updates, or deletions in database tables. Roughly speaking, a rule causes additional commands to be executed when a given command on a given table is executed. Alternatively, an <literal>INSTEAD</literal> rule can replace a given command by another, or cause a command not to be executed at all. Rules are used to implement SQL views as well. It is important to realize that a rule is really a command transformation mechanism, or command macro. The transformation happens before the execution of the command starts. If you actually want an operation that fires independently for each physical row, you probably want to use a trigger, not a rule. More information about the rules system is in <xref linkend="rules"/>. PostgreSQLのルールシステムを使用すると、データベーステーブルに対する挿入、更新、削除時に本来の操作の代替として実行するアクションを定義できます。 簡単に言えば、指定されたテーブルに対して指定されたコマンドが実行された時、ルールによって追加のコマンドが実行されるということです。 その他にも、INSTEADルールによって指定されたコマンドを他のコマンドに置き換えたり、まったくコマンドを実行しないようにすることも可能です。 また、ルールはSQLビューを実装するためにも使われます。 重要なのは、ルールとは実際にコマンドを変換する仕組み、言い換えれば、コマンドのマクロであることです。 ルールによる変換はコマンドの実行前に発生します。 各物理行を個別に操作したい場合、ルールではなくトリガを使用する方が良いでしょう。 ルールシステムについての詳細は、第39章に記載されています。

Presently, <literal>ON SELECT</literal> rules can only be attached to views. Such a rule must be named <literal>"_RETURN"</literal>, must be an unconditional <literal>INSTEAD</literal> rule, and must have an action that consists of a single <command>SELECT</command> command. This command defines the visible contents of the view. (The view itself is basically a dummy table with no storage.) It's best to regard such a rule as an implementation detail. While a view can be redefined via <literal>CREATE OR REPLACE RULE "_RETURN" AS ...</literal>, it's better style to use <literal>CREATE OR REPLACE VIEW</literal>. 現時点では、ON SELECTルールはビューにのみ付けられます。 このようなルールは"_RETURN"という名前で、無条件のINSTEADルールでなければならず、単一のSELECTコマンドからなるアクションを持っていなければなりません。 このコマンドは、ビューの表示内容を定義します。 (ビュー自体は基本的に、ストレージを持たないダミーテーブルです。) このようなルールは、実装の詳細と見なすのが最善です。 ビューはCREATE OR REPLACE RULE "_RETURN" AS ...を使って再定義できますが、CREATE OR REPLACE VIEWを使う方が良いです。

You can create the illusion of an updatable view by defining <literal>ON INSERT</literal>, <literal>ON UPDATE</literal>, and <literal>ON DELETE</literal> rules (or any subset of those that's sufficient for your purposes) to replace update actions on the view with appropriate updates on other tables. If you want to support <command>INSERT RETURNING</command> and so on, then be sure to put a suitable <literal>RETURNING</literal> clause into each of these rules. ON INSERTON UPDATEON DELETEルールを必要に応じて定義し、ビューに対する更新操作を他のテーブルに対する適切な更新操作に置換することで、更新可能なビューという実在しないオブジェクトを作成することができます。 INSERT RETURNINGなどをサポートしたければ、これらのルールに適切なRETURNING句を確実につけてください。

There is a catch if you try to use conditional rules for complex view updates: there <emphasis>must</emphasis> be an unconditional <literal>INSTEAD</literal> rule for each action you wish to allow on the view. If the rule is conditional, or is not <literal>INSTEAD</literal>, then the system will still reject attempts to perform the update action, because it thinks it might end up trying to perform the action on the dummy table of the view in some cases. If you want to handle all the useful cases in conditional rules, add an unconditional <literal>DO INSTEAD NOTHING</literal> rule to ensure that the system understands it will never be called on to update the dummy table. Then make the conditional rules non-<literal>INSTEAD</literal>; in the cases where they are applied, they add to the default <literal>INSTEAD NOTHING</literal> action. (This method does not currently work to support <literal>RETURNING</literal> queries, however.) 複雑なビューの更新に条件付きルールを使用しようとする場合、落とし穴があります。 そのビューに許可するそれぞれの操作に、条件を持たないINSTEADルールを用意する必要があることです。 ルールが条件付きであったり、INSTEADでない場合、システムは更新操作を拒否します。 その場合、システムが、場合によっては、ビューのダミーテーブルに対する操作になる可能性があるとみなすからです。 使用する全てのケースについて条件付きルールを作成する場合は、条件を持たないDO INSTEAD NOTHINGルールを追加し、ダミーテーブルに対する更新は呼び出されないことをシステムに明示します。さらに、条件付きルールには、INSTEADと指定しないようにします。 これらの条件が満たされた場合、デフォルトのINSTEAD NOTHINGアクションにルールに含まれるアクションが追加されます。 (しかし現在、この方法ではRETURNING問い合わせのサポートがうまく動作しません。)

注記

A view that is simple enough to be automatically updatable (see <xref linkend="sql-createview"/>) does not require a user-created rule in order to be updatable. While you can create an explicit rule anyway, the automatic update transformation will generally outperform an explicit rule. 十分単純であり自動更新可能なビュー(CREATE VIEW参照)は、更新可能とするためにユーザ作成のルールを必要としません。 とにかく明示的なルールを作成することもできますが、自動更新による変形は明示的なルールよりも通常高速です。

Another alternative worth considering is to use <literal>INSTEAD OF</literal> triggers (see <xref linkend="sql-createtrigger"/>) in place of rules. 検討すべき別の方法は、ルールの代わりにINSTEAD OFトリガ(CREATE TRIGGER参照)を使うことです。

パラメータ

<title>Parameters</title>
name

The name of a rule to create. This must be distinct from the name of any other rule for the same table. Multiple rules on the same table and same event type are applied in alphabetical name order. 作成するルールの名前です。 この名前は、同じテーブルの他のルールとは異なる名前にする必要があります。 同一テーブルにイベントの種類が同じルールが複数あった場合、ルール名の順番(アルファベット順)に適用されます。

event

The event is one of <literal>SELECT</literal>, <literal>INSERT</literal>, <literal>UPDATE</literal>, or <literal>DELETE</literal>. Note that an <command>INSERT</command> containing an <literal>ON CONFLICT</literal> clause cannot be used on tables that have either <literal>INSERT</literal> or <literal>UPDATE</literal> rules. Consider using an updatable view instead. イベントとは、SELECTINSERTUPDATEDELETEのいずれかです。 ON CONFLICT句を含むINSERTは、INSERTルールまたはUPDATEルールのあるテーブルに対して使えないことに注意してください。 代わりに、更新可能ビューを利用することを検討してください。

table_name

The name (optionally schema-qualified) of the table or view the rule applies to. ルールを適用するテーブルまたはビューの名前です(スキーマ修飾名も可)。

condition

Any <acronym>SQL</acronym> conditional expression (returning <type>boolean</type>). The condition expression cannot refer to any tables except <literal>NEW</literal> and <literal>OLD</literal>, and cannot contain aggregate functions. 任意のSQL条件式です(boolean型を返します)。 条件式では、NEWおよびOLD以外のテーブルは参照できません。 また、集約関数を含めることもできません。

INSTEAD
<para><literal>INSTEAD</literal> indicates that the commands should be executed <emphasis>instead of</emphasis> the original command.

INSTEADは、元のコマンドの代わりにこのコマンドが実行されることを示します。

ALSO
<para><literal>ALSO</literal> indicates that the commands should be executed <emphasis>in addition to</emphasis> the original command.

ALSOは元のコマンドに加えてこのコマンドが実行されることを示します。

If neither <literal>ALSO</literal> nor <literal>INSTEAD</literal> is specified, <literal>ALSO</literal> is the default. ALSOINSTEADも指定されなかった場合、ALSOがデフォルトです。

command

The command or commands that make up the rule action. Valid commands are <command>SELECT</command>, <command>INSERT</command>, <command>UPDATE</command>, <command>DELETE</command>, or <command>NOTIFY</command>. ルールのアクションを構成する単一または複数のコマンドです。 有効なコマンドは、SELECTINSERTUPDATEDELETENOTIFYです。

Within <replaceable class="parameter">condition</replaceable> and <replaceable class="parameter">command</replaceable>, the special table names <literal>NEW</literal> and <literal>OLD</literal> can be used to refer to values in the referenced table. <literal>NEW</literal> is valid in <literal>ON INSERT</literal> and <literal>ON UPDATE</literal> rules to refer to the new row being inserted or updated. <literal>OLD</literal> is valid in <literal>ON UPDATE</literal> and <literal>ON DELETE</literal> rules to refer to the existing row being updated or deleted. conditioncommandの内部では、対象とするテーブルの値を参照するために、特別なテーブル名NEWOLDを使用できます。 NEWは、ON INSERTON UPDATEルールで有効で、挿入または更新される新しい行を参照します。 OLDは、ON UPDATEON DELETEルールで有効で、更新または削除される既存の行を参照します。

注釈

<title>Notes</title>

You must be the owner of a table to create or change rules for it. テーブルにルールを定義する、または、そのルールを変更するためには所有者でなければなりません。

In a rule for <literal>INSERT</literal>, <literal>UPDATE</literal>, or <literal>DELETE</literal> on a view, you can add a <literal>RETURNING</literal> clause that emits the view's columns. This clause will be used to compute the outputs if the rule is triggered by an <command>INSERT RETURNING</command>, <command>UPDATE RETURNING</command>, or <command>DELETE RETURNING</command> command respectively. When the rule is triggered by a command without <literal>RETURNING</literal>, the rule's <literal>RETURNING</literal> clause will be ignored. The current implementation allows only unconditional <literal>INSTEAD</literal> rules to contain <literal>RETURNING</literal>; furthermore there can be at most one <literal>RETURNING</literal> clause among all the rules for the same event. (This ensures that there is only one candidate <literal>RETURNING</literal> clause to be used to compute the results.) <literal>RETURNING</literal> queries on the view will be rejected if there is no <literal>RETURNING</literal> clause in any available rule. ビュー上のINSERTUPDATEDELETEルールでは、RETURNING句を追加して、ビューの列を返すことができます。 ルールがINSERT RETURNINGUPDATE RETURNINGDELETE RETURNINGコマンドによって呼び出された場合、この句は出力を計算することに使用されます。 RETURNINGなしでルールが呼び出された場合、ルールのRETURNING句は無視されます。 現在の実装では、無条件のINSTEADルールのみがRETURNINGを含むことができます。 さらに、同一イベント用のすべてのルールの中で多くても1つのRETURNING句を持つことができます。 (これにより確実に、結果を計算するために使用されるRETURNING句の候補が1つのみになります。) ビュー上のRETURNING問い合わせは、利用可能なルールのどれにもRETURNINGが存在しない場合に拒絶されます。

It is very important to take care to avoid circular rules. For example, though each of the following two rule definitions are accepted by <productname>PostgreSQL</productname>, the <command>SELECT</command> command would cause <productname>PostgreSQL</productname> to report an error because of recursive expansion of a rule: ルールの循環は絶対に避けるよう注意してください。 例えば、下記の2つのルール定義それぞれはPostgreSQLに受け入れられますが、ルールが再帰的に展開されるため、SELECTコマンドが、PostgreSQLにエラーを表示させます。

CREATE RULE "_RETURN" AS
    ON SELECT TO t1
    DO INSTEAD
        SELECT * FROM t2;

CREATE RULE "_RETURN" AS
    ON SELECT TO t2
    DO INSTEAD
        SELECT * FROM t1;

SELECT * FROM t1;

Presently, if a rule action contains a <command>NOTIFY</command> command, the <command>NOTIFY</command> command will be executed unconditionally, that is, the <command>NOTIFY</command> will be issued even if there are not any rows that the rule should apply to. For example, in: 現在、ルールのアクションにNOTIFYコマンドが含まれる場合、NOTIFYコマンドは無条件に実行されます。 つまり、ルールを適用すべき行が存在しなかったとしても、NOTIFYが発行されます。 例えば、

CREATE RULE notify_me AS ON UPDATE TO mytable DO ALSO NOTIFY mytable;

UPDATE mytable SET name = 'foo' WHERE id = 42;

one <command>NOTIFY</command> event will be sent during the <command>UPDATE</command>, whether or not there are any rows that match the condition <literal>id = 42</literal>. This is an implementation restriction that might be fixed in future releases. では、id = 42という条件に一致する行があってもなくても、UPDATEの際、1つのNOTIFYイベントが送信されます。 これは実装上の制限であり、将来のリリースでは修正されるかもしれません。

互換性

<title>Compatibility</title>

<command>CREATE RULE</command> is a <productname>PostgreSQL</productname> language extension, as is the entire query rewrite system. CREATE RULEPostgreSQLの言語拡張で、問い合わせ書き換えシステム全体が言語拡張です。

関連項目

<title>See Also</title> ALTER RULE, DROP RULE