拡張性

PostgreSQL 9.0.0文書
前のページ | 巻戻し | 第 53章GINインデックス | 早送り | 次のページ

# 53.2. 拡張性

GINインタフェースは高度に抽象化されています。 アクセスメソッド実装者に要求されることは、アクセスするデータ型の意味を実装することだけです。 GIN層自体が同時実行性、ログ処理、ツリー構造の検索処理に関する注意を行います。

GINアクセスメソッドを動作させるために取ることは、4つ（または5つ）のユーザ定義関数を実装することだけです。 これは、ツリー内のキーの動作とキーとインデックス付けされる値、インデックス可能な問い合わせ間の関係を定義します。 すなわち、GINは、一般化、コード再利用、整理されたインタフェースによる拡張性を組み合わせます。

GIN用の演算子クラスが提供しなければならない4つのメソッドを示します。

`int compare(Datum a, Datum b)`

  キー（インデックス付けされる値ではありません）を比較し、0より小さい、0、または0より大きい整数を返します。 それぞれ、最初のキーが2番目のキーより、小さい、等しい、または大きいことを示します。

`Datum *extractValue(Datum inputValue, int32 *nkeys)`

  インデックス対象値に与えられるキーの配列を返します。 返されるキーの数は`*nkeys`に格納しなければなりません。

`Datum *extractQuery(Datum query, int32 *nkeys, StrategyNumber n, bool **pmatch, Pointer **extra_data)`

  問い合わせ対象の値に与えられるキーの配列を返します。 つまり、`query`はインデックス可能な演算子の右辺の値です。 この左辺はインデックス対象の列です。 `n`は演算子クラス内の演算子の戦略番号です（項35.14.2を参照）。 `extractQuery`はしばしば、`query`のデータ型と抽出しなければならないキー値を決定するために、`n`を調べなければなりません。 返されるキーの数を`*nkeys`に格納しなければなりません。 問い合わせがキーを含んでいない場合、`extractQuery`は、演算子の意味合いによって`*nkeys`に0または-1を格納しなければなりません。 0は全ての値が`query`に一致し、完全インデックススキャンが行われることを意味します（しかし、項53.5を参照）。 -1は何も`query`に一致せず、インデックススキャンはすべて飛ばせることを意味します。 部分一致が提供されている場合、`pmatch`は使用する出力引数です。 使用するには、`extractQuery`が`*nkeys`論理値の配列を割り当て、そのアドレスを`*pmatch`に格納しなければなりません。 関連するキーが部分一致を必要とするとき、それぞれの配列要素は真に、そうでなければ偽に設定されなければなりません。 `*pmatch`がNULLに設定されていない場合、GINは部分一致が必要ないと想定します。 呼び出し前に変数はNULLに初期化されますので、この引数は部分一致が提供されていない演算子クラスでは、単に無視できます。 `extra_data`は、`extractQuery`が`consistent`と`comparePartial`メソッドに追加データを渡すことができるようにする出力引数です。 使用するには、`extractQuery`が`*nkeys`ポインタの配列を割り当て、そのアドレスを`*extra_data`に格納し、そして望まれるものは何でも個別のポインタに格納しなければなりません。 変数は呼び出し前にNULLに初期化されますので、追加データを必要としない演算子クラスでこの引数は単に無視できます。 もし`*extra_data`が設定されれば、配列全部が`consistent`メソッドに、適切な要素が`comparePartial`メソッドに渡されます。

`bool consistent(bool check[], StrategyNumber n, Datum query, int32 nkeys, Pointer extra_data[], bool *recheck)`

  インデックス付けられた値が戦略番号`n`を持つ問い合わせ演算子を満たす（または、recheck印が返されたときはたぶん満たすかもしれない）場合に真を返します。 `check`配列は長さ`nkeys`であり、この`query`データに対して事前に行われた`extractQuery`が返したキーの数と同じです。 インデックス対象値が対応する問い合わせキーを持つ場合、`check`配列の各要素は真です。 つまり、(check[i] == TRUE)の場合、`extractQuery`の結果配列のi番目のキーがインデックス対象値内に存在します。 元の`query`データ（抽出されたキー配列ではありません）は、`consistent`メソッドがそれを調査する必要がある場合に、渡されます。 `extra_data`は`extractQuery`により返された追加データ配列で、ない場合はNULLです。 成功の場合、`*recheck`はヒープタプルが問い合わせ演算子に対し再検査を必要とすれば真で、インデックス検査が的確であれば偽です。

オプションとして、GINに対する演算子クラスは第5のメソッドを提供します。

`int comparePartial(Datum partial_key, Datum key, StrategyNumber n, Pointer extra_data)`

  問い合わせとインデックスキーの部分一致を比較します。 符号が結果を示す整数が返ります。 ゼロ未満はインデックスキーは問い合わせに一致しないが、インデックススキャンを続けるべきであることを示します。 ゼロはインデックスキーが問い合わせに一致することを示します。 ゼロより大きな値はこれ以上の一致はありえないためインデックススキャンを停止すべきであることを示します。 スキャンをいつ停止するかを決めるためにセマンテックスが必要とされる場合、部分一致問い合わせを生成した演算子の戦略番号`n`が提供されます。 また`extra_data`は`extractQuery`で作成される追加データ配列の対応する要素、もしなければNULLです。

"部分一致"問い合わせをサポートするためには、演算子クラスは`comparePartial`メソッドを提供しなければなりません。 またその`extractQuery`は、部分一致問い合わせであった時に`pmatch`パラメータを設定しなければなりません。 詳細については項53.3.2を参照してください。

前のページ | ホーム | 次のページ
はじめに | 上に戻る | 実装