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

CREATE OPERATOR CLASS

CREATE OPERATOR CLASS <refpurpose>define a new operator class</refpurpose> — 新しい演算子クラスを定義する

概要

CREATE OPERATOR CLASS name [ DEFAULT ] FOR TYPE data_type
  USING index_method [ FAMILY family_name ] AS
  {  OPERATOR strategy_number operator_name [ ( op_type, op_type ) ] [ FOR SEARCH | FOR ORDER BY sort_family_name ]
   | FUNCTION support_number [ ( op_type [ , op_type ] ) ] function_name ( argument_type [, ...] )
   | STORAGE storage_type
  } [, ... ]

説明

<title>Description</title>

<command>CREATE OPERATOR CLASS</command> creates a new operator class. An operator class defines how a particular data type can be used with an index. The operator class specifies that certain operators will fill particular roles or <quote>strategies</quote> for this data type and this index method. The operator class also specifies the support functions to be used by the index method when the operator class is selected for an index column. All the operators and functions used by an operator class must be defined before the operator class can be created. CREATE OPERATOR CLASSは新しい演算子クラスを作成します。 演算子クラスは、特定のデータ型がインデックスでどのように使用されるかを定義します。 演算子クラスにより、データ型およびインデックスメソッドの特定の役割もしくは戦略に、どの演算子を使用するかが指定されます。 また、インデックスの列に対して演算子クラスが選択される際、演算子クラスによってインデックスメソッドが使用するサポート関数が指定されます。 演算子クラスで使用される全ての演算子および関数は、演算子クラスを作成できるようになる前に定義しておく必要があります。

If a schema name is given then the operator class is created in the specified schema. Otherwise it is created in the current schema. Two operator classes in the same schema can have the same name only if they are for different index methods. スキーマ名が与えられている場合、その演算子クラスは指定されたスキーマに作成されます。 スキーマ名がなければ、演算子クラスは現在のスキーマに作成されます。 異なるインデックスメソッドに使用する場合のみ、同じスキーマ内の2つの演算子クラスに同じ名前を付けることができます。

The user who defines an operator class becomes its owner. Presently, the creating user must be a superuser. (This restriction is made because an erroneous operator class definition could confuse or even crash the server.) 演算子クラスは、それを定義したユーザが所有者となります。 現在、演算子クラスを作成するには、スーパーユーザである必要があります。 (誤った演算子クラスを定義すると、サーバを混乱させ、サーバクラッシュの原因とさえなり得るため、この制限が付けられています)。

<command>CREATE OPERATOR CLASS</command> does not presently check whether the operator class definition includes all the operators and functions required by the index method, nor whether the operators and functions form a self-consistent set. It is the user's responsibility to define a valid operator class. 現在、CREATE OPERATOR CLASSでは、インデックスメソッドに必要な全ての演算子および関数が演算子クラス定義に含まれているかどうか、また、演算子や関数の形式がそれ自身で整合性を持っているかを検査しません。 ユーザの責任において、有効な演算子クラスを定義してください。

Related operator classes can be grouped into <firstterm>operator families</firstterm>. To add a new operator class to an existing family, specify the <literal>FAMILY</literal> option in <command>CREATE OPERATOR CLASS</command>. Without this option, the new class is placed into a family named the same as the new class (creating that family if it doesn't already exist). 関連する演算子クラスを演算子族にまとめることができます。 既存の演算子族に新しい演算子クラスを追加するためには、CREATE OPERATOR CLASSFAMILYオプションを指定してください。 このオプションを指定しないと、新しい演算子クラスはそのクラスと同じ名前の演算子族内に置かれます(この演算子族が存在しない場合は作成します)。

Refer to <xref linkend="xindex"/> for further information. 詳細については36.16を参照してください。

パラメータ

<title>Parameters</title>
name

The name of the operator class to be created. The name can be schema-qualified. 作成する演算子クラスの名前です。 演算子クラス名は、スキーマ修飾することができます。

DEFAULT

If present, the operator class will become the default operator class for its data type. At most one operator class can be the default for a specific data type and index method. DEFAULTを付けると、その演算子クラスが、そのデータ型のデフォルトの演算子クラスになります。 特定のデータ型およびインデックスメソッドのデフォルトにできる演算子クラスは最大1つまでです。

data_type

The column data type that this operator class is for. この演算子クラスを使用する列のデータ型です。

index_method

The name of the index method this operator class is for. この演算子クラスを使用するインデックスメソッドの名前です。

family_name

The name of the existing operator family to add this operator class to. If not specified, a family named the same as the operator class is used (creating it, if it doesn't already exist). この演算子クラスの追加先となる既存の演算子族の名前です。 指定されない場合、演算子クラスと同じ名前の演算子族が使用されます(演算子族が存在しない場合は作成します)。

strategy_number

The index method's strategy number for an operator associated with the operator class. 演算子クラスに関連する演算子のインデックスメソッドの戦略番号です。

operator_name

The name (optionally schema-qualified) of an operator associated with the operator class. 演算子クラスに関連する演算子の名前です(スキーマ修飾名でも可)。

op_type

In an <literal>OPERATOR</literal> clause, the operand data type(s) of the operator, or <literal>NONE</literal> to signify a prefix operator. The operand data types can be omitted in the normal case where they are the same as the operator class's data type. OPERATOR句では、演算子の入力データ型、もしくは、前置演算子を表すNONEを指定します。 演算子クラスのデータ型と同じである通常の場合、入力データ型は省略可能です。

In a <literal>FUNCTION</literal> clause, the operand data type(s) the function is intended to support, if different from the input data type(s) of the function (for B-tree comparison functions and hash functions) or the class's data type (for B-tree sort support functions, B-tree equal image functions, and all functions in GiST, SP-GiST, GIN and BRIN operator classes). These defaults are correct, and so <replaceable class="parameter">op_type</replaceable> need not be specified in <literal>FUNCTION</literal> clauses, except for the case of a B-tree sort support function that is meant to support cross-data-type comparisons. FUNCTION句では、関数の入力データ型(B-Tree比較関数およびハッシュ関数用)またはクラスのデータ型(B-treeソートサポート関数、B-tree等価イメージ関数とGiST、SP-GiST、GIN、BRIN演算子クラスのすべての関数用)と異なる場合、関数がサポートする予定の演算対象データ型です。 これらのデフォルトは常に正確です。 このため、データ型を跨がる比較をサポートする予定のB-treeソートサポート関数は除き、FUNCTION句でop_typeを指定する必要はありません。

sort_family_name

The name (optionally schema-qualified) of an existing <literal>btree</literal> operator family that describes the sort ordering associated with an ordering operator. 順序付け演算子に関連したソート順序を記述する、既存のbtree演算子族の名前(スキーマ修飾可)です。

If neither <literal>FOR SEARCH</literal> nor <literal>FOR ORDER BY</literal> is specified, <literal>FOR SEARCH</literal> is the default. FOR SEARCHFOR ORDER BYも指定されていない場合、FOR SEARCHがデフォルトです。

support_number

The index method's support function number for a function associated with the operator class. 演算子クラスに関連する関数用のインデックスメソッドのサポート関数の番号です。

function_name

The name (optionally schema-qualified) of a function that is an index method support function for the operator class. 演算子クラス用のインデックスメソッドのサポート関数となる関数の名前です(スキーマ修飾名でも可)。

argument_type

The parameter data type(s) of the function. 関数のパラメータのデータ型です。

storage_type

The data type actually stored in the index. Normally this is the same as the column data type, but some index methods (currently GiST, GIN, SP-GiST and BRIN) allow it to be different. The <literal>STORAGE</literal> clause must be omitted unless the index method allows a different type to be used. If the column <replaceable class="parameter">data_type</replaceable> is specified as <type>anyarray</type>, the <replaceable class="parameter">storage_type</replaceable> can be declared as <type>anyelement</type> to indicate that the index entries are members of the element type belonging to the actual array type that each particular index is created for. インデックスに実際に格納されるデータ型です。 通常、このデータ型は列のデータ型と同じです。 しかし、異なるデータ型を許可するインデックスメソッドも存在します(現時点ではGiST、GIN、SP-GiST、BRIN)。 インデックスメソッドが異なるデータ型の使用を許可していなければ、STORAGE句を指定してはいけません。 列data_typeanyarrayとして指定された場合、storage_typeanyelementとして宣言し、インデックスのエントリが各インデックスが作成される実際の配列型に属する要素型のメンバであることを示すことができます。

The <literal>OPERATOR</literal>, <literal>FUNCTION</literal>, and <literal>STORAGE</literal> clauses can appear in any order. OPERATORFUNCTIONSTORAGEは任意の順番で記述できます。

注釈

<title>Notes</title>

Because the index machinery does not check access permissions on functions before using them, including a function or operator in an operator class is tantamount to granting public execute permission on it. This is usually not an issue for the sorts of functions that are useful in an operator class. インデックス機構は、使用する前に関数に関するアクセス権限を検査しませんので、 関数や演算子を演算子クラスに含めることは、PUBLICに実行権限を与えることと同じです。 通常、演算子クラスで有用な種類の関数ではこれは問題になりません。

The operators should not be defined by SQL functions. An SQL function is likely to be inlined into the calling query, which will prevent the optimizer from recognizing that the query matches an index. 演算子はSQL関数で定義してはなりません。 SQL関数は呼び出し元の問い合わせにインライン化されることが多いので、オプティマイザでその問い合わせがインデックスに一致するかどうかを認識できなくなってしまうからです。

Before <productname>PostgreSQL</productname> 8.4, the <literal>OPERATOR</literal> clause could include a <literal>RECHECK</literal> option. This is no longer supported because whether an index operator is <quote>lossy</quote> is now determined on-the-fly at run time. This allows efficient handling of cases where an operator might or might not be lossy. PostgreSQL 8.4より前までは、OPERATOR句にRECHECKオプションを含めることができました。 インデックス演算子に損失があるかどうかは実行時にその場で決定されるようになりましたので、これはサポートされなくなりました。 これにより、演算子に損失があるかもしれないしないかもしれないような場合を効率的に扱うことができるようになりました。

<title>Examples</title>

The following example command defines a GiST index operator class for the data type <literal>_int4</literal> (array of <type>int4</type>). See the <xref linkend="intarray"/> module for the complete example. 以下のコマンド例では、_int4データ型(int4の配列)のGiSTインデックス演算子クラスを定義しています。 この例の詳細については、intarrayモジュールを参照してください。

CREATE OPERATOR CLASS gist__int_ops
    DEFAULT FOR TYPE _int4 USING gist AS
        OPERATOR        3       &&,
        OPERATOR        6       = (anyarray, anyarray),
        OPERATOR        7       @>,
        OPERATOR        8       <@,
        OPERATOR        20      @@ (_int4, query_int),
        FUNCTION        1       g_int_consistent (internal, _int4, smallint, oid, internal),
        FUNCTION        2       g_int_union (internal, internal),
        FUNCTION        3       g_int_compress (internal),
        FUNCTION        4       g_int_decompress (internal),
        FUNCTION        5       g_int_penalty (internal, internal, internal),
        FUNCTION        6       g_int_picksplit (internal, internal),
        FUNCTION        7       g_int_same (_int4, _int4, internal);

互換性

<title>Compatibility</title>

<command>CREATE OPERATOR CLASS</command> is a <productname>PostgreSQL</productname> extension. There is no <command>CREATE OPERATOR CLASS</command> statement in the SQL standard. CREATE OPERATOR CLASSPostgreSQLの拡張です。 標準SQLにはCREATE OPERATOR CLASS文はありません。

関連項目

<title>See Also</title> ALTER OPERATOR CLASS, DROP OPERATOR CLASS, CREATE OPERATOR FAMILY, ALTER OPERATOR FAMILY