doc/pg_hint_plan-ja.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD html 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html>
   3 <head>
   4 <title>pg_hint_plan</title>
   5 <!-- Uncoment after the tool has been hosted somewhere.
   6 <link rel="home" title="pg_hint_plan" href="index.html">
   7 -->
   8 <link rel="stylesheet" type="text/css" href="style.css">
   9 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  10 </head>
  11
  12 <body>
  13 <h1 id="pg_hint_plan">pg_hint_plan 1.1.0</h1>
  14 <div class="navigation">
  15   <a href="pg_hint_plan-ja.html">pg_hint_plan</a>
  16 </div>
  17 <hr>
  18
  19 <div class="index">
  20 <ol>
  21 <li><a href="#name">名前</a></li>
  22 <li><a href="#synopsis">概要</a></li>
  23 <li><a href="#description">機能説明</a>
  24 <li><a href="#install">インストール</a></li>
  25 <li><a href="#uninstall">アンインストール</a></li>
  26 <li><a href="#restrictions">使用上の注意と制約</a></li>
  27 <li><a href="#requirement">動作環境</a></li>
  28 <li><a href="#seealso">関連項目</a></li>
  29 <li><a href="hint_list-ja.html">Appendix A. ヒント句一覧</a></li>
  30 </div>
  31
  32 <h2 id="name">名前</h2>
  33 <p>pg_hint_plan -- 実行計画を示すヒントをクエリに指定することで、SQL文やGUCパラメータを変えずに実行計画を制御します。</p>
  34
  35 <h2 id="synopsis">概要</h2>
  36 <p>PostgreSQLはコストベースオプティマイザを採用しており、SQL文と統計情報を元に可能な実行計画のコストを見積もり、最もコストの低い実行計画を選択します。オプティマイザは可能な限りよい実行計画を作成しようとしますが、カラム間の相関関係などは考慮しないため、複雑なクエリでは常に最適なプランを選択するとは限りません。</p>
  37 <p>pg_hint_planを用いると、ヒントでスキャン方式や結合方式を指定することで、SQL文やGUCパラメータを変更することなく実行計画を制御することができます。</p>
  38
  39 <h2 id="description">機能説明</h2>
  40 <p>pg_hint_planの機能について説明するにあたり、まず文中で使用されている用語について説明します。</p>
  41 <table>
  42 <thead>
  43 <tr>
  44 <tr><th>用語</th><th>説明</th></tr>
  45 </tr></thead>
  46 <tbody>
  47 <tr><td>ヒント句</td>
  48   <td>実行計画を制御するための情報です。</td></tr>
  49   <tr><td>ヒント</td>
  50   <td>実行計画を制御したいクエリに適用するヒント句を列挙したものです。</td></tr>
  51 </tbody>
  52 </table>
  53
  54 <h3 id="hint-rule">ヒントの指定方法</h3>
  55 <p>ヒントは二つの方法で指定することができます。</p>
  56 <ul>
  57 <li>コメントでの指定</li>
  58 <p>特殊なSQLブロックコメント内にヒントを記述します。</p>
  59 <li>テーブルでの指定</li>
  60 <p>ヒント用のテーブルにヒントを登録します。</p>
  61 </ul>
  62 <p>特定のアプリケーションではヒントをコメントで指定することができないため、「テーブルでの指定」でヒントを指定します。なお、「コメントでの指定」と異なり、アプリケーションのソースコードに手を入れずに指定するヒントを変更することができます。</p>
  63
  64 <h4 id="hint-comment">コメントでの指定</h4>
  65 <p>指定したいヒントを、実行計画を制御したいクエリの先頭または途中のSQLブロックコメントの中に記述します。</p>
  66 <p>ヒント用コメントと通常のコメントを区別するために、ヒント用のブロックコメントは「<span class="bold">/*+</span>」で始めます。ヒントの対象は、カッコ内にオブジェクト名または別名で指定します。オブジェクト名は、スペース、タブ、または改行のいずれかで区切って指定します。</p>
  67 <p>以下の例では、HashJoinとSeqScanヒント句により、pgbench_accountsテーブルに対するSeq Scanの結果をHash Joinする実行計画が選択されています。なおかつ、Setヒント句によりこのクエリの実行計画を作成する間だけrandom_page_costが2.0に変更されています。</p>
  68 <pre>
  69 postgres=# EXPLAIN (VERBOSE, COSTS)
  70 postgres-# /*+
  71 postgres*#     SeqScan(a)
  72 postgres*#     HashJoin(a b)
  73 postgres*#     Set(random_page_cost 2.0)
  74 postgres*#  */
  75 postgres-# SELECT *
  76 postgres-#   FROM pgbench_accounts a
  77 postgres-#   JOIN pgbench_branches b
  78 postgres-#     ON a.bid = b.bid
  79 postgres-#  ORDER BY a.aid
  80 postgres-#  LIMIT 10;
  81                                              QUERY PLAN
  82 ----------------------------------------------------------------------------------------------------
  83  Limit  (cost=6176.99..6177.01 rows=10 width=461)
  84    Output: a.aid, a.bid, a.abalance, a.filler, b.bid, b.bbalance, b.filler, a.aid
  85    ->  Sort  (cost=6176.99..6426.99 rows=100000 width=461)
  86          Output: a.aid, a.bid, a.abalance, a.filler, b.bid, b.bbalance, b.filler, a.aid
  87          Sort Key: a.aid
  88          ->  <span class="strong">Hash Join</span>  (cost=1.02..4016.02 rows=100000 width=461)
  89                Output: a.aid, a.bid, a.abalance, a.filler, b.bid, b.bbalance, b.filler, a.aid
  90                Hash Cond: (a.bid = b.bid)
  91                ->  <span class="strong">Seq Scan on public.pgbench_accounts a</span>  (cost=0.00..2640.00 rows=100000 width=97)
  92                      Output: a.aid, a.bid, a.abalance, a.filler
  93                ->  Hash  (cost=1.01..1.01 rows=1 width=364)
  94                      Output: b.bid, b.bbalance, b.filler
  95                      ->  Seq Scan on public.pgbench_branches b  (cost=0.00..1.01 rows=1 width=364)
  96                            Output: b.bid, b.bbalance, b.filler
  97 (14 rows)
  98
  99 postgres=#
 100 </pre>
 101
 102 <h4 id="hint-table">テーブルでの指定</h4>
 103 <p>指定したいヒントを、実行計画を制御したいクエリと併せてヒント用のテーブルに登録します。</p>
 104 <p>デフォルトでは無効なので、テーブルで指定したヒントは適用されません。そのため、ヒントをテーブルで指定する場合は、<a href="#hint-GUC">pg_hint_planのGUCパラメータ</a>pg_hint_plan.enable_hint_tableの設定を変更します。</p>
 105 <p>ヒント用のテーブルは「<span class="bold">hint_plan.hints</span>」です。hint_plan.hintsテーブルには、以下の情報を登録します。</p>
 106 <table>
 107 <thead>
 108 <tr>
 109 <tr><th>列名</th><th>説明</th></tr>
 110 </tr></thead>
 111 <tbody>
 112 <tr><td>id</td>
 113   <td>識別番号です。連番型ですので、新しいヒントを登録するときにはこの列を指定せずに登録してください。クエリやアプリケーション名やヒントを更新するときに使用してください。</td></tr>
 114 <tr><td>norm_query_string</td>
 115   <td>実行計画を制御したいクエリを指定します。対象のクエリに定数があるときは、下記の例のように「?」に置き換えます。キーワード間の空白の数が、登録するクエリと実行するクエリで異なると別のSQL文として扱われます。</td></tr>
 116 <tr><td>application_name</td>
 117   <td>ヒント適用対象のアプリケーション名を指定します。下記の例では「psql」から実行されたクエリのみがヒント適用対象となります。全てのアプリケーションにヒントを適用したいときは、空文字列を登録します。アプリケーション名は、セッションの「application_name」GUCパラメータと等しいか判断します。</td></tr>
 118 <tr><td>hints</td>
 119   <td>ヒントを指定します。ヒント以外のもの（SQLコメントなど）を含めないでください。</td></tr>
 120 </tbody>
 121 </table>
 122 <p>以下の例では、テーブルに登録した「コメントでの指定」の例と同じヒントと、登録したクエリの実行結果を示しています。</p>
 123 <pre>
 124 postgres=# SELECT * FROM hint_plan.hints;
 125  id |     norm_query_string      | application_name |                      hints
 126 ----+----------------------------+------------------+--------------------------------------------------
 127   1 | EXPLAIN (VERBOSE, COSTS)  +| psql             | SeqScan(a)HashJoin(a b)Set(random_page_cost 2.0)
 128     |  SELECT *                 +|                  |
 129     |    FROM pgbench_accounts a+|                  |
 130     |    JOIN pgbench_branches b+|                  |
 131     |      ON a.bid = b.bid     +|                  |
 132     |   ORDER BY a.aid          +|                  |
 133     |   LIMIT ?;                +|                  |
 134     |                            |                  |
 135 ...
 136
 137 postgres=# SET pg_hint_plan.enable_hint_table TO on;
 138 postgres=# EXPLAIN (VERBOSE, COSTS)
 139 postgres-# SELECT *
 140 postgres-#   FROM pgbench_accounts a
 141 postgres-#   JOIN pgbench_branches b
 142 postgres-#     ON a.bid = b.bid
 143 postgres-#  ORDER BY a.aid
 144 postgres-#  LIMIT 10;
 145                                              QUERY PLAN
 146 ----------------------------------------------------------------------------------------------------
 147  Limit  (cost=6176.99..6177.01 rows=10 width=461)
 148    Output: a.aid, a.bid, a.abalance, a.filler, b.bid, b.bbalance, b.filler, a.aid
 149    ->  Sort  (cost=6176.99..6426.99 rows=100000 width=461)
 150          Output: a.aid, a.bid, a.abalance, a.filler, b.bid, b.bbalance, b.filler, a.aid
 151          Sort Key: a.aid
 152          ->  <span class="strong">Hash Join</span>  (cost=1.02..4016.02 rows=100000 width=461)
 153                Output: a.aid, a.bid, a.abalance, a.filler, b.bid, b.bbalance, b.filler, a.aid
 154                Hash Cond: (a.bid = b.bid)
 155                ->  <span class="strong">Seq Scan on public.pgbench_accounts a</span>  (cost=0.00..2640.00 rows=100000 width=97)
 156                      Output: a.aid, a.bid, a.abalance, a.filler
 157                ->  Hash  (cost=1.01..1.01 rows=1 width=364)
 158                      Output: b.bid, b.bbalance, b.filler
 159                      ->  Seq Scan on public.pgbench_branches b  (cost=0.00..1.01 rows=1 width=364)
 160                            Output: b.bid, b.bbalance, b.filler
 161 (14 rows)
 162
 163 postgres=#
 164 </pre>
 165
 166 <div class="tips">
 167 <span class="strong">指定方法の優先度</span>
 168 <p>ヒントをコメントとテーブルの両方で指定した場合、テーブルで指定したヒントが適用され、コメントで指定したヒントは無視されます。</p>
 169 <p>以下の例では、コメントでヒントを指定して実行計画を制御しているクエリに対して、テーブルに空文字列のヒントを登録しています。テーブルで指定したヒントが優先されるので、コメントで指定したヒントを取り消すことができます。</p>
 170 <pre>
 171 postgres=# select * from hint_plan.hints;
 172  id |             norm_query_string              | application_name | hints
 173 ----+--------------------------------------------+------------------+-------
 174   1 | EXPLAIN (VERBOSE, COSTS)                  +| psql             |
 175     | /*+                                       +|                  |
 176     |     HashJoin(a b)                         +|                  |
 177     |     SeqScan(a)                            +|                  |
 178     |  */                                       +|                  |
 179     | SELECT *                                  +|                  |
 180     |   FROM pgbench_accounts a                 +|                  |
 181     |   JOIN pgbench_branches b ON a.bid = b.bid+|                  |
 182     |  ORDER BY a.aid;                           |                  |
 183 ...
 184
 185 postgres=# EXPLAIN (VERBOSE, COSTS)
 186 postgres-# /*+
 187 postgres*#     HashJoin(a b)
 188 postgres*#     SeqScan(a)
 189 postgres*#  */
 190 postgres-# SELECT *
 191 postgres-#   FROM pgbench_accounts a
 192 postgres-#   JOIN pgbench_branches b ON a.bid = b.bid
 193 postgres-#  ORDER BY a.aid;
 194                                                       QUERY PLAN
 195 ----------------------------------------------------------------------------------------------------------------------
 196  <span class="strong">Nested Loop</span>  (cost=0.00..5750.47 rows=100000 width=461)
 197    Output: a.aid, a.bid, a.abalance, a.filler, b.bid, b.bbalance, b.filler, a.aid
 198    Join Filter: (a.bid = b.bid)
 199    ->  <span class="strong">Index Scan using pgbench_accounts_pkey on public.pgbench_accounts a</span>  (cost=0.00..4249.45 rows=100000 width=97)
 200          Output: a.aid, a.bid, a.abalance, a.filler
 201    ->  Materialize  (cost=0.00..1.01 rows=1 width=364)
 202          Output: b.bid, b.bbalance, b.filler
 203          ->  Seq Scan on public.pgbench_branches b  (cost=0.00..1.01 rows=1 width=364)
 204                Output: b.bid, b.bbalance, b.filler
 205 (9 rows)
 206 </pre>
 207 </div>
 208
 209 <h3 id="hint-group">ヒント句のグループ</h3>
 210 <p>pg_hint_planで使えるヒント句の種類は、スキャン方式と結合方式、結合順序、GUCパラメータの4グループです。各グループの具体的なヒント句は、<a href="hint_list-ja.html">ヒント句一覧</a>を参照してください。</p>
 211
 212 <h4>スキャン方式</h4>
 213 <p>あるオブジェクトでどのスキャン方式を選択するかを指定できるヒント句のグループです。「SeqScan」や「IndexScan」などを含みます。</p>
 214 <p>スキャン方式を指定できるオブジェクトは、通常のテーブル、継承テーブル、UNLOGGEDテーブル、一時テーブル、システムカタログです。スキャン方式を指定できないオブジェクトは、外部テーブル、テーブル関数、VALUESコマンド結果、CTE(共通テーブル式)、ビュー、副問い合わせ結果です。</p>
 215 <p>特定のオブジェクトについてあるスキャン方式を選択して欲しい場合は、そのスキャン方式のヒント句と、対象となるオブジェクトの名前を指定します。逆に、特定のオブジェクトについてあるスキャン方式を選択して欲しくない場合は、Noで始まるヒント句を指定します。同じオブジェクトに対して複数のスキャン方式のヒント句を指定した場合は、最後に指定したヒント句が適用されます。</p>
 216
 217 <h4>結合方式</h4>
 218 <p>あるオブジェクトの組み合わせでどの結合方式を選択するかを指定できるヒント句のグループです。「MergeJoin」や「NestLoop」などを含みます。</p>
 219 <p>結合方式を指定できるオブジェクトは、通常のテーブル、継承テーブル、UNLOGGEDテーブル、一時テーブル、外部テーブル、システムカタログ、テーブル関数、VALUESコマンド結果、CTE(共通テーブル式)です。結合方式を指定できないオブジェクトは、ビュー、副問い合わせ結果です。</p>
 220 <p>特定のオブジェクトの組み合わせについてある結合方式を選択して欲しい場合は、その結合方式のヒント句と、対象となる2つ以上のオブジェクトの名前を指定します。逆に、特定のオブジェクトの組み合わせについてある結合方式を選択して欲しくない場合は、Noで始まるヒント句を指定します。同じオブジェクトの組み合わせに対して複数の結合方式のヒント句を指定した場合は、最後に指定したヒント句が適用されます。</p>
 221
 222 <h4>結合順序</h4>
 223 <p>あるオブジェクトの組み合わせでどのような順番で結合するかを指定できるヒント句のグループです。「Leading」のみを含みます。</p>
 224 <p>結合順序を指定できるオブジェクトは結合方式と同じです。</p>
 225 <p>先に結合して欲しいオブジェクトから順にオブジェクト名または別名を指定します。同じ問合せブロックのオブジェクトに対して複数の結合順序のヒント句を指定した場合は、最後に指定したヒント句が適用されます。 </p>
 226 <div class="tips">
 227 <span class="strong"></span>
 228 <p>結合対象のテーブルが3つ以上ある場合、結合方式のヒント句を指定したとしてもコスト見積もりによっては対象のテーブルが直接結合されないことがあります。対象のテーブルが直接結合されない場合は、結合順序のヒント句を併せて指定します。</p>
 229 <p>以下の例では、table1とtable2を直接結合する場合はNested Loopを、table1とtable2とtable3を結合する場合はMerge Joinを指定しています。また、コスト見積もりによってはtable1とtable2が直接結合されない場合を避けるため、table1とtable2を結合してからtable3を結合するようにLeadingヒント句を併用しています。</p>
 230 <pre>
 231 postgres=# /*+
 232 postgres*#     NestLoop(t1 t2)
 233 postgres*#     MergeJoin(t1 t2 t3)
 234 postgres*#     Leading(t1 t2 t3)
 235 postgres*#  */
 236 postgres-# SELECT * FROM table1 t1
 237 postgres-#     JOIN table table2 t2 ON (t1.key = t2.key)
 238 postgres-#     JOIN table table3 t3 ON (t2.key = t3.key);
 239 ...
 240 </pre>
 241 </div>
 242
 243 <h4>GUCパラメータ</h4>
 244 <p>そのクエリの実行計画を作成している間だけGUCパラメータを変更できるヒント句のグループです。「Set」のみを含みます。</p>
 245 <p>設定したいGUCパラメータとそのパラメータの値を指定します。指定できるGUCパラメータは<a href="http://www.postgresql.jp/document/current/html/runtime-config-query.html">問い合わせ計画</a>のGUCパラメータのみです。同じGUCパラメータのヒント句を2回以上指定した場合は、最後に指定したヒント句が適用されます。</p>
 246 <div class="tips">
 247 <span class="strong">Setヒント句の制限</span>
 248 <p>Setヒント句に問い合わせ計画のGUCパラメータ以外を指定した場合の動作は保証できません。問い合わせ計画以外のGUCパラメータを指定した場合の例の一つとして、<a href="#hint-GUC">pg_hint_planのGUCパラメータ</a>を指定した場合の動作を、以下に示します。<p>
 249 <ul>
 250 <li>pg_hint_plan.enable_hint、pg_hint_plan.enable_hint_tableをSetヒント句の対象に指定した場合は、無効になります。なお、pg_hint_plan.debug_printをonに設定していると、そのヒント句はログ出力で「適用されたヒント句」として出力されます。</li>
 251 <li>pg_hint_plan.debug_printをSetヒント句の対象に指定した場合は、指定したとおりに適用されます。</li>
 252 <li>pg_hint_plan.parse_messagesをSetヒント句の対象に指定した場合は、構文エラーと一部のSetヒント句のエラーのメッセージはクエリ開始時の設定レベルで出力され、それ以外のメッセージはSetヒント句で指定したレベルで出力されます。</li>
 253 </ul>
 254 </div>
 255
 256 <h3 id="hint-GUC">pg_hint_planのGUCパラメータ</h3>
 257 <p>pg_hint_planの動作を制御するGUCパラメータを以下に記述します。</p>
 258 <table>
 259 <thead>
 260 <tr>
 261 <tr><th>GUCパラメータ</th><th>説明</th><th>デフォルト値</th></tr>
 262 </tr></thead>
 263 <tbody>
 264 <tr><td>pg_hint_plan.enable_hint</td>
 265   <td>pg_hint_planの機能を有効または無効にします。</td><td>on</td></tr>
 266 <tr><td>pg_hint_plan.enable_hint_table</td>
 267   <td>ヒントをテーブルで指定する機能を有効または無効にします。</td><td>off</td></tr>
 268 <tr><td>pg_hint_plan.debug_print</td>
 269   <td>指定したヒントが実行計画生成にどのように影響したかを出力します。メッセージはLOGメッセージレベルで出力されますので、デフォルトではサーバログに出力され、クライアントには渡されません。</td><td>off</td></tr>
 270 <tr><td>pg_hint_plan.parse_messages</td>
 271   <td>指定したヒントを解釈できなかった場合に、どのメッセージ階層でログを出力するかを指定します。有効な値は、debug5、debug4、debug3、debug2、debug1、log、info、notice、warning、またはerrorです。fatalとpanicは指定できません。</td><td>info</td></tr>
 272
 273 </tbody>
 274 </table>
 275 <p>
 276 PostgreSQL 9.1の環境でこれらのパラメータをpostgresql.confファイルで設定するには、<a href="http://www.postgresql.jp/document/9.1/html/runtime-config-custom.html#GUC-CUSTOM-VARIABLE-CLASSES">custom_variable_classes</a>にpg_hint_planを加える必要があります。
 277 典型的な使用例は以下のようになります。
 278 </p>
 279 <pre>
 280 # postgresql.conf
 281 shared_preload_libraries = 'pg_hint_plan'
 282
 283 custom_variable_classes = 'pg_hint_plan'    # 9.2以降は廃止されたため記述不要
 284 pg_hint_plan.parse_messages = 'debug2'
 285 </pre>
 286 <p>
 287 PostgreSQL 9.2以降ではcustom_variable_classesは廃止されているため、pg_hint_planのGUCパラメータを標準のGUCパラメータと同様に記述することができます。
 288 </p>
 289
 290 <h2 id="install">インストール</h2>
 291 <p>pg_hint_planのインストール方法について説明します。</p>
 292
 293 <h3 id="build">ビルド</h3>
 294 <p>pg_hint_planをソースコードからビルドする場合、pg_hint_planのソースを展開したディレクトリでmake → make installの順に実行します。make installはPostgreSQLをインストールしたOSユーザで実行します。なお、pg_hint_planのビルドにはpgxsを使用するので、RPM版のPostgreSQLを使用している環境では、postgresql-devel パッケージが必要です。</p>
 295 <p>以下にビルドの例を示します。</p>
 296 <pre>
 297 $ tar xzvf pg_hint_plan-1.0.0.tar.gz
 298 $ cd pg_hint_plan-1.0.0
 299 $ make
 300 $ su
 301 # make install
 302 </pre>
 303
 304 <h3 id="create-extension">データベースへの登録</h3>
 305 <p>pg_hint_planはPostgreSQLの拡張(EXTENSION)を使用しているので、pg_hint_planを利用するデータベースにスーパーユーザもしくはそのデータベースの所有者で接続してCREATE EXTENSIONコマンドを実行します。</p>
 306 <p>以下にデータベースへの登録の例を示します。 <i>dbname</i>は対象となるデータベース名を意味します。</p>
 307 <pre>
 308 $ psql -d <i>dbname</i> -c "CREATE EXTENSION pg_hint_plan"
 309 </pre>
 310
 311 <h3 id="hint-load">pg_hint_planのロード</h3>
 312 <p>特定のセッションでのみpg_hint_planを使う場合は、以下の例のようにpg_hint_planの共有ライブラリをLOADコマンドでロードします。一般ユーザで利用する場合は$libdir/pluginsにもインストールする必要があるので注意してください。
 313 <pre>
 314 postgres=# LOAD 'pg_hint_plan';
 315 LOAD
 316 postgres=# </pre></p>
 317 <p>全てのセッションでpg_hint_planを有効にするには、shared_preload_libraries GUCパラメータに'pg_hint_plan'を追加してからサーバを再起動します。</p>
 318 <p>注意: pg_hint_planを<a href="#create-extension">データベースに登録</a>せずに、ロード後にSQL文を実行すると以下に示す例のようなエラーとなります。 pg_hint_planを使うときは、データベースへの登録を忘れないように注意してください。</p>
 319 <pre>
 320 postgres=# EXPLAIN SELECT * FROM pgbench_accounts a WHERE aid = 1;
 321 ERROR:  schema "hint_plan" does not exist
 322 LINE 1: SELECT hints   FROM hint_plan.hints  WHERE norm_query_string...
 323                             ^
 324 QUERY:  SELECT hints   FROM hint_plan.hints  WHERE norm_query_string = $1    AND ( application_name = $2     OR application_name = '' )  ORDER BY application_name DESC
 325 postgres=#
 326 </pre>
 327
 328 <h2 id="uninstall">アンインストール</h2>
 329 <p>pg_hint_planをアンインストールするときは、以下の手順を実行します。 <i>dbname</i>は対象となるデータベース名を意味します。</p>
 330 <ol>
 331 <li>pg_hint_planのソースを展開したディレクトリでmake uninstallを実行します。make uninstallはPostgreSQLをインストールしたOSユーザで実行します。</li>
 332 <pre>
 333 $ cd pg_hint_plan-1.0.0
 334 $ su
 335 # make uninstall
 336 </pre>
 337 <li>pg_hint_planを登録したデータベースにスーパーユーザもしくはそのデータベースの所有者で接続して、DROP EXTENSIONコマンドおよびDROP SCHEMAコマンドを実行します。</li>
 338 <pre>
 339 $ psql -d <i>dbname</i> -c "DROP EXTENSION pg_hint_plan"
 340 $ psql -d <i>dbname</i> -c "DROP SCHEMA hint_plan"
 341 </pre>
 342 </ol>
 343
 344 <h2 id="restrictions">使用上の注意と制約</h2>
 345 <p>pg_hint_planを使用する際には、以下の注意と制約があります。</p>
 346 <h3>ヒントの指定方法</h3>
 347 <dl>
 348 <dt>コメント指定でのヒント記述位置</dt>
 349 <dd>ヒントはクエリの先頭または途中に記述できます。ただし、ヒントをクエリの途中に記述する場合、ヒント用のブロックコメントより前に以下の文字<span class="strong">以外</span>が含まれると、「/*+」で始まるコメントでもヒントと見なされず無視されます。
 350 <ul>
 351 <li>空白文字（半角スペース、水平/垂直タブ、改行、フォームフィード、復帰）</li>
 352 <li>アルファベット（大文字/小文字）</li>
 353 <li>数字</li>
 354 <li>アンダースコア</li>
 355 <li>カンマ</li>
 356 <li>開き括弧（(）、閉じ括弧（)）</li>
 357 </ul>
 358 <p>指定したヒントが無視される例を以下に示します。</p>
 359 <ol>
 360 <li>二重引用符（"）がヒント用のブロックコメントより前に含まれている場合</li>
 361 <pre>
 362 postgres=# SELECT bid AS "BID"
 363 postgres-# /*+
 364 postgres*#     SeqScan(b)
 365 postgres*#  */
 366 postgres-#   FROM pgbench_branches b;
 367 ...
 368 </pre>
 369 <li>演算子（>=）がヒント用のブロックコメントより前に含まれている場合</li>
 370 <pre>
 371 postgres=# WITH avg_aid AS (
 372 postgres(#    SELECT avg(aid) FROM pgbench_history h
 373 postgres(#     WHERE delta >= 0
 374 postgres(# )
 375 postgres-# /*+
 376 postgres*#     SeqScan(h)
 377 postgres*#  */
 378 postgres-# SELECT * FROM avg_aid;
 379 ...
 380 </pre>
 381 </ol>
 382 一つのクエリに複数のブロックコメントを記述する場合は、最初のブロックコメントにのみヒントを記述してください。二番目以降のブロックコメントは、ヒントと見なされず無視されます。以下の例では、HashJoin(a b)とSeqScan(a)がヒントと見なされ、IndexScan(a)とMergeJoin(a b)は無視されています。</p>
 383 <pre>
 384 postgres=# /*+
 385 postgres*#     <span class="strong">HashJoin(a b)</span>
 386 postgres*#     <span class="strong">SeqScan(a)</span>
 387 postgres*#  */
 388 postgres-# /*+ IndexScan(a) */
 389 postgres-# EXPLAIN SELECT /*+ MergeJoin(a b) */ *
 390 postgres-#    FROM pgbench_branches b
 391 postgres-#    JOIN pgbench_accounts a ON b.bid = a.bid
 392 postgres-#   ORDER BY a.aid;
 393                                       QUERY PLAN
 394 ---------------------------------------------------------------------------------------
 395  Sort  (cost=31465.84..31715.84 rows=100000 width=197)
 396    Sort Key: a.aid
 397    ->  <span class="strong">Hash Join</span>  (cost=1.02..4016.02 rows=100000 width=197)
 398          Hash Cond: (a.bid = b.bid)
 399          ->  <span class="strong">Seq Scan on pgbench_accounts a</span>  (cost=0.00..2640.00 rows=100000 width=97)
 400          ->  Hash  (cost=1.01..1.01 rows=1 width=100)
 401                ->  Seq Scan on pgbench_branches b  (cost=0.00..1.01 rows=1 width=100)
 402 (7 rows)
 403
 404 postgres=# </pre>
 405 </dd>
 406 <dt>PL/pgSQL中の個別のクエリに対するヒント</dt>
 407 <dd>ヒントは、PL/pgSQLブロック中の各クエリにも指定できます。ただし、コメントで指定する場合は、SELECTなどのSQLキーワードより後に指定してください。
 408 <p>以下の例では、一つ目のクエリにNoIndexScanを、二つ目のクエリにSeqScanをそれぞれ指定しています。</p>
 409 <pre>
 410 postgres=# CREATE FUNCTION hints_func(integer) RETURNS integer AS $$
 411 postgres$# DECLARE
 412 postgres$#     id  integer;
 413 postgres$#     cnt integer;
 414 postgres$# BEGIN
 415 postgres$#     SELECT /*+<span class="strong">NoIndexScan(a)</span>*/ aid
 416 postgres$#         INTO id FROM pgbench_accounts a WHERE aid = $1;
 417 postgres$#     SELECT /*+<span class="strong">SeqScan(a)</span>*/ count(*)
 418 postgres$#         INTO cnt FROM pgbench_accounts a;
 419 postgres$#     RETURN id + cnt;
 420 postgres$# END;
 421 postgres$# $$ LANGUAGE plpgsql;
 422 </pre>
 423 </dd>
 424 <dt>オブジェクト名の引用符付け</dt>
 425 <dd>ヒントに記述するオブジェクト名や別名が括弧（(、)のいずれか）、二重引用符（"）、空白（スペース、タブ、改行のいずれか）を含む場合は、通常のSQL文で使う場合と同じように二重引用符(")で囲んでください。二重引用符を含むオブジェクト名は、全体を二重引用符で括ったうえで、内部に含む二重引用符を二重引用符でエスケープしてください(例: 「quoted"table"name」→「"quoted""table""name"」)。</dd>
 426 <dt>同一名称テーブルの区別</dt>
 427 <dd>スキーマ違いや同一テーブルの複数回使用などでクエリ中に同一名称のテーブルが複数回出現する場合は、テーブルに別名をつけてそれぞれのテーブルを区別してください。以下の例の1つ目のSQL文では、HashJoin(t1 t1)をヒントに指定したとき、ヒント句対象のオブジェクトが特定できずにエラーになっています。2つ目のSQL文では、各テーブルにptやstという別名をつけているため、実行計画作成時にヒントで指定した通りにHash Joinを選択しています。</p>
 428 <pre>
 429 postgres=# /*+ <span class="strong">HashJoin(t1 t1)</span>*/
 430 postgres-# EXPLAIN SELECT * FROM s1.t1
 431 postgres-# JOIN public.t1 ON (s1.t1.id=public.t1.id);
 432 INFO:  hint syntax error at or near "HashJoin(t1 t1)"
 433 <span class="strong">DETAIL:  Relation name "t1" is ambiguous.</span>
 434                             QUERY PLAN
 435 ------------------------------------------------------------------
 436  Merge Join  (cost=337.49..781.49 rows=28800 width=8)
 437    Merge Cond: (s1.t1.id = public.t1.id)
 438    ->  Sort  (cost=168.75..174.75 rows=2400 width=4)
 439          Sort Key: s1.t1.id
 440          ->  Seq Scan on t1  (cost=0.00..34.00 rows=2400 width=4)
 441    ->  Sort  (cost=168.75..174.75 rows=2400 width=4)
 442          Sort Key: public.t1.id
 443          ->  Seq Scan on t1  (cost=0.00..34.00 rows=2400 width=4)
 444 (8 行)
 445
 446 postgres=# /*+ <span class="strong">HashJoin(pt st)</span> */
 447 postgres-# EXPLAIN SELECT * FROM s1.t1 st
 448 postgres-# JOIN public.t1 pt ON (st.id=pt.id);
 449                              QUERY PLAN
 450 ---------------------------------------------------------------------
 451  <span class="strong">Hash Join</span>  (cost=64.00..1112.00 rows=28800 width=8)
 452    Hash Cond: (st.id = pt.id)
 453    ->  Seq Scan on t1 st  (cost=0.00..34.00 rows=2400 width=4)
 454    ->  Hash  (cost=34.00..34.00 rows=2400 width=4)
 455          ->  Seq Scan on t1 pt  (cost=0.00..34.00 rows=2400 width=4)
 456 (5 行)
 457
 458 postgres=#</pre>
 459 </p>
 460 </dd>
 461 <dt>FROM句にVALUESコマンドを指定した場合の制限</dt>
 462 <dd>FROM句にVALUESコマンドを指定した場合は、ヒント句のオブジェクト名に「*VALUES*」を指定してください。これは、VALUESの結果に別名を指定しても、PostgreSQL本体側で「*VALUES*」に名称が置き換えられるためです。複数のVALUESを使用する場合、この動作によりヒント句の対象を特定できません。よって、実行計画を制御できません。
 463 <pre>
 464 postgres=# /*+ <span class="strong">MergeJoin(a *VALUES*)</span> */
 465 postgres-# EXPLAIN SELECT *
 466 postgres-#    FROM pgbench_accounts a
 467 postgres-#    JOIN (VALUES (1,1),(2,2)) <span class="strong">v</span> (vid, vbalance) ON a.aid = v.vid
 468 postgres-#   ORDER BY a.aid;
 469                                                   QUERY PLAN
 470 ---------------------------------------------------------------------------------------------------------------
 471  <span class="strong">Merge Join</span>  (cost=0.04..4497.33 rows=2 width=105)
 472    Merge Cond: (a.aid = "*VALUES*".column1)
 473    ->  Index Scan using pgbench_accounts_pkey on pgbench_accounts a  (cost=0.00..4247.26 rows=100000 width=97)
 474    ->  Sort  (cost=0.04..0.04 rows=2 width=8)
 475          Sort Key: "*VALUES*".column1
 476          ->  Values Scan on <span class="strong">"*VALUES*"</span>  (cost=0.00..0.03 rows=2 width=8)
 477 (6 行)
 478
 479 postgres=#
 480 </pre>
 481 </dd>
 482 </dl>
 483
 484 <h3>ヒントの適用対象の指定</h3>
 485 <dl>
 486 <dt>クエリに明記されていないテーブルへのヒント句適用</dt>
 487 <dd>ヒント句で指定した名称と一致すれば、ビュー定義や関数内クエリなどに出現するテーブルについても、ヒントを指定したクエリ内と同じようにヒント句が適用されます。このため、ヒント句の適用有無や適用するヒント句をそれぞれのテーブルで変えたい場合は、それぞれ異なる別名を指定してください。</br>
 488 以下の例では、ビュー定義で使われている「t1」という別名をSeqScanヒント句で指定したことで、表スキャンとビュー経由のスキャンの両方でSeq Scanが選択されています。ビュー定義で使用されている「t1」とは別の別名を実表に指定することで、個別にスキャン方式を制御できます。
 489 <pre>
 490 postgres=# CREATE VIEW view1 AS SELECT * FROM table1 <span class="strong">t1</span>;
 491 CREATE TABLE
 492 postgres=# /*+ SeqScan(<span class="strong">t1</span>) */
 493 postgres=# EXPLAIN SELECT * FROM table1 <span class="strong">t1</span> JOIN view1 t2 ON (t1.key = t2.key) WHERE t2.key = 1;
 494                            QUERY PLAN
 495 -----------------------------------------------------------------
 496  Nested Loop  (cost=0.00..358.01 rows=1 width=16)
 497    ->  Seq Scan on table1 <span class="strong">t1</span>  (cost=0.00..179.00 rows=1 width=8)
 498          Filter: (key = 1)
 499    ->  Seq Scan on table1 <span class="strong">t1</span>  (cost=0.00..179.00 rows=1 width=8)
 500          Filter: (key = 1)
 501 (5 rows)
 502
 503 postgres=# /*+ SeqScan(<span class="strong">t3</span>) */
 504 postgres=# EXPLAIN SELECT * FROM table1 <span class="strong">t3</span> JOIN view1 t2 ON (t1.key = t2.key) WHERE t2.key = 1;
 505                                    QUERY PLAN
 506 --------------------------------------------------------------------------------
 507  Nested Loop  (cost=0.00..187.29 rows=1 width=16)
 508    ->  Seq Scan on table1 <span class="strong">t3</span>  (cost=0.00..179.00 rows=1 width=8)
 509          Filter: (key = 1)
 510    ->  Index Scan using foo_pkey on table1 t1  (cost=0.00..8.28 rows=1 width=8)
 511          Index Cond: (key = 1)
 512 (5 rows)
 513
 514 </pre>
 515 </dd>
 516 <dt>継承テーブルに対するヒント句</dt>
 517 <dd>継承テーブルにスキャン方式のヒント句を指定する場合は、オブジェクト名として親テーブルの名称または別名を指定してください。全ての子テーブルに同じスキャン方式を選択します。子テーブルごとに別のスキャン方式を指定することはできません。</dd>
 518 <dt>ビューやルールを使うクエリのヒント</dt>
 519 <dd>ルールを定義したテーブルやビューを複数用いるときに、各ビュー内のテーブルの別名やルール書き換え後のクエリのテーブルの別名が重複した場合は、ヒント句の対象を区別できません。区別する場合は、各ビュー内のテーブルの別名やルール書き換え後のクエリのテーブルの別名を重複させないでください。</dd>
 520 <dt>ルールを使うクエリでのヒントの適用範囲</dt>
 521 <dd>ルールによるクエリ書き換えによってクエリが複数になる場合は、書き換え前のクエリで指定したヒントが全てのクエリで使用されます。ルール内のクエリにヒントを記述しても、そのヒントは適用されません。</dd>
 522 <dt>マルチステートメントでのヒントの適用範囲</dt>
 523 <dd>クエリをマルチステートメントで実行する場合は、1つ目のクエリで指定したヒントが全てのクエリで使用されます。2つ目以降のクエリに指定したヒントは無視されます。psqlコマンドで-cオプションで複数のクエリを指定した場合などにマルチステートメントで実行されます。</dd>
 524 <dt>副問い合わせ結果をヒントに指定する方法</dt>
 525 <dd>以下の副問い合わせの結果をヒントに指定する場合は、ヒント句のオブジェクト名に「ANY_subquery」を指定してください。
 526 <ul>
 527 <li>IN (SELECT ... { LIMIT | OFFSET 等} ... )</li>
 528 <li>ANY (SELECT ... { LIMIT | OFFSET 等} ...)</li>
 529 <li>SOME (SELECT ... { LIMIT | OFFSET 等} ...)</li>
 530 </ul>
 531 PostgreSQLは、実行計画を生成するときに副問い合わせを上位の問合せに併合することがあります。しかし、上記のような副問い合わせの場合には併合せず、これらの副問い合わせの結果に内部的に「ANY_subquery」という固定名をつけます。以下の例では、その固定名を指定したヒント句の効果でHash Joinを選択しています。
 532 <pre>
 533 postgres=# /*+HashJoin(a1 ANY_subquery)*/
 534 postgres=# EXPLAIN SELECT *
 535 postgres=#    FROM pgbench_accounts a1
 536 postgres=#   WHERE aid IN (SELECT bid FROM pgbench_accounts a2 LIMIT 10);
 537                                          QUERY PLAN
 538
 539 ---------------------------------------------------------------------------------------------
 540  Hash Semi Join  (cost=0.49..2903.00 rows=1 width=97)
 541    Hash Cond: (a1.aid = a2.bid)
 542    ->  Seq Scan on pgbench_accounts a1  (cost=0.00..2640.00 rows=100000 width=97)
 543    ->  Hash  (cost=0.36..0.36 rows=10 width=4)
 544          ->  Limit  (cost=0.00..0.26 rows=10 width=4)
 545                ->  Seq Scan on pgbench_accounts a2  (cost=0.00..2640.00 rows=100000 width=4)
 546 (6 rows)
 547
 548 postgres=#
 549 </pre>
 550 一つのクエリで上記のような副問い合わせを複数使用している場合は、「ANY_subquery」と指定しても対象を特定できないため、ヒント句はエラーとなり無視されます。</br>
 551 </dd>
 552 <dt>IndexOnlyScanヒント句の指定(PostgreSQL 9.2以降)</dt>
 553 <dd>ヒント句の対象となるテーブルにIndex Only Scanが可能なインデックスとIndex Only Scanが不可能なインデックスが存在する場合、Index Only Scanが可能なインデックスをテーブルと併せてIndexOnlyScanヒント句に指定しないとIndex Scanが選択されることがあります。</dd>
 554 <dt>NoIndexScanヒント句の注意点(PostgreSQL 9.2以降)</dt>
 555 <dd>PostgreSQL 9.2以降でNoIndexScanヒント句を指定した場合は、Index ScanだけでなくIndex Only Scanも選択されません。</dd>
 556 </dl>
 557
 558 <h3>ヒント指定エラーの扱い</h3>
 559 <dt>構文エラー</dt>
 560 <dd>ヒント句の記述に構文上の誤りがあった場合、pg_hint_planは誤った記述より前のヒント句のみ有効とし、誤った記述以降のヒント句を無視してクエリを実行します。誤りの内容はpg_hint_plan.parse_messagesで指定したレベルでサーバログに記録されます。
 561 <ul>
 562 <li>ヒント句名を間違っている。</li>
 563 <li>オブジェクト指定を正しく括弧で囲っていない。</li>
 564 <li>オブジェクト名を空白で区切っていない。</li>
 565 </ul>
 566 </dd>
 567 <dt>オブジェクト指定エラー</dt>
 568 <dd>pg_hint_planは、ヒント句対象のオブジェクト指定に誤りがあった場合、pg_hint_planは不正なヒント句のみを無視し、それ以外のヒント句を使ってクエリを実行します。誤りの内容はpg_hint_plan.parse_messagesで指定したレベルでサーバログに記録されます。誤ったオブジェクト指定の例を以下に示します。
 569 <ul>
 570 <li>クエリ中に同じ名称のテーブル名または別名のテーブルがあり、それに対してヒント句を指定した。</li>
 571 <li>結合方式や結合順序のヒント句に同じオブジェクト名を複数回指定した。</li>
 572 </ul>
 573 </dd>
 574 <div class="tips">
 575 <span class="strong">構文エラーとオブジェクト指定エラーが同時に起こった場合</span>
 576 <p>構文エラーより前のヒント句の中から、オブジェクト指定エラーでないヒント句を適用します。</p>
 577 </div><br>
 578 <dt>指定するヒント句の種類の重複</dt>
 579 <dd>同じオブジェクトに対して同じグループのヒント句を重複して指定した場合は、各グループで最後に指定したヒント句を使用します。</dd>
 580 <dt>ネストしたブロックコメント</dt>
 581 <dd>pg_hint_planでは、ヒントを指定したブロックコメントにネストしたブロックコメントを含めることができません。ネストしたブロックコメントを含めた場合は、誤った記述に関する情報を出力しますがエラー終了しません。ヒントを無視してクエリを実行します。</dd>
 582 <dt>メッセージの出力レベル</dt>
 583 <dd>ヒントに誤りがあった場合に出力されるメッセージのレベルは、基本的にはpg_hint_plan.parse_messagesに指定したレベルです。ただし、ヒント句に指定したオブジェクトの長さが識別子の最大長(デフォルトでは63バイト)を超えた際に切り詰めた場合は、NOTICEで出力します。</dd>
 584
 585 <h3>機能制限</h3>
 586 <dt>標準のGUCパラメータの影響</dt>
 587 <dd>FROMリストの数がfrom_collapse_limitの設定値以上の場合、またはFROMリストの数がjoin_collapse_limitの設定値より大きい場合は、結合順序のヒント句が無視されます。また、FROMリストの数がgeqo_thresholdの設定値以上の場合は、結合順序のヒント句、および結合方式のヒント句が無視されます。ヒント句が使われるようにするには、これらのGUCパラメータの値を大きくしてください。</dd>
 588 <dt>ヒント句で制御できないケース</dt>
 589 <dd>pg_hint_planでは、PostgreSQLのプランナが候補としてあげる事ができない実行計画をヒント句に指定しても、その実行計画を生成することはできません。PostgreSQLのプランナが候補としてあげる事ができない実行計画の例を以下に示します。
 590 <ul>
 591 <li>FULL OUTER JOINではNested Loopは、プランナが実行計画の候補として扱いません。</li>
 592 <li>WHERE句やJOIN条件などに指定していない列のみを含むインデックスは、プランナが実行計画の候補として扱いません。</li>
 593 <li>検索条件にctidを指定しない場合はTid Scanは、プランナが実行計画の候補として扱いません。</li>
 594 </ul>
 595 </dd>
 596 <dt>ECPGにおける制限</dt>
 597 <dd>ECPGで実装したアプリケーションから発行するクエリにヒントをコメントで指定した場合、実行計画を制御できません。これは、CプリプロセッサがCコードに変換するタイミングで、全てのブロックコメントを取り除いてしまうためです。ただし、C言語文字列に格納したクエリをEXECUTEコマンドで実行する動的SQLの場合は、コメントでヒントを指定しても実行計画を制御できます。</dd>
 598 <dt>ヒントによるフィンガープリントの変化</dt>
 599 <dd>SQLコメントでヒントを指定した場合、SQL文フィンガープリントベースのクエリキャッシュなどでは、ヒントが異なれば別のSQL文として扱われます。pg_stat_statementも9.1では別クエリとして集計しますが、9.2ではクエリ集約機能によりコメントが除去されるので、コメントで指定したヒントのみが異なるクエリは同じクエリとして扱われます。</dd>
 600
 601 </dl>
 602
 603 <h2 id="requirement">動作環境</h2>
 604 <dl>
 605 <dt>PostgreSQL</dt>
 606   <dd>バージョン 9.1.4、9.2.1</dd>
 607 <dt>動作検証済みOS</dt>
 608   <dd>RHEL 6.1</dd>
 609 </dl>
 610
 611 <h2 id="seealso">関連項目</h2>
 612 <h3 id="postgresql_document">PostgreSQLドキュメント</h3>
 613 <a href="http://www.postgresql.jp/document/current/html/sql-explain.html">EXPLAIN</a>
 614 <a href="http://www.postgresql.jp/document/current/html/sql-set.html">SET</a>
 615 <a href="http://www.postgresql.jp/document/current/html/runtime-config.html">サーバの設定</a>
 616 <hr>
 617
 618 <div class="navigation">
 619   <a href="pg_hint_plan-ja.html">pg_hint_plan</a>
 620 </div>
 621
 622 <p class="footer">Copyright (c) 2012-2013, NIPPON TELEGRAPH AND TELEPHONE CORPORATION</p>
 623
 624 <!--
 625 <script type="text/javascript">
 626 var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
 627 document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
 628 </script><script src="pg_statsinfo-ja_files/ga.js" type="text/javascript"></script>
 629 <script type="text/javascript">
 630 try{
 631 var pageTracker = _gat._getTracker("UA-10244036-6");
 632 pageTracker._trackPageview();
 633 } catch(err) {}
 634 </script>
 635 -->
 636 </body>
 637 </html>