doc/hint_list.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>Appendix A. Hints list</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.4 Appendices</h1>
  14 <div class="navigation">
  15   <a href="pg_hint_plan.html">pg_hint_plan</a> &gt;
  16   <a href="hint_list.html">Appendix A. Hints list</a>
  17 </div>
  18 <hr>
  19
  20 <h2 id="hint-list">Appendix A. Hints list</h2>
  21 <p>The available hints are listed below.</p>
  22 <table>
  23 <thead>
  24 <tr>
  25 <tr><th>Group</th><th>Format</th><th>Description</th></tr>
  26 </tr>
  27 </thead>
  28 <tbody>
  29 <tr><td rowspan="11" nowrap>Scan method</td>
  30   <td nowrap>SeqScan(table)</td>
  31   <td>Forces sequential scan on the table</td></tr>
  32 <tr><td>TidScan(table)</td>
  33   <td>Forces TID scan on the table.</td></tr>
  34 <tr><td nowrap>IndexScan(table[ index...])</td>
  35   <td>Forces index scan on the table. Restricts to specified indexes if any. </td></tr>
  36 <tr><td nowrap>IndexOnlyScan(table[ index...])</td>
  37   <td>Forces index only scan on the table. Rstricts to specfied indexes if any. Index scan may be used if index only scan is not available. Available for PostgreSQL 9.2 and later.</td></tr>
  38 <tr><td nowrap>BitmapScan(table[ index...])</td>
  39   <td>Forces bitmap scan on the table. Restoricts to specfied indexes if any.</td></tr>
  40 <tr><td nowrap>IndexScanRegexp(table[ POSIX Regexp...])</br>IndexOnlyScanRegexp(table[ POSIX Regexp...])</br>BitmapScanRegexp(table[ POSIX Regexp...])</td>
  41   <td>Forces index scan or index only scan (For PostgreSQL 9.2 and later) or bitmap scan on the table. Restricts to indexes that matches the specified <a href="https://www.postgresql.org/docs/11/functions-matching.html#FUNCTIONS-POSIX-REGEXP">POSIX regular expression</a> pattern</td></tr>
  42 <tr><td nowrap>NoSeqScan(table)</td>
  43   <td>Forces not to do sequential scan on the table.</td></tr>
  44 <tr><td nowrap>NoTidScan(table)</td>
  45   <td>Forces not to do TID scan on the table. </td></tr>
  46 <tr><td nowrap>NoIndexScan(table)</td>
  47   <td>Forces not to do index scan and index only scan (For PostgreSQL
  48   9.2 and later) on the table. </td></tr>
  49 <tr><td nowrap>NoIndexOnlyScan(table)</td>
  50   <td>Forces not to do index only scan on the table. Available for PostgreSQL 9.2 and later.</td></tr>
  51 <tr><td nowrap>NoBitmapScan(table)</td>
  52   <td>Forces not to do bitmap scan on the table. </td></tr>
  53
  54 <tr><td rowspan="6" nowrap>Join method</td>
  55   <td nowrap>NestLoop(table table[ table...])</td>
  56   <td>Forces nested loop for the joins consist of the specifiled tables.</td></tr>
  57 <tr><td nowrap>HashJoin(table table[ table...])</td>
  58   <td>Forces hash join for the joins consist of the  specifiled tables.</td></tr>
  59 <tr><td nowrap>MergeJoin(table table[ table...])</td>
  60   <td>Forces merge join for the joins consist of the specifiled tables.</td></tr>
  61 <tr><td nowrap>NoNestLoop(table table[ table...])</td>
  62   <td>Forces not to do nested loop for the joins consist of the specifiled tables.</td></tr>
  63 <tr><td nowrap>NoHashJoin(table table[ table...])</td>
  64   <td>Forces not to do hash join for the joins consist of the specifiled tables.</td></tr>
  65 <tr><td nowrap>NoMergeJoin(table table[ table...])</td>
  66   <td>Forces not to do merge join for the joins consist of the  specifiled tables.</td></tr>
  67
  68 <tr><td rowspan="2">Join order</td>
  69   <td nowrap>Leading(table table[ table...])</td>
  70   <td>Forces join order as specified.</td></tr>
  71 <tr><td nowrap>Leading(&lt;join pair&gt;)</td>
  72         <td>Forces join order and directions as specified. A join pair is a pair of tables and/or other join pairs enclosed by parentheses, which can make a nested structure.</td>
  73
  74 <tr><td rowspan="2">Behavior control on Join</td>
  75   <td nowrap>Memoize(table table[ table...])</td>
  76   <td nowrap>Allow the topmost join of a join among the specified tables to memoize the inner result. (Note that this doesn't enforce.)</td></tr>
  77 <tr><td nowrap>NoMemoize(table table[ table...])</td>
  78   <td nowrap>Inhibit the topmost join of a join among the specified tables from memoizing the inner result.</td>
  79 </tr>
  80
  81 <tr><td>Row number correction</td>
  82         <td nowrap>Rows(table table[ table...] correction)</td>
  83   <td>Corrects row number of a result of the joins consist of the specfied tables. The available correction methods are absolute (#&ltn&gt), addition (+&ltn&gt), subtract (-&ltn&gt) and multiplication (*&ltn&gt). &ltn&gt should be a string that strtod() can read.</td></tr>
  84 <tr><td>Parallel query configuration</td>
  85         <td nowrap>Parallel(table &lt# of workers&gt [soft|hard])</td>
  86   <td>Enforce or inhibit parallel execution of specfied table. &lt# of workers&gt is the desired number of parallel workers, where zero means inhibiting parallel execution. If the third parameter is soft (default), it just changes max_parallel_workers_per_gather and leave everything else to planner. Hard means enforcing the specified number of workers.</td>
  87 <tr><td>GUC</td>
  88   <td nowrap>Set(GUC-param value)</td>
  89   <td>Set the GUC parameter to the value while planner is running.</td></tr>
  90 </tbody>
  91 </table></p>
  92
  93
  94 <hr>
  95 <div class="navigation">
  96   <a href="pg_hint_plan.html">pg_hint_plan</a> &gt;
  97   <a href="hint_list.html">Appendix A. hints list</a>
  98 </div>
  99
 100 <p class="footer">Copyright (c) 2012-2021, NIPPON TELEGRAPH AND TELEPHONE CORPORATION</p>
 101 </body>
 102 </html>