<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>61.1. カスタムスキャンパスの作成</title><link type="text/css"><link rev="made"><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><link title="第61章 カスタムスキャンプロバイダの作成"><link title="61.2. カスタムスキャン計画の作成"><meta name="viewport" content="width=device-width,initial-scale=1.0"><style type="text/css"></style><script type="text/javascript"></script>
<script type="text/javascript"></script></head><span>他のバージョンの文書</span> <span>： <span>16</span> | </span><a>15</a><span> | </span><a>14</a><span> | </span><a>13</a><span> | </span><a>12</a><span> | </span><a>11</a><span> | </span><a>10</a><span> | </span><a>9.6</a><span> | </span><a>9.5</a><span> | <span><a>9.4</a></span> | <span><a>9.3</a></span> | <span><a>9.2</a></span> | <span><a>9.1</a></span> | <span><a>9.0</a></span> | <span><a>8.4</a></span> | <span><a>8.3</a></span> | <span><a>8.2</a></span> | <span><a>8.1</a></span> | <span><a>8.0</a></span> | <span><a>7.4</a></span> | <span><a>7.3</a></span> | <span><a>7.2</a></span></span><div><table width="100%" summary="Navigation header"><tr><th colspan="4" align="center"><a accesskey="h">PostgreSQL 16.3文書</a></th></tr><tr><td width="10%" align="left"></td><td width="10%" align="left"></td><td width="60%" align="center"><a title="第61章 カスタムスキャンプロバイダの作成">第61章 カスタムスキャンプロバイダの作成</a></td><td width="20%" align="right"></td></tr><tr><td width="10%" align="left"><a accesskey="p" title="第61章 カスタムスキャンプロバイダの作成">前へ</a> </td><td width="10%" align="left"><a accesskey="u" title="第61章 カスタムスキャンプロバイダの作成">上へ</a></td><td width="60%" align="center">61.1. カスタムスキャンパスの作成</td><td width="20%" align="right"> <a accesskey="n" title="61.2. カスタムスキャン計画の作成">次へ</a></td></tr></table><hr></div><div><div><div><div><h2>61.1. カスタムスキャンパスの作成 <a>#</a></h2></div></div></div><p>

カスタムスキャンプロバイダは、典型的には、以下のフックを設定することでベースリレーションのためのパスを追加します。
このフックはコアのコードがそのリレーションへのすべてのアクセスパスを生成した後で呼び出されます。
（フックの呼び出しの後に作成されるギャザーパス(Gather path)を除きます。フックが追加した部分パスをギャザーパスが利用できるようにするためです。）
</p><pre>
typedef void (*set_rel_pathlist_hook_type) (PlannerInfo *root,
                                            RelOptInfo *rel,
                                            Index rti,
                                            RangeTblEntry *rte);
extern PGDLLIMPORT set_rel_pathlist_hook_type set_rel_pathlist_hook;
</pre><p>
  </p><p>

このフックはコアシステムが生成したパスを検査し、修正し、あるいは削除するために使うことができますが、カスタムスキャンプロバイダは、典型的には<code>CustomPath</code>オブジェクトを生成し、<code>add_path</code>を使ってそれを<code>rel</code>に追加することのみを行います。
カスタムスキャンプロバイダは<code>CustomPath</code>オブジェクトの初期化を担当します。
このオブジェクトは以下のように宣言されています。
</p><pre>
typedef struct CustomPath
{
    Path      path;
    uint32    flags;
    List     *custom_paths;
    List     *custom_private;
    const CustomPathMethods *methods;
} CustomPath;
</pre><p>
  </p><p>

<code>path</code>は、他のすべてのパスと同じく、行数の推定値、開始とトータルのコスト、このパスで提供されるソート順を含めて初期化される必要があります。
<code>flags</code>はビットマスクで、スキャンプロバイダが特定のオプションをサポートできるかどうかを指定します。
カスタムパスが逆向きスキャンをサポートできるなら<code>CUSTOMPATH_SUPPORT_BACKWARD_SCAN</code>を、マークとリストアをサポートできるなら<code>CUSTOMPATH_SUPPORT_MARK_RESTORE</code>を、プロジェクションを実行できるなら<code>CUSTOMPATH_SUPPORT_PROJECTION</code>を<code>flags</code>に含めます。
(<code>CUSTOMPATH_SUPPORT_PROJECTION</code>が設定されていなければ、スキャンノードはスキャンされるリレーションのVarを生成するよう依頼されるだけです。一方、そのフラグが設定されていれば、スキャンノードはこのVarのスカラ式を評価できないといけません。)
オプションの<code>custom_paths</code>はこのカスタムパスのノードで使用される<code>Path</code>のノードのリストです。
プランナがこれを<code>Plan</code>のノードに変換します。
<code>custom_private</code>はカスタムパスのプライベートデータを格納するために使うことができます。
プライベートデータは<code>nodeToString</code>が処理できるような形式で格納してください。
そうすることで、カスタムパスを出力するデバッグルーチンが設計通りに動作します。
<code>methods</code>は要求されるカスタムパスのメソッドのオブジェクト（通常は静的に割り当てられる）を指している必要があり、以下でさらに詳しく説明します。
  </p><p>

カスタムスキャンプロバイダは結合(join)のパスを提供することもできます。
ベースのリレーションの場合と同様、そのようなパスは置換される結合が普通に生成したであろうものと同じ結果を生成しなければなりません。
そのために、結合のプロバイダは以下のフックをセットし、フック関数内で結合リレーション用に<code>CustomPath</code>のパスを作成します。
</p><pre>
typedef void (*set_join_pathlist_hook_type) (PlannerInfo *root,
                                             RelOptInfo *joinrel,
                                             RelOptInfo *outerrel,
                                             RelOptInfo *innerrel,
                                             JoinType jointype,
                                             JoinPathExtraData *extra);
extern PGDLLIMPORT set_join_pathlist_hook_type set_join_pathlist_hook;
</pre><p>


このフックは、同じ結合リレーションについて、内側あるいは外側のリレーションとの様々な組み合わせで繰り返し呼び出されます。
繰り返しの作業を最小化するのはフック側の責任です。
  </p><div><div><div><div><h3>61.1.1. カスタムスキャンパスのコールバック <a>#</a></h3></div></div></div><p>
</p><pre>
Plan *(*PlanCustomPath) (PlannerInfo *root,
                         RelOptInfo *rel,
                         CustomPath *best_path,
                         List *tlist,
                         List *clauses,
                         List *custom_plans);
</pre><p>

カスタムパスを完成した計画に変換します。
戻り値は一般的には<code>CustomScan</code>オブジェクトで、その領域はコールバックが割り当てて初期化しなければなりません。
詳しくは<a title="61.2. カスタムスキャン計画の作成">61.2</a>を参照してください。
   </p><p>
</p><pre>
List *(*ReparameterizeCustomPathByChild) (PlannerInfo *root,
                                          List *custom_private,
                                          RelOptInfo *child_rel);
</pre><p>

このコールバックは、指定された子リレーション<code>child_rel</code>の最上位の親によりパラメータ化されたパスを子リレーションによりパラメータ化されるよう変換する時に呼び出されます。
コールバックはパスを再パラメータ化したり、<code>CustomPath</code>の指定された<code>custom_private</code>メンバに保存されている式ノードを変換したりするのに使われます。
コールバックは必要に応じて<code>reparameterize_path_by_child</code>、<code>adjust_appendrel_attrs</code>または<code>adjust_appendrel_attrs_multilevel</code>を使います。
   </p></div></div><div><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" title="第61章 カスタムスキャンプロバイダの作成">前へ</a> </td><td width="20%" align="center"><a accesskey="u" title="第61章 カスタムスキャンプロバイダの作成">上へ</a></td><td width="40%" align="right"> <a accesskey="n" title="61.2. カスタムスキャン計画の作成">次へ</a></td></tr><tr><td width="40%" align="left" valign="top">第61章 カスタムスキャンプロバイダの作成 </td><td width="20%" align="center"><a accesskey="h" title="PostgreSQL 16.3文書">ホーム</a></td><td width="40%" align="right" valign="top"> 61.2. カスタムスキャン計画の作成</td></tr></table></div></html>

行数の推定値、開始とトータルのコストを含める

ユーザーが手動で設定する必要がある

スキャンプロバイダが特定のオプションをサポートできるかどうか

データベースのバージョン情報