• R/O
  • HTTP
  • SSH
  • HTTPS

pg_hint_plan: コミット

firtst release


コミットメタ情報

リビジョンbaa9589b2a8e242480097de3b6c9ea26951d45a5 (tree)
日時2019-01-17 17:14:19
作者Kyotaro Horiguchi <horiguchi.kyotaro@lab....>
コミッターKyotaro Horiguchi

ログメッセージ

Fix documentation.

Fixed wrong or stale descriptions, and poor or broken styles of
the documentation.

変更サマリ

差分

--- a/doc/hint_list.html
+++ b/doc/hint_list.html
@@ -10,7 +10,7 @@
1010 </head>
1111
1212 <body>
13-<h1 id="pg_hint_plan">pg_hint_plan 1.2 Appendices</h1>
13+<h1 id="pg_hint_plan">pg_hint_plan 1.3 Appendices</h1>
1414 <div class="navigation">
1515 <a href="pg_hint_plan-ja.html">pg_hint_plan</a> &gt;
1616 <a href="hint_list-ja.html">Appendix A. Hints list</a>
--- a/doc/pg_hint_plan-ja.html
+++ b/doc/pg_hint_plan-ja.html
@@ -66,18 +66,18 @@
6666 <p>ヒント用コメントと通常のコメントを区別するために、ヒント用のブロックコメントは「<span class="bold">/*+</span>」で始めます。ヒントの対象は、カッコ内にオブジェクト名または別名で指定します。オブジェクト名は、スペース、タブ、または改行のいずれかで区切って指定します。</p>
6767 <p>以下の例では、HashJoinとSeqScanヒント句により、pgbench_accountsテーブルに対するSeq Scanの結果をHash Joinする実行計画が選択されています。なおかつ、Setヒント句によりこのクエリの実行計画を作成する間だけrandom_page_costが2.0に変更されています。</p>
6868 <pre>
69-<b>postgres=#</b> EXPLAIN (VERBOSE, COSTS)
70-<b>postgres-# /*+</b>
71-<b>postgres*# SeqScan(a)</b>
72-<b>postgres*# HashJoin(a b)</b>
73-<b>postgres*# Set(random_page_cost 2.0)</b>
74-<b>postgres*# */</b>
75-<b>postgres-#</b> SELECT *
76-<b>postgres-#</b> FROM pgbench_accounts a
77-<b>postgres-#</b> JOIN pgbench_branches b
78-<b>postgres-#</b> ON a.bid = b.bid
79-<b>postgres-#</b> ORDER BY a.aid
80-<b>postgres-#</b> LIMIT 10;
69+<span class="strong">postgres=#</span> EXPLAIN (VERBOSE, COSTS)
70+<span class="strong">postgres-# /*+</span>
71+<span class="strong">postgres*# SeqScan(a)</span>
72+<span class="strong">postgres*# HashJoin(a b)</span>
73+<span class="strong">postgres*# Set(random_page_cost 2.0)</span>
74+<span class="strong">postgres*# */</span>
75+<span class="strong">postgres-#</span> SELECT *
76+<span class="strong">postgres-#</span> FROM pgbench_accounts a
77+<span class="strong">postgres-#</span> JOIN pgbench_branches b
78+<span class="strong">postgres-#</span> ON a.bid = b.bid
79+<span class="strong">postgres-#</span> ORDER BY a.aid
80+<span class="strong">postgres-#</span> LIMIT 10;
8181 QUERY PLAN
8282 ----------------------------------------------------------------------------------------------------
8383 Limit (cost=6176.99..6177.01 rows=10 width=461)
@@ -124,37 +124,37 @@ postgres=#
124124 <p>以下の例では、ヒントの登録、ヒント登録情報の変更、ヒントの解除の順に、クエリの実行結果を示しています。
125125 </p>
126126 <pre>
127-<b>postgres=#</b> INSERT INTO hint_plan.hints(norm_query_string, application_name, hints)
128-<b>postgres-#</b> VALUES (
129-<b>postgres(#</b> 'EXPLAIN (COSTS false) SELECT * FROM t1 WHERE t1.id = ?;',
130-<b>postgres(#</b> '',
131-<b>postgres(#</b> 'SeqScan(t1)'
132-<b>postgres(#</b> );
127+<span class="strong">postgres=#</span> INSERT INTO hint_plan.hints(norm_query_string, application_name, hints)
128+<span class="strong">postgres-#</span> VALUES (
129+<span class="strong">postgres(#</span> 'EXPLAIN (COSTS false) SELECT * FROM t1 WHERE t1.id = ?;',
130+<span class="strong">postgres(#</span> '',
131+<span class="strong">postgres(#</span> 'SeqScan(t1)'
132+<span class="strong">postgres(#</span> );
133133 INSERT 0 1
134-<b>postgres=#</b> UPDATE hint_plan.hints
135-<b>postgres-#</b> SET hints = 'IndexScan(t1)'
136-<b>postgres-#</b> WHERE id = 1;
134+<span class="strong">postgres=#</span> UPDATE hint_plan.hints
135+<span class="strong">postgres-#</span> SET hints = 'IndexScan(t1)'
136+<span class="strong">postgres-#</span> WHERE id = 1;
137137 UPDATE 1
138-<b>postgres=#</b> DELETE FROM hint_plan.hints
139-<b>postgres-#</b> WHERE id = 1;
138+<span class="strong">postgres=#</span> DELETE FROM hint_plan.hints
139+<span class="strong">postgres-#</span> WHERE id = 1;
140140 DELETE 1
141-<b>postgres=#</b>
141+<span class="strong">postgres=#</span>
142142 </pre>
143143 <p>なお、ヒントの登録や変更や解除はスーパーユーザでのみ可能です。一般ユーザでヒントの登録や変更や解除を実施したい場合は、スーパーユーザから一般ユーザにhint_plan.hintsテーブルの各権限を付与してください。</p>
144144 <p>以下の例では、hint_plan.hintsテーブルに対してINSERT権限を持たない一般ユーザがヒントの登録を実施しようとしたときの結果を示しています。</p>
145145 <pre>
146-<b>postgres=></b> INSERT INTO hint_plan.hints(norm_query_string, application_name, hints)
147-<b>postgres-></b> VALUES (
148-<b>postgres(></b> 'EXPLAIN (COSTS false) SELECT * FROM t1 WHERE t1.id = ?;',
149-<b>postgres(></b> '',
150-<b>postgres(></b> 'SeqScan(t1)'
151-<b>postgres(></b> );
146+<span class="strong">postgres=></span> INSERT INTO hint_plan.hints(norm_query_string, application_name, hints)
147+<span class="strong">postgres-></span> VALUES (
148+<span class="strong">postgres(></span> 'EXPLAIN (COSTS false) SELECT * FROM t1 WHERE t1.id = ?;',
149+<span class="strong">postgres(></span> '',
150+<span class="strong">postgres(></span> 'SeqScan(t1)'
151+<span class="strong">postgres(></span> );
152152 ERROR: permission denied for relation hints
153-<b>postgres=></b>
153+<span class="strong">postgres=></span>
154154 </pre>
155155 <p>以下の例では、テーブルに登録した「コメントでの指定」の例と同じヒントと、登録したクエリの実行結果を示しています。</p>
156156 <pre>
157-<b>postgres=#</b> SELECT * FROM hint_plan.hints;
157+<span class="strong">postgres=#</span> SELECT * FROM hint_plan.hints;
158158 id | norm_query_string | application_name | hints
159159 ----+----------------------------+------------------+--------------------------------------------------
160160 1 | EXPLAIN (VERBOSE, COSTS) +| psql | SeqScan(a)HashJoin(a b)Set(random_page_cost 2.0)
@@ -167,14 +167,14 @@ ERROR: permission denied for relation hints
167167 | | |
168168 ...
169169
170-<b>postgres=#</b> SET pg_hint_plan.enable_hint_table TO on;
171-<b>postgres=#</b> EXPLAIN (VERBOSE, COSTS)
172-<b>postgres-#</b> SELECT *
173-<b>postgres-#</b> FROM pgbench_accounts a
174-<b>postgres-#</b> JOIN pgbench_branches b
175-<b>postgres-#</b> ON a.bid = b.bid
176-<b>postgres-#</b> ORDER BY a.aid
177-<b>postgres-#</b> LIMIT 10;
170+<span class="strong">postgres=#</span> SET pg_hint_plan.enable_hint_table TO on;
171+<span class="strong">postgres=#</span> EXPLAIN (VERBOSE, COSTS)
172+<span class="strong">postgres-#</span> SELECT *
173+<span class="strong">postgres-#</span> FROM pgbench_accounts a
174+<span class="strong">postgres-#</span> JOIN pgbench_branches b
175+<span class="strong">postgres-#</span> ON a.bid = b.bid
176+<span class="strong">postgres-#</span> ORDER BY a.aid
177+<span class="strong">postgres-#</span> LIMIT 10;
178178 QUERY PLAN
179179 ----------------------------------------------------------------------------------------------------
180180 Limit (cost=6176.99..6177.01 rows=10 width=461)
@@ -182,10 +182,10 @@ ERROR: permission denied for relation hints
182182 -> Sort (cost=6176.99..6426.99 rows=100000 width=461)
183183 Output: a.aid, a.bid, a.abalance, a.filler, b.bid, b.bbalance, b.filler, a.aid
184184 Sort Key: a.aid
185- -> <b><u>Hash Join</u></b> (cost=1.02..4016.02 rows=100000 width=461)
185+ -> <span class="strong">Hash Join</span> (cost=1.02..4016.02 rows=100000 width=461)
186186 Output: a.aid, a.bid, a.abalance, a.filler, b.bid, b.bbalance, b.filler, a.aid
187187 Hash Cond: (a.bid = b.bid)
188- -> <b><u>Seq Scan on public.pgbench_accounts a</u></b> (cost=0.00..2640.00 rows=100000 width=97)
188+ -> <span class="strong">Seq Scan on public.pgbench_accounts a</span> (cost=0.00..2640.00 rows=100000 width=97)
189189 Output: a.aid, a.bid, a.abalance, a.filler
190190 -> Hash (cost=1.01..1.01 rows=1 width=364)
191191 Output: b.bid, b.bbalance, b.filler
@@ -260,21 +260,21 @@ postgres-# ORDER BY a.aid;
260260 <p>結合対象のテーブルが3つ以上ある場合、結合方式のヒント句を指定したとしてもコスト見積もりによっては対象のテーブルが直接結合されないことがあります。対象のテーブルが直接結合されない場合は、結合順序のヒント句を併せて指定します。</p>
261261 <p>以下の例では、table1とtable2を直接結合する場合はNested Loopを、table1とtable2とtable3を結合する場合はMerge Joinを指定しています。また、コスト見積もりによってはtable1とtable2が直接結合されない場合を避けるため、table1とtable2を結合してからtable3を結合するようにLeadingヒント句を併用しています。</p>
262262 <pre>
263-<b>postgres=# /*+</b>
264-<b>postgres*# NestLoop(t1 t2)</b>
265-<b>postgres*# MergeJoin(t1 t2 t3)</b>
266-<b>postgres*# Leading(t1 t2 t3)</b>
267-<b>postgres*# */</b>
268-<b>postgres-#</b> SELECT * FROM table1 t1
269-<b>postgres-#</b> JOIN table table2 t2 ON (t1.key = t2.key)
270-<b>postgres-#</b> JOIN table table3 t3 ON (t2.key = t3.key);
263+<span class="strong">postgres=# /*+</span>
264+<span class="strong">postgres*# NestLoop(t1 t2)</span>
265+<span class="strong">postgres*# MergeJoin(t1 t2 t3)</span>
266+<span class="strong">postgres*# Leading(t1 t2 t3)</span>
267+<span class="strong">postgres*# */</span>
268+<span class="strong">postgres-#</span> SELECT * FROM table1 t1
269+<span class="strong">postgres-#</span> JOIN table table2 t2 ON (t1.key = t2.key)
270+<span class="strong">postgres-#</span> JOIN table table3 t3 ON (t2.key = t3.key);
271271 ...
272272 </pre>
273273 </div>
274274 <h4>結合方向</h4>
275275 <p>上記の結合順序の指定を行なった際にはプランナの都合により結合方向(外部表/内部表もしくは駆動表/被駆動表の別)が期待とは異なるものになる場合があります。このような状況に対して結合方向を固定したい場合はもうひとつの書式を使う必要があります。</p>
276276 <pre>
277-<b>postgres=# /*+ Leading((t1 (t2 t3))) */</b> SELECT...
277+<span class="strong">postgres=# /*+ Leading((t1 (t2 t3))) */</span> SELECT...
278278 </pre>
279279 <p>この書式では2つの要素を丸括弧で囲ったものがネストする形になっており、一つの括弧内では1つ目の要素が外部/駆動表、2番めの要素が内部/被駆動表として結合されます。</p>
280280 <h4>見積もり件数補正</h4>
@@ -282,15 +282,15 @@ postgres-# ORDER BY a.aid;
282282 <p>見積もり件数補正対象として指定できるオブジェクトは結合方式と同じです。補正できるのは結合結果の見積もり件数だけで、スキャンの見積もり件数を補正することはできません。</p>
283283 <p>以下の例では、テーブルaとテーブルbの結合結果の件数を、ヒント句で指定した値に補正しています。</p>
284284 <pre>
285-<b>postgres=# /*+ Rows(a b #10) */</b>
286-<b>postgres-#</b> EXPLAIN SELECT *
287-<b>postgres-#</b> FROM pgbench_branches b
288-<b>postgres-#</b> JOIN pgbench_accounts a ON b.bid = a.bid
289-<b>postgres-#</b> WHERE aid &lt; 20
290-<b>postgres-#</b> ORDER BY a.aid;
285+<span class="strong">postgres=# /*+ Rows(a b #10) */</span>
286+<span class="strong">postgres-#</span> EXPLAIN SELECT *
287+<span class="strong">postgres-#</span> FROM pgbench_branches b
288+<span class="strong">postgres-#</span> JOIN pgbench_accounts a ON b.bid = a.bid
289+<span class="strong">postgres-#</span> WHERE aid &lt; 20
290+<span class="strong">postgres-#</span> ORDER BY a.aid;
291291 QUERY PLAN
292292 --------------------------------------------------------------------------------------------------------
293- Nested Loop (cost=0.29..9.92 rows=<b><u>10</u></b> width=461)
293+ Nested Loop (cost=0.29..9.92 rows=<span class="strong">10</span> width=461)
294294 Join Filter: (b.bid = a.bid)
295295 -> Index Scan using pgbench_accounts_pkey on pgbench_accounts a (cost=0.29. .8.62 rows=19 width=97)
296296 Index Cond: (aid &lt; 20)
@@ -304,19 +304,19 @@ postgres-# ORDER BY a.aid;
304304 <p>3番目のパラメータは強制の程度を指定します。 "soft" は max_parallel_workers_per_gather のみを変更して適用はプランナに任せます。"hard" は他のプランナ変数も変更するなどしてワーカ数を強制します。</p>
305305 <p>以下の例では、テーブル c1 とテーブル c2 の結合で各々異なるワーカ数を強制します。</p>
306306 <pre>
307-<b>postgres=#</b> explain <b>/*+ Parallel(c1 3 hard) Parallel(c2 5 hard) */</b>
307+<span class="strong">postgres=#</span> explain <span class="strong">/*+ Parallel(c1 3 hard) Parallel(c2 5 hard) */</span>
308308 select c2.a from c1 join c2 on (c1.a = c2.a);
309309 QUERY PLAN
310310 -------------------------------------------------------------------------------
311311 Hash Join (cost=2.86..11406.38 rows=101 width=4)
312312 Hash Cond: (c1.a = c2.a)
313313 -> Gather (cost=0.00..7652.13 rows=1000101 width=4)
314- <b><u>Workers Planned: 3</u></b>
315- -> Parallel Seq Scan on <b><u>c1</u></b> (cost=0.00..7652.13 rows=322613 width=4)
314+ <span class="strong">Workers Planned: 3</span>
315+ -> Parallel Seq Scan on <span class="strong">c1</span> (cost=0.00..7652.13 rows=322613 width=4)
316316 -> Hash (cost=1.59..1.59 rows=101 width=4)
317317 -> Gather (cost=0.00..1.59 rows=101 width=4)
318- <b><u>Workers Planned: 5</u></b>
319- -> Parallel Seq Scan on <b><u>c2</u></b> (cost=0.00..1.59 rows=59 width=4)
318+ <span class="strong">Workers Planned: 5</span>
319+ -> Parallel Seq Scan on <span class="strong">c2</span> (cost=0.00..1.59 rows=59 width=4)
320320 </pre>
321321
322322 <h4>GUCパラメータ</h4>
@@ -410,7 +410,7 @@ $ psql -d <i>dbname</i> -c "DROP SCHEMA hint_plan"
410410 <h2 id="restrictions">ヒントの指定に関する詳細</h2>
411411 <p>以下にいくつかのトピックに関してヒントの動作について説明します。</p>
412412 <dl>
413-<dt><h3>コメント指定でのヒント記述位置と文法</h3></dt>
413+<dt>コメント指定でのヒント記述位置と文法</dt>
414414 <dd>ヒントはクエリの先頭または途中に記述できます。ただし、ヒントをクエリの途中に記述する場合、ヒント用のブロックコメントより前に以下の文字<span class="strong">以外</span>が含まれると、「/*+」で始まるコメントでもヒントと見なされず無視されます。
415415 <ul>
416416 <li>空白文字(半角スペース、水平/垂直タブ、改行、フォームフィード、復帰)</li>
@@ -468,7 +468,7 @@ postgres-# ORDER BY a.aid;
468468
469469 postgres=# </pre>
470470 </dd>
471-<dt><h3>PL/pgSQL中の個別のクエリに対するヒント</h3></dt>
471+<dt>PL/pgSQL中の個別のクエリに対するヒント</dt>
472472 <dd>ヒントは、PL/pgSQLブロック中の各クエリにも指定できます。ただし、以下のような制約があります。
473473 <ul>
474474 <li>指定したヒントが適用されるSQLは以下の通りです。他のSQLにヒントを指定しても適用されません。
@@ -489,20 +489,20 @@ postgres$# DECLARE
489489 postgres$# id integer;
490490 postgres$# cnt integer;
491491 postgres$# BEGIN
492-postgres$# SELECT <b><u>/*+ NoIndexScan(a) */</u></b> aid
492+postgres$# SELECT <span class="strong">/*+ NoIndexScan(a) */</span> aid
493493 postgres$# INTO id FROM pgbench_accounts a WHERE aid = $1;
494-postgres$# SELECT <b><u>/*+ SeqScan(a) */</u></b> count(*)
494+postgres$# SELECT <span class="strong">/*+ SeqScan(a) */</span> count(*)
495495 postgres$# INTO cnt FROM pgbench_accounts a;
496496 postgres$# RETURN id + cnt;
497497 postgres$# END;
498498 postgres$# $$ LANGUAGE plpgsql;
499499 </pre>
500500 </dd>
501-<dt><h3>ヒント句内のオブジェクト名の文字ケース</h3></dt>
501+<dt>ヒント句内のオブジェクト名の文字ケース</dt>
502502 <dd>PostgreSQL は引用符で囲われないオブジェクト名を文字ケースを無視して扱いますが、pg_hint_plan は指定されたオブジェクト名の文字ケースはそのまま PostgreSQL の内部表現と比較します。つまり、ヒント句で TBL と指定した場合、データベース上で "TBL" と定義したもののみと合致し, TBL, tbl, Tbl など引用符で囲われないオブジェクト名とは合致しません。</dd>
503-<dt><h3>ヒント句内のオブジェクト名の引用符付け</h3></dt>
503+<dt>ヒント句内のオブジェクト名の引用符付け</dt>
504504 <dd>ヒントに記述するオブジェクト名や別名が括弧((、)のいずれか)、二重引用符(")、空白(スペース、タブ、改行のいずれか)を含む場合は、通常のSQL文で使う場合と同じように二重引用符(")で囲んでください。二重引用符を含むオブジェクト名は、全体を二重引用符で括ったうえで、内部に含む二重引用符を二重引用符でエスケープしてください(例: 「quoted"table"name」→「"quoted""table""name"」)。</dd>
505-<dt><h3>同一名称テーブルの区別</h3></dt>
505+<dt>同一名称テーブルの区別</dt>
506506 <dd>スキーマ違いや同一テーブルの複数回使用などでクエリ中に同一名称のテーブルが複数回出現する場合は、テーブルに別名をつけてそれぞれのテーブルを区別してください。以下の例の1つ目のSQL文では、HashJoin(t1 t1)をヒントに指定したとき、ヒント句対象のオブジェクトが特定できずにエラーになっています。2つ目のSQL文では、各テーブルにptやstという別名をつけているため、実行計画作成時にヒントで指定した通りにHash Joinを選択しています。</p>
507507 <pre>
508508 postgres=# /*+ <span class="strong">HashJoin(t1 t1)</span>*/
@@ -538,7 +538,7 @@ postgres=#</pre>
538538 </p>
539539 </dd>
540540 <dl>
541-<dt><h3>ビューおよびルールの中でアクセスされているテーブル</h3></dt>
541+<dt>ビューおよびルールの中でアクセスされているテーブル</dt>
542542 <dd>ヒント句で指定した名称と一致すれば、ビュー定義や関数内クエリなどに出現するテーブルについても、ヒントを指定したクエリ内と同じようにヒント句が適用されます。このため、ヒント句の適用有無や適用するヒント句をそれぞれのテーブルで変えたい場合は、それぞれ異なる別名を指定してください。</br>
543543 以下の例では、ビュー定義で使われている「t1」という別名をSeqScanヒント句で指定したことで、表スキャンとビュー経由のスキャンの両方でSeq Scanが選択されています。ビュー定義で使用されている「t1」とは別の別名を実表に指定することで、個別にスキャン方式を制御できます。
544544 <pre>
@@ -555,10 +555,10 @@ postgres=# EXPLAIN SELECT * FROM table1 <span class="strong">t1</span> JOIN view
555555 Filter: (key = 1)
556556 </pre>
557557 </dd>
558-<dt><h3>継承テーブル</h3></dt>
558+<dt>継承テーブル</dt>
559559 <dd>継承テーブルにスキャン方式のヒント句を指定する場合は、オブジェクト名として親テーブルの名称または別名を指定してください。全ての子テーブルに同じスキャン方式を選択します。子テーブルごとに別のスキャン方式を指定することはできません。</dd>
560560
561-<dt><h3>マルチステートメント</h3></dt>
561+<dt>マルチステートメント</dt>
562562 <dd>クエリをマルチステートメントで実行する場合は、ヒントの指定方法によって以下のように注意点が異なります。
563563 <dl>
564564 <dt>コメントでの指定</dt>
@@ -567,7 +567,7 @@ postgres=# EXPLAIN SELECT * FROM table1 <span class="strong">t1</span> JOIN view
567567 <dd>ヒントを指定したいクエリの定数部分を?に置き換えてから、全てのクエリを一つにまとめてヒント用テーブルに登録します。ただし、複数の動的クエリをマルチステートメントで実行する場合には対応していません。</dd>
568568 </dl>
569569 </dd>
570-<dt><h3>FROM句にVALUES式を使っている問い合わせ</h3></dt>
570+<dt>FROM句にVALUES式を使っている問い合わせ</dt>
571571 <dd>FROM句にVALUES式を使っている場合は、ヒント句のオブジェクト名に「*VALUES*」を指定することでヒントを与えることができる場合があります。 ただし複数のVALUESを使っている場合は内部的には区別がつかないためヒントを与えることはできません。
572572 <pre>
573573 postgres=# /*+ <span class="strong">MergeJoin(a *VALUES*)</span> */
@@ -577,23 +577,23 @@ postgres-# JOIN (VALUES (1,1),(2,2)) <span class="strong">v</span> (vid, vbal
577577 postgres-# ORDER BY a.aid;
578578 QUERY PLAN
579579 ---------------------------------------------------------------------------------------------------------------
580- <b><u>Merge Join</u></b> (cost=0.04..4497.33 rows=2 width=105)
580+ <span class="strong">Merge Join</span> (cost=0.04..4497.33 rows=2 width=105)
581581 Merge Cond: (a.aid = "*VALUES*".column1)
582582 -> Index Scan using pgbench_accounts_pkey on pgbench_accounts a (cost=0.00..4247.26 rows=100000 width=97)
583583 -> Sort (cost=0.04..0.04 rows=2 width=8)
584584 Sort Key: "*VALUES*".column1
585- -> Values Scan on <b><u>"*VALUES*"</u></b> (cost=0.00..0.03 rows=2 width=8)
585+ -> Values Scan on <span class="strong">"*VALUES*"</span> (cost=0.00..0.03 rows=2 width=8)
586586 postgres=#
587587 </pre>
588588 </dd>
589589 </dl>
590590
591-<dt><h3>副問い合わせ結果</h3></dt>
591+<dt>副問い合わせ結果</dt>
592592 <dd>以下のような形式の副問い合わせでは外側の文への併合が行われず「ANY_subquery」という名前の独立した副問合せとして残される場合があります。このような副問合せが一つしかない場合は ANY_subquery という名前でこの副問合せを特定することができます。
593593 <ul>
594-<li>IN (SELECT ... { <b>LIMIT | OFFSET 等</b>} ... )</li>
595-<li>ANY (SELECT ... { <b>LIMIT | OFFSET 等</b>} ...)</li>
596-<li>SOME (SELECT ... { <b>LIMIT | OFFSET 等</b>} ...)</li>
594+<li>IN (SELECT ... { <span class="strong">LIMIT | OFFSET 等</span>} ... )</li>
595+<li>ANY (SELECT ... { <span class="strong">LIMIT | OFFSET 等</span>} ...)</li>
596+<li>SOME (SELECT ... { <span class="strong">LIMIT | OFFSET 等</span>} ...)</li>
597597 </ul>
598598 以下の例では、そのことを利用して Hash Joinを強制しています。
599599 <pre>
@@ -615,19 +615,19 @@ postgres=# WHERE aid IN (SELECT bid FROM pgbench_accounts a2 LIMIT 10);
615615 postgres=#
616616 </pre>
617617
618-<dt><h3>IndexOnlyScanヒント句</h3></dt>
619-<dd>ヒント句の対象となるテーブルにIndex Only Scanが可能なインデックスとIndex Only Scanが不可能なインデックスが同時に存在する場合、Index Only Scanが可能なインデックスをテーブルに対してIndexOnlyScanヒント句を追加で指定しないとIndex Scanが選択されることがあります。</dd>
618+<dt>IndexOnlyScanヒント句</dt>
619+<dd>IndexOnlyScanヒントで指定されているインデックスで index only scan が実行できない場合は、index scan を他のインデックスで実行する可能性があります。</dd>
620620
621-<dt><h3>NoIndexScanヒントの挙動について</h3></dt>
621+<dt>NoIndexScanヒントの挙動について</dt>
622622 <dd>NoIndexScanヒント句を指定した場合は、Index ScanだけでなくIndex Only Scanも選択されません。</dd>
623623 </dl>
624624
625-<dt><h3>UNION に対する並列実行ヒント</h3></dt>
625+<dt>UNION に対する並列実行ヒント</dt>
626626 <dd>UNIONは直下のサブクエリが全て並列実行可能な場合にだけ並列実行を行います。一方ですべてのサブクエリが並列実行可能な場合は、そのうちの一つで並列実行を強制するとコスト比較の結果UNION全体が並列実行されることになります。ただし並列実行ヒントによる並列実行の禁止を行った場合はそのスキャンは並列実行不可となります。
627627 </dd>
628628 </dl>
629629
630-<dt><h3>Set ヒントでの pg_hint_plan 自身の制御変数の設定</h3></dt>
630+<dt>Set ヒントでの pg_hint_plan 自身の制御変数の設定</dt>
631631 <dd>pg_hint_plan 自身の挙動を設定する変数を Set ヒントで変更した場合は期待通りに動作しない場合があります。</dd>
632632 <ul>
633633 <li>enable_hint, enable_hint_tables の設定ヒントはログ上は「使用済み」と出ますが、実際には無視されています。</li>
@@ -636,7 +636,7 @@ postgres=#
636636 </dd>
637637
638638 <h2>ヒントのパースエラーについて</h2>
639-<dt><h3>構文エラー</h3></dt>
639+<dt>構文エラー</dt>
640640 <dd>ヒント句の記述に構文上の誤りがあった場合、pg_hint_planは誤った記述より前のヒント句のみ有効とし、誤った記述以降のヒント句を無視してクエリを実行します。誤りの内容はpg_hint_plan.parse_messagesで指定したレベルでサーバログに記録されます。
641641 <ul>
642642 <li>ヒント句名を間違っている。</li>
@@ -644,22 +644,22 @@ postgres=#
644644 <li>オブジェクト名を空白で区切っていない。</li>
645645 </ul>
646646 </dd>
647-<dt><h3>オブジェクト指定エラー</h3></dt>
647+<dt>オブジェクト指定エラー</dt>
648648 <dd>pg_hint_planは、ヒント句対象のオブジェクト指定に誤りがあった場合、pg_hint_planは正常に解析できたヒントのみを適用して、それ以外を無視します。誤りの内容はpg_hint_plan.parse_messagesで指定したレベルでサーバログに記録されます。
649649 <ul>
650650 </dd>
651651
652-<dt><h3>重複したヒント</h3></dt>
652+<dt>重複したヒント</dt>
653653 <dd>同じオブジェクトに対して同じグループのヒント句を重複して指定した場合は、各グループで最後に指定したヒント句を使用します。</dd>
654-<dt><h3>ネストしたブロックコメント</h3></dt>
654+<dt>ネストしたブロックコメント</dt>
655655 <dd>pg_hint_planでは、ヒントを指定したブロックコメントにネストしたブロックコメントを含めることができません。ネストしたブロックコメントを含めた場合は、誤った記述に関する情報を出力しますがエラー終了しません。ヒントを無視してクエリを実行します。</dd>
656-<dt><h3>メッセージの出力レベル</h3></dt>
656+<dt>メッセージの出力レベル</dt>
657657 <dd>ヒントに誤りがあった場合に出力されるメッセージのレベルは、基本的にはpg_hint_plan.parse_messagesに指定したレベルです。ただし、ヒント句に指定したオブジェクトの長さが識別子の最大長(デフォルトでは63バイト)を超えた際に切り詰めた場合は、NOTICEで出力します。</dd>
658658
659659 <h2>注意事項</h2>
660-<dt><h3>プランナパラメータの影響</h3></dt>
660+<dt>プランナパラメータの影響</dt>
661661 <dd>FROM句の要素数が from_collapse_limit 以上または join_collapse_limit を超える場合には、結合順序のヒント句は正しく動作しません。また、FROM句の要素数が geqo_threshold 以上の場合は、結合順序のヒント句、および結合方式のヒント句は動作しません。ヒント句が使われるようにするには、これらのGUCパラメータの値を十分に大きくしてください。</dd>
662-<dt><h3>適用不能なヒント</h3></dt>
662+<dt>実行不能なプランを指定するヒント</dt>
663663 <dd>ヒントで指定した結果正しく実行できない実行計画が生成される場合は、実行可能なプランに強制的に修正します。実行不能な実行計画例を以下に示します。
664664 <ul>
665665 <li>特殊な場合を除いた FULL OUTER JOINに対する Nested Loop。</li>
@@ -667,9 +667,9 @@ postgres=#
667667 <li>検索条件にctidを指定しない場合の Tid Scan。</li>
668668 </ul>
669669 </dd>
670-<dt><h3>ECPGにおける制限</h3></dt>
670+<dt>ECPGにおける制限</dt>
671671 <dd>ECPGで実装したアプリケーションから発行するクエリにヒントをコメントで指定した場合、実行計画を制御できません。これは、CプリプロセッサがCコードに変換するタイミングで、全てのブロックコメントを取り除いてしまうためです。ただし、EXECUTEコマンドで実行する動的SQLに含まれるコメントは使用可能です。</dd>
672-<dt><h3>異なるヒントを与えた同一クエリの pg_stat_statements での扱い</h3></dt>
672+<dt>異なるヒントを与えた同一クエリの pg_stat_statements での扱い</dt>
673673 <dd>pg_stat_statements ではクエリIDの生成の際にコメントは無視されます。そのため与えているヒントが異なる同一のクエリは一つのクエリとして集計されます。</dd>
674674
675675 </dl>
--- a/doc/pg_hint_plan.html
+++ b/doc/pg_hint_plan.html
@@ -57,8 +57,8 @@ pre { margin: 0 2em 0 2em; padding:0.3em; border-style: solid; border-width:0.1e
5757 <p>In the example below , hash join is selected as the joning method and scanning pgbench_accounts by sequential scan method.</p>
5858 <pre>
5959 postgres=# /*+
60-postgres*# <b><u>HashJoin(a b)</u></b>
61-postgres*# <b><u>>SeqScan(a)</u></b>
60+postgres*# <span class="strong">HashJoin(a b)</span>
61+postgres*# <span class="strong">SeqScan(a)</span>
6262 postgres*# */
6363 postgres-# EXPLAIN SELECT *
6464 postgres-# FROM pgbench_branches b
@@ -68,20 +68,19 @@ postgres-# ORDER BY a.aid;
6868 ---------------------------------------------------------------------------------------
6969 Sort (cost=31465.84..31715.84 rows=100000 width=197)
7070 Sort Key: a.aid
71- -> <b><u>Hash Join</u></b> (cost=1.02..4016.02 rows=100000 width=197)
71+ -> <span class="strong">Hash Join</span> (cost=1.02..4016.02 rows=100000 width=197)
7272 Hash Cond: (a.bid = b.bid)
73- -> <b><u>Seq Scan on pgbench_accounts a</u></b> (cost=0.00..2640.00 rows=100000 width=97)
73+ -> <span class="strong">Seq Scan on pgbench_accounts a</span> (cost=0.00..2640.00 rows=100000 width=97)
7474 -> Hash (cost=1.01..1.01 rows=1 width=100)
7575 -> Seq Scan on pgbench_branches b (cost=0.00..1.01 rows=1 width=100)
7676 (7 rows)
7777
7878 postgres=# </pre>
7979
80-<h2 id="examples">Hint table</h2>
81-<p> The above section mentioned that
82-hints are placed in a comment with special form. This way of hinting
83-is inconvenient for certain cases where queries cannot be edited. For
84-such cases, hints can be placed in a special table named
80+<h2 id="examples">The hint table</h2>
81+<p> Hints are described in a comment in a special form in the above
82+section. This is inconvenient in the case where queries cannot be
83+edited. In the case hints can be placed in a special table named
8584 "hint_plan.hints". The table consists of the following columns.</p>
8685 <table>
8786 <thead>
@@ -102,23 +101,23 @@ such cases, hints can be placed in a special table named
102101
103102 <p>The following example shows how to operate with the hint table.</p>
104103 <pre>
105-<b>postgres=#</b> INSERT INTO hint_plan.hints(norm_query_string, application_name, hints)
106-<b>postgres-#</b> VALUES (
107-<b>postgres(#</b> 'EXPLAIN (COSTS false) SELECT * FROM t1 WHERE t1.id = ?;',
108-<b>postgres(#</b> '',
109-<b>postgres(#</b> 'SeqScan(t1)'
110-<b>postgres(#</b> );
104+<span class="strong">postgres=#</span> INSERT INTO hint_plan.hints(norm_query_string, application_name, hints)
105+<span class="strong">postgres-#</span> VALUES (
106+<span class="strong">postgres(#</span> 'EXPLAIN (COSTS false) SELECT * FROM t1 WHERE t1.id = ?;',
107+<span class="strong">postgres(#</span> '',
108+<span class="strong">postgres(#</span> 'SeqScan(t1)'
109+<span class="strong">postgres(#</span> );
111110 INSERT 0 1
112-<b>postgres=#</b> UPDATE hint_plan.hints
113-<b>postgres-#</b> SET hints = 'IndexScan(t1)'
114-<b>postgres-#</b> WHERE id = 1;
111+<span class="strong">postgres=#</span> UPDATE hint_plan.hints
112+<span class="strong">postgres-#</span> SET hints = 'IndexScan(t1)'
113+<span class="strong">postgres-#</span> WHERE id = 1;
115114 UPDATE 1
116-<b>postgres=#</b> DELETE FROM hint_plan.hints
117-<b>postgres-#</b> WHERE id = 1;
115+<span class="strong">postgres=#</span> DELETE FROM hint_plan.hints
116+<span class="strong">postgres-#</span> WHERE id = 1;
118117 DELETE 1
119-<b>postgres=#</b>
118+<span class="strong">postgres=#</span>
120119 </pre>
121-<p>The hint tables is owned by the creator user and having the default previledges at the time of creation.
120+<p>The hint table is owned by the creator user and having the default previledges at the time of creation.
122121 during CREATE EXTENSION. Table hints are prioritized than comment hits.</p>
123122
124123 <h3 id="hint-group">The types of hints</h3>
@@ -128,11 +127,11 @@ during CREATE EXTENSION. Table hints are prioritized than comment hits.</p>
128127 <p>Scan method hints enforce specific scanning method on the target table. pg_hint_plan recognizes the target table by alias names if any. They are 'SeqScan' , 'IndexScan' and so on in this kind of hint.</p>
129128 <p>Scan hints are effective on ordinary tables, inheritance tables, UNLOGGED tables, temporary tables and system catalogs. External(foreign) tables, table functions, VALUES clause, CTEs, views and subquiries are not affected.</p>
130129 <pre>
131-<b>postgres=# /*+</b>
132-<b>postgres*# SeqScan(t1)</b>
133-<b>postgres*# IndexScan(t2 t2_pkey)</b>
134-<b>postgres*# */</b>
135-<b>postgres-#</b> SELECT * FROM table1 t1 JOIN table table2 t2 ON (t1.key = t2.key);
130+<span class="strong">postgres=# /*+</span>
131+<span class="strong">postgres*# SeqScan(t1)</span>
132+<span class="strong">postgres*# IndexScan(t2 t2_pkey)</span>
133+<span class="strong">postgres*# */</span>
134+<span class="strong">postgres-#</span> SELECT * FROM table1 t1 JOIN table table2 t2 ON (t1.key = t2.key);
136135 </pre>
137136
138137
@@ -144,24 +143,24 @@ during CREATE EXTENSION. Table hints are prioritized than comment hits.</p>
144143 <p> This hint "Leading" enforces the order of join on two or more tables. There are two ways of enforcing. One is enforcing specific order of joining but not restricting direction at each join level. Another enfoces join direction additionaly. Details are seen in the <a href="hint_list.html">hint list</a> table.</p>
145144
146145 <pre>
147-<b>postgres=# /*+</b>
148-<b>postgres*# NestLoop(t1 t2)</b>
149-<b>postgres*# MergeJoin(t1 t2 t3)</b>
150-<b>postgres*# Leading(t1 t2 t3)</b>
151-<b>postgres*# */</b>
152-<b>postgres-#</b> SELECT * FROM table1 t1
153-<b>postgres-#</b> JOIN table table2 t2 ON (t1.key = t2.key)
154-<b>postgres-#</b> JOIN table table3 t3 ON (t2.key = t3.key);
146+<span class="strong">postgres=# /*+</span>
147+<span class="strong">postgres*# NestLoop(t1 t2)</span>
148+<span class="strong">postgres*# MergeJoin(t1 t2 t3)</span>
149+<span class="strong">postgres*# Leading(t1 t2 t3)</span>
150+<span class="strong">postgres*# */</span>
151+<span class="strong">postgres-#</span> SELECT * FROM table1 t1
152+<span class="strong">postgres-#</span> JOIN table table2 t2 ON (t1.key = t2.key)
153+<span class="strong">postgres-#</span> JOIN table table3 t3 ON (t2.key = t3.key);
155154 </pre>
156155
157156 <h4>Hint for row number correction</h4>
158157 <p>This hint "Rows" corrects row number misestimation of joins that comes from restrictions of the planner. </p>
159158
160159 <pre>
161-<b>postgres=# /*+ Rows(a b #10) */</b> SELECT... ; Sets rows of join result to 10
162-<b>postgres=# /*+ Rows(a b +10) */</b> SELECT... ; Increments row number by 10
163-<b>postgres=# /*+ Rows(a b -10) */</b> SELECT... ; Subtracts 10 from the row number.
164-<b>postgres=# /*+ Rows(a b *10) */</b> SELECT... ; Makes the number 10 times larger.
160+<span class="strong">postgres=# /*+ Rows(a b #10) */</span> SELECT... ; Sets rows of join result to 10
161+<span class="strong">postgres=# /*+ Rows(a b +10) */</span> SELECT... ; Increments row number by 10
162+<span class="strong">postgres=# /*+ Rows(a b -10) */</span> SELECT... ; Subtracts 10 from the row number.
163+<span class="strong">postgres=# /*+ Rows(a b *10) */</span> SELECT... ; Makes the number 10 times larger.
165164 </pre>
166165
167166 <h4>Hint for parallel plan</h4>
@@ -170,27 +169,27 @@ scans. The third parameter specifies the strength of enfocement. "soft" means th
170169 tables and system catalogues. External tables, table functions, values clause, CTEs, views and subqueries are not affected. Internal tables of a view can be specified by its real name/alias as the target object. The following example shows that the query is enforced differently on each table.</p>
171170
172171 <pre>
173-<b>postgres=#</b> explain <b>/*+ Parallel(c1 3 hard) Parallel(c2 5 hard) */</b>
172+<span class="strong">postgres=#</span> explain <span class="strong">/*+ Parallel(c1 3 hard) Parallel(c2 5 hard) */</span>
174173 SELECT c2.a FROM c1 JOIN c2 ON (c1.a = c2.a);
175174 QUERY PLAN
176175 -------------------------------------------------------------------------------
177176 Hash Join (cost=2.86..11406.38 rows=101 width=4)
178177 Hash Cond: (c1.a = c2.a)
179178 -> Gather (cost=0.00..7652.13 rows=1000101 width=4)
180- <b><u>Workers Planned: 3</u></b>
181- -> Parallel Seq Scan on <b><u>c1</u></b> (cost=0.00..7652.13 rows=322613 width=4)
179+ <span class="strong">Workers Planned: 3</span>
180+ -> Parallel Seq Scan on <span class="strong">c1</span> (cost=0.00..7652.13 rows=322613 width=4)
182181 -> Hash (cost=1.59..1.59 rows=101 width=4)
183182 -> Gather (cost=0.00..1.59 rows=101 width=4)
184- <b><u>Workers Planned: 5</u></b>
185- -> Parallel Seq Scan on <b><u>c2</u></b> (cost=0.00..1.59 rows=59 width=4)
183+ <span class="strong">Workers Planned: 5</span>
184+ -> Parallel Seq Scan on <span class="strong">c2</span> (cost=0.00..1.59 rows=59 width=4)
186185
187-<b>postgres=#</b> EXPLAIN <b>/*+ Parallel(tl 5 hard) */</b> SELECT sum(a) FROM tl;
186+<span class="strong">postgres=#</span> EXPLAIN <span class="strong">/*+ Parallel(tl 5 hard) */</span> SELECT sum(a) FROM tl;
188187 QUERY PLAN
189188 -----------------------------------------------------------------------------------
190- <b><u>Finalize Aggregate</u></b> (cost=693.02..693.03 rows=1 width=8)
189+ <span class="strong">Finalize Aggregate</span> (cost=693.02..693.03 rows=1 width=8)
191190 -> Gather (cost=693.00..693.01 rows=5 width=8)
192- <b><u>Workers Planned: 5</u></b>
193- -> <b><u>Partial Aggregate</u></b> (cost=693.00..693.01 rows=1 width=8)
191+ <span class="strong">Workers Planned: 5</span>
192+ -> <span class="strong">Partial Aggregate</span> (cost=693.00..693.01 rows=1 width=8)
194193 -> Parallel Seq Scan on tl (cost=0.00..643.00 rows=20000 width=4)
195194 </pre>
196195 </dd>
@@ -202,7 +201,7 @@ tables and system catalogues. External tables, table functions, values clause, C
202201 <h4>GUC parameters temporarily setting</h4>
203202 <p>'Set' hint changes GUC parameters just while planning. GUC parameter shown in <a href="http://www.postgresql.org/docs/current/static/runtime-config-query.html">Query Planning</a> can have the expected effects on planning unless any other hint conflicts with the planner method configuration parameters. The last one among hints on the same GUC parameter makes effect. <a href="#hint-GUC">GUC parameters for pg_hint_plan</a> are also settable by this hint but it won't work as your expectation. See <a href="#restrictions">Restrictions</a> for details.</p>
204203 <pre>
205-postgres=# <b>/*+ Set(random_page_cost 2.0) */</b>
204+postgres=# <span class="strong">/*+ Set(random_page_cost 2.0) */</span>
206205 postgres-# SELECT * FROM table1 t1 WHERE key = 'value';
207206 ...
208207 </pre>
@@ -227,7 +226,6 @@ postgres-# SELECT * FROM table1 t1 WHERE key = 'value';
227226 <td>Specifies message level of debug print. Valid values are error, warning, notice, info, log, debug<n>.</td><td>INFO</td></tr>
228227 </tbody>
229228 </table>
230-
231229 <h2 id="install">Installation</h2>
232230 This section describes the installation steps.
233231 <h3 id="build">building binary module</h3>
@@ -260,26 +258,27 @@ $ su
260258 </pre>
261259
262260 <h2 id="hint_syntax">Details in hinting</h2>
263-<h3>Syntax and placement</h3>
261+<dl>
262+<dt>Syntax and placement</dt>
264263 <dd>pg_hint_plan reads hints from only the first block comment and any characters except alphabets, digits, spaces, underscores, commas and parentheses stops parsing immediately. In the following example HashJoin(a b) and SeqScan(a) are parsed as hints but IndexScan(a) and MergeJoin(a b) are not.
265264
266265 <pre>
267-<b>postgres=# /*+</b>
268-<b>postgres*# HashJoin(a b)</b>
269-<b>postgres*# SeqScan(a)</b>
270-<b>postgres*# */</b>
271-<b>postgres-# /*+ IndexScan(a) */</b>
272-<b>postgres-#</b> EXPLAIN SELECT <b>/*+ MergeJoin(a b) */</b> *
273-<b>postgres-#</b> FROM pgbench_branches b
274-<b>postgres-#</b> JOIN pgbench_accounts a ON b.bid = a.bid
275-<b>postgres-#</b> ORDER BY a.aid;
266+<span class="strong">postgres=# /*+</span>
267+<span class="strong">postgres*# HashJoin(a b)</span>
268+<span class="strong">postgres*# SeqScan(a)</span>
269+<span class="strong">postgres*# */</span>
270+<span class="strong">postgres-# /*+ IndexScan(a) */</span>
271+<span class="strong">postgres-#</span> EXPLAIN SELECT <span class="strong">/*+ MergeJoin(a b) */</span> *
272+<span class="strong">postgres-#</span> FROM pgbench_branches b
273+<span class="strong">postgres-#</span> JOIN pgbench_accounts a ON b.bid = a.bid
274+<span class="strong">postgres-#</span> ORDER BY a.aid;
276275 QUERY PLAN
277276 ---------------------------------------------------------------------------------------
278277 Sort (cost=31465.84..31715.84 rows=100000 width=197)
279278 Sort Key: a.aid
280- -> <b><u>Hash Join</u></b> (cost=1.02..4016.02 rows=100000 width=197)
279+ -> <span class="strong">Hash Join</span> (cost=1.02..4016.02 rows=100000 width=197)
281280 Hash Cond: (a.bid = b.bid)
282- -> <b><u>Seq Scan on pgbench_accounts a</u></b> (cost=0.00..2640.00 rows=100000 width=97)
281+ -> <span class="strong">Seq Scan on pgbench_accounts a</span> (cost=0.00..2640.00 rows=100000 width=97)
283282 -> Hash (cost=1.01..1.01 rows=1 width=100)
284283 -> Seq Scan on pgbench_branches b (cost=0.00..1.01 rows=1 width=100)
285284 (7 rows)
@@ -287,7 +286,7 @@ $ su
287286 postgres=# </pre>
288287 </dd>
289288
290-<h3>Using with PL/pgSQL</h3>
289+<dt>Using with PL/pgSQL</dt>
291290 <dd>pg_hint_plan works for queries in PL/pgSQL scripts with some restrictions.
292291 <ul>
293292 <li>Hints affect only on the following kind of queires.
@@ -309,9 +308,9 @@ postgres$# DECLARE
309308 postgres$# id integer;
310309 postgres$# cnt integer;
311310 postgres$# BEGIN
312-postgres$# SELECT <b><u>/*+ NoIndexScan(a) */</u></b> aid
311+postgres$# SELECT <span class="strong">/*+ NoIndexScan(a) */</span> aid
313312 postgres$# INTO id FROM pgbench_accounts a WHERE aid = $1;
314-postgres$# SELECT <b><u>/*+ SeqScan(a) */</u></b> count(*)
313+postgres$# SELECT <span class="strong">/*+ SeqScan(a) */</span> count(*)
315314 postgres$# INTO cnt FROM pgbench_accounts a;
316315 postgres$# RETURN id + cnt;
317316 postgres$# END;
@@ -319,11 +318,11 @@ postgres$# $$ LANGUAGE plpgsql;
319318 </pre>
320319 </dd>
321320
322-<h3>Letter case in a hinted object</h3>
321+<dt>Letter case in the object names</dt>
323322 <dd>Unlike the way PostgreSQL handles object names, pg_hint_plan compares bare object names in hints against the database internal object names in case sensitive way. Therefore an object name TBL in a hint matches only "TBL" in database and does not match any unquoted names like TBL, tbl or Tbl.
324323 </dd>
325324
326-<h3>Escaping special chacaters in object names</h3>
325+<dt>Escaping special chacaters in object names</dt>
327326 <dd>The objects as the hint parameter should be enclosed by double quotes if they includes parentheses, double quotes and white spaces. The escaping rule is the same as PostgreSQL.
328327 </dd>
329328
@@ -332,15 +331,15 @@ postgres$# $$ LANGUAGE plpgsql;
332331 exists. This behavior is usable to point a specific occurance
333332 among multiple occurances of one table.
334333 <pre>
335-<b>postgres=# /*+ HashJoin(t1 t1) */</b>
336-<b>postgres-#</b> EXPLAIN SELECT * FROM s1.t1
337-<b>postgres-#</b> JOIN public.t1 ON (s1.t1.id=public.t1.id);
334+<span class="strong">postgres=# /*+ HashJoin(t1 t1) */</span>
335+<span class="strong">postgres-#</span> EXPLAIN SELECT * FROM s1.t1
336+<span class="strong">postgres-#</span> JOIN public.t1 ON (s1.t1.id=public.t1.id);
338337 INFO: hint syntax error at or near "HashJoin(t1 t1)"
339-<b><u>DETAIL: Relation name "t1" is ambiguous.</u></b>
338+<span class="strong">DETAIL: Relation name "t1" is ambiguous.</span>
340339 ...
341-<b>postgres=# /*+ HashJoin(pt st) */</b>
342-<b>postgres-#</b> EXPLAIN SELECT * FROM s1.t1 st
343-<b>postgres-#</b> JOIN public.t1 pt ON (st.id=pt.id);
340+<span class="strong">postgres=# /*+ HashJoin(pt st) */</span>
341+<span class="strong">postgres-#</span> EXPLAIN SELECT * FROM s1.t1 st
342+<span class="strong">postgres-#</span> JOIN public.t1 pt ON (st.id=pt.id);
344343 QUERY PLAN
345344 ---------------------------------------------------------------------
346345 <span class="strong">Hash Join</span> (cost=64.00..1112.00 rows=28800 width=8)
@@ -351,14 +350,14 @@ INFO: hint syntax error at or near "HashJoin(t1 t1)"
351350 </pre>
352351 </dd>
353352
354-<h3>Underlying tables of views or rules</h3>
353+<dt>Underlying tables of views or rules</dt>
355354 <dd>Hints are not applicable on views itself, but they can affect the
356355 queries within if the object names match the object names in the
357356 expanded query on the view. Assigning aliases to the tables in a view
358357 enables them to be manipulated from outside the view.
359358 <pre>
360-<b>postgres=#</b> CREATE VIEW v1 AS SELECT * FROM <b><u>t2</u></b>;
361-<b>postgres=#</b> EXPLAIN <b>/*+ HashJoin(t1 v1) */</b>
359+<span class="strong">postgres=#</span> CREATE VIEW v1 AS SELECT * FROM <span class="strong">t2</span>;
360+<span class="strong">postgres=#</span> EXPLAIN <span class="strong">/*+ HashJoin(t1 v1) */</span>
362361 SELECT * FROM t1 JOIN v1 ON (c1.a = v1.a);
363362 QUERY PLAN
364363 ------------------------------------------------------------------
@@ -370,27 +369,27 @@ enables them to be manipulated from outside the view.
370369 </pre>
371370 </dd>
372371
373-<h3>Inheritance tables</h3>
372+<dt>Inheritance tables</dt>
374373 <dd>Hints can point only the parent of an inheritance tables and the
375374 hint affect all the inheritance. Hints simultaneously point directly
376375 to children are not in effect.
377376 </dd>
378377
379-<h3>Hinting on multistatements</h3>
378+<dt>Hinting on multistatements</dt>
380379 <dd>One multistatement can have exactly one hint comment and the hints affects all of the individual statement in the multistatement. Notice that the seemingly multistatement on the interactive interface of psql is internally a sequence of single statements so hints affects only on the statement just following.</dd>
381380
382-<h3>VALUES expressions</h3>
381+<dt>VALUES expressions</dt>
383382 <dd>VALUES expressions in FROM clause are named as *VALUES* internally
384383 so it is hintable if it is the only VALUES in a query. Two or more
385384 VALUES expressions in a query seems distinguishable looking its
386385 explain result. But in reality it is mere a cosmetic and they are not
387386 distinguisable.
388387 <pre>
389-<b>postgres=# /*+ MergeJoin(*VALUES*_1 *VALUES*) */</b>
388+<span class="strong">postgres=#</span> <span class="strong">/*+ MergeJoin(*VALUES*_1 *VALUES*) */</span>
390389 EXPLAIN SELECT * FROM (VALUES (1, 1), (2, 2)) v (a, b)
391390 JOIN (VALUES (1, 5), (2, 8), (3, 4)) w (a, c) ON v.a = w.a;
392391 INFO: pg_hint_plan: hint syntax error at or near "MergeJoin(*VALUES*_1 *VALUES*) "
393-<b><u>DETAIL: Relation name "*VALUES*" is ambiguous.</u></b>
392+<span class="strong">DETAIL: Relation name "*VALUES*" is ambiguous.</span>
394393 QUERY PLAN
395394 -------------------------------------------------------------------------
396395 Hash Join (cost=0.05..0.12 rows=2 width=16)
@@ -406,20 +405,20 @@ INFO: pg_hint_plan: hint syntax error at or near "MergeJoin(*VALUES*_1 *VALUES*
406405 <p>Subqueries in the following context occasionally can be hinted using the
407406 name "ANY_subquery".</p>
408407 <pre>
409-IN (SELECT ... {<b>LIMIT | OFFSET</b> ...} ...)
410-= ANY (SELECT ... {<b>LIMIT | OFFSET</b> ...} ...)
411-= SOME (SELECT ... {<b>LIMIT | OFFSET</b> ...} ...)
408+IN (SELECT ... {<span class="strong">LIMIT | OFFSET</span> ...} ...)
409+= ANY (SELECT ... {<span class="strong">LIMIT | OFFSET</span> ...} ...)
410+= SOME (SELECT ... {<span class="strong">LIMIT | OFFSET</span> ...} ...)
412411 </pre>
413412 <p>For these syntaxes, planner internally assigns the name to the subquery when planning joins on tables including it, so join hints are applicable on such joins using the implicit name as the following.</p>
414413 <pre>
415-<b>postgres=# /*+HashJoin(a1 ANY_subquery)*/</b>
416-<b>postgres=#</b> EXPLAIN SELECT *
417-<b>postgres=#</b> FROM pgbench_accounts a1
418-<b>postgres=#</b> WHERE aid IN (SELECT bid FROM pgbench_accounts a2 LIMIT 10);
414+<span class="strong">postgres=# /*+HashJoin(a1 ANY_subquery)*/</span>
415+<span class="strong">postgres=#</span> EXPLAIN SELECT *
416+<span class="strong">postgres=#</span> FROM pgbench_accounts a1
417+<span class="strong">postgres=#</span> WHERE aid IN (SELECT bid FROM pgbench_accounts a2 LIMIT 10);
419418 QUERY PLAN
420419
421420 ---------------------------------------------------------------------------------------------
422- <b><u>Hash Semi Join</u></b> (cost=0.49..2903.00 rows=1 width=97)
421+ <span class="strong">Hash Semi Join</span> (cost=0.49..2903.00 rows=1 width=97)
423422 Hash Cond: (a1.aid = a2.bid)
424423 -> Seq Scan on pgbench_accounts a1 (cost=0.00..2640.00 rows=100000 width=97)
425424 -> Hash (cost=0.36..0.36 rows=10 width=4)
@@ -428,58 +427,60 @@ IN (SELECT ... {<b>LIMIT | OFFSET</b> ...} ...)
428427 </pre>
429428 </dd>
430429
431-<h3>Using IndexOnlyScan hint</h3>
432-<dd>An additional hint to enforce an index that can perform index only scan is required for IndexOnlyScan hint to work when any index that can not perform index only scan is also defined on the same table. </dd>
430+<dt>Using IndexOnlyScan hint</dt>
431+<dd>Index scan may unexpectedly performed on another index when the index specifed in IndexOnlyScan hint cannot perform index only scan.</dd>
433432
434-<h3>Behavior of NoIndexScan</h3>
433+<dt>Behavior of NoIndexScan</dt>
435434 <dd>NoIndexScan hint involes NoIndexOnlyScan.</dd>
436435
437-<h3>Parallel hint and UNION</h3>
436+<dt>Parallel hint and UNION</dt>
438437 <dd>A UNION can run in parallel only when all underlying subqueries
439438 are parallel-safe. Conversely enforcing parallel on any of
440439 the subqueries let a parallel-executable UNION run in
441440 parallel. Meanwhile, a parallel hint with zero workers hinhibits a scan
442441 from executed in parallel.</dd>
443442
444-<h3>Setting pg_hint_plan parameters by Set hints</h3>
443+<dt>Setting pg_hint_plan parameters by Set hints</dt>
445444 <dd><p>pg_hint_plan paramters change the behavior of itself so some parameters doesn't work as expected.</p>
446445 <ul>
447446 <li>Hints to change enable_hint, enable_hint_tables are ignored even though they are reported as "used hints" in debug logs.</li>
448447 <li>Setting debug_print and message_level works from midst of the processing of the target query.</li>
449448 </ul>
450449 </dd>
451-
450+</dl>
452451
453452 <h2 id="errors">Errors</h2>
454453 <p>pg_hint_plan stops parsing on any error and uses hints already parsed on the most cases. Followings are the typical errors.</p>
455-<h3>Syntax errors </h3>
456-<p>Any syntactical errors or wrong hint names are reported as an syntax error. These errors are reported in the server log with the message level which specified by pg_hint_plan.message_level if pg_hint_plan.debug_print is on and aboves.</p>
457-<h3>Object misspecifications</h3>
458-<p>Object misspecifications results silent ingorance of the hints. This kind of error is reported as "not used hints" in the server log by the same condtion to syntax errors.</p>
454+<dl>
455+<dt>Syntax errors </dt>
456+<dd>Any syntactical errors or wrong hint names are reported as an syntax error. These errors are reported in the server log with the message level which specified by pg_hint_plan.message_level if pg_hint_plan.debug_print is on and aboves.</dd>
457+<dt>Object misspecifications</dt>
458+<dd>Object misspecifications results silent ingorance of the hints. This kind of error is reported as "not used hints" in the server log by the same condtion to syntax errors.</dd>
459459
460-<h3>Redundant or conflicting hints</h3>
461-<p>The last hint will be active when redundant hints or hints conflicting with each other. This kind of error is reported as "duplication hints" in the server log by the same condition to syntax errors.</p>
460+<dt>Redundant or conflicting hints</dt>
461+<dd>The last hint will be active when redundant hints or hints conflicting with each other. This kind of error is reported as "duplication hints" in the server log by the same condition to syntax errors.</dd>
462462
463-<h3>Nested comments</h3>
464-<p>Hint comment cannot include another block comment within. If pg_hint_plan finds it, differently from other erros, it stops parsing and abandans all hints already parsed. This kind of error is reported in the same manner as other errors. </p>
463+<dt>Nested comments</dt>
464+<dd>Hint comment cannot include another block comment within. If pg_hint_plan finds it, differently from other erros, it stops parsing and abandans all hints already parsed. This kind of error is reported in the same manner as other errors. </dd>
465465
466466 <h2 id="func_limits">Functional limitations</h2>
467-<h3>Influences of some of planner GUC parameters</h3>
468-<p>The planner does not try to consider joining order for FROM clause entries more than from_collapse_limit. pg_hint_plan cannot affect joining order as expected for the case.</p>
467+<dt>Influences of some of planner GUC parameters</dt>
468+<dd>The planner does not try to consider joining order for FROM clause entries more than from_collapse_limit. pg_hint_plan cannot affect joining order as expected for the case.</dd>
469469
470-<h3>Cases that pg_hint_plan essentially does not work </h3>
471-<p>By the nature of pg_hint_plan, it cannot affect some cases that out of scope of the planner like following.</p>
470+<dt>Hints trying to enforce unexecutable plans </dt>
471+<dd>Planner chooses any executable plans when the enforced plan cannot be executed.
472472 <ul>
473473 <li>FULL OUTER JOIN to use nested loop</li>
474474 <li>To use indexes that does not have columns used in quals</li>
475475 <li>To do TID scans for queries without ctid conditions</li>
476476 </ul>
477+</dd>
477478
478-<h3>Queries in ECPG</h3>
479-<p>ECPG removes comments in queries written as embedded SQLs so hints cannot be passed form those queries. The only exception is that EXECUTE command passes given string unmodifed. Please consider hint tables for this case.</p>
479+<dt>Queries in ECPG</dt>
480+<dd>ECPG removes comments in queries written as embedded SQLs so hints cannot be passed form those queries. The only exception is that EXECUTE command passes given string unmodifed. Please consider hint tables in the case.</dd>
480481
481-<h3>Work with pg_stat_statements</h3>
482-<p>pg_stat_statements generates a query id ignoring comments. As the result the identical queires with different hints are summerized as the same query.</p>
482+<dt>Work with pg_stat_statements</dt>
483+<dd>pg_stat_statements generates a query id ignoring comments. As the result the identical queires with different hints are summerized as the same query.</dd>
483484
484485 <h2 id="requirement">Requirements</h2>
485486 pg_hint_plan11 1.3 requires PostgreSQL 11.
--- a/doc/style.css
+++ b/doc/style.css
@@ -54,6 +54,15 @@ th, td {
5454 padding: 0.2em;
5555 }
5656
57+dt {
58+ font-weight: 600;
59+ margin-top: 1em;
60+ margin-left: 1em;
61+}
62+dd {
63+ margin-top: 0.5em;
64+}
65+
5766 thead th {
5867 background: #f2f2f2;
5968 text-align: center;
旧リポジトリブラウザで表示