From: Kyotaro Horiguchi Date: Wed, 19 Jan 2022 01:37:00 +0000 (+0900) Subject: Fix many typos in doc X-Git-Tag: REL14_1_4_0~3 X-Git-Url: http://git.osdn.net/view?a=commitdiff_plain;h=e771aa671adc23577b8d9ef1eb797bad03e3b307;p=pghintplan%2Fpg_hint_plan.git Fix many typos in doc Many misspellings were left alone in the documentation. Rechecked the whole documentation and fixed the misspellings. Reported-by: qianglingjie <86580516+qianglingjie@users.noreply.github.com> --- diff --git a/doc/hint_list.html b/doc/hint_list.html index 62e295e..045e8ea 100755 --- a/doc/hint_list.html +++ b/doc/hint_list.html @@ -34,9 +34,9 @@ IndexScan(table[ index...]) Forces index scan on the table. Restricts to specified indexes if any. IndexOnlyScan(table[ index...]) - 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. + Forces index only scan on the table. Restricts to specified indexes if any. Index scan may be used if index only scan is not available. Available for PostgreSQL 9.2 and later. BitmapScan(table[ index...]) - Forces bitmap scan on the table. Restoricts to specfied indexes if any. + Forces bitmap scan on the table. Restricts to specified indexes if any. IndexScanRegexp(table[ POSIX Regexp...])
IndexOnlyScanRegexp(table[ POSIX Regexp...])
BitmapScanRegexp(table[ POSIX Regexp...]) 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 POSIX regular expression pattern NoSeqScan(table) @@ -53,17 +53,17 @@ Join method NestLoop(table table[ table...]) - Forces nested loop for the joins consist of the specifiled tables. + Forces nested loop for the joins consist of the specified tables. HashJoin(table table[ table...]) - Forces hash join for the joins consist of the specifiled tables. + Forces hash join for the joins consist of the specified tables. MergeJoin(table table[ table...]) - Forces merge join for the joins consist of the specifiled tables. + Forces merge join for the joins consist of the specified tables. NoNestLoop(table table[ table...]) - Forces not to do nested loop for the joins consist of the specifiled tables. + Forces not to do nested loop for the joins consist of the specified tables. NoHashJoin(table table[ table...]) - Forces not to do hash join for the joins consist of the specifiled tables. + Forces not to do hash join for the joins consist of the specified tables. NoMergeJoin(table table[ table...]) - Forces not to do merge join for the joins consist of the specifiled tables. + Forces not to do merge join for the joins consist of the specified tables. Join order Leading(table table[ table...]) @@ -80,10 +80,10 @@ Row number correction Rows(table table[ table...] correction) - Corrects row number of a result of the joins consist of the specfied tables. The available correction methods are absolute (#<n>), addition (+<n>), subtract (-<n>) and multiplication (*<n>). <n> should be a string that strtod() can read. + Corrects row number of a result of the joins consist of the specified tables. The available correction methods are absolute (#<n>), addition (+<n>), subtract (-<n>) and multiplication (*<n>). <n> should be a string that strtod() can read. Parallel query configuration Parallel(table <# of workers> [soft|hard]) - Enforce or inhibit parallel execution of specfied table. <# of workers> 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. + Enforce or inhibit parallel execution of specified table. <# of workers> 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. GUC Set(GUC-param value) Set the GUC parameter to the value while planner is running. diff --git a/doc/pg_hint_plan.html b/doc/pg_hint_plan.html index 9bcd10b..d795316 100755 --- a/doc/pg_hint_plan.html +++ b/doc/pg_hint_plan.html @@ -121,7 +121,7 @@ DELETE 1

The hint table is owned by the creator user and having the default privileges at the time of creation during CREATE EXTENSION. Table hints are prioritized then comment hits.

The types of hints

-

Hinting phrases are classified into six types based on what kind of object and how they can affect planning. Scaning methods, join methods, joining order, row number correction, parallel query and GUC setting. You will see the lists of hint phrases of each type in Hint list.

+

Hinting phrases are classified into six types based on what kind of object and how they can affect planning. Scanning methods, join methods, joining order, row number correction, parallel query and GUC setting. You will see the lists of hint phrases of each type in Hint list.

Hints for scan methods

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.

@@ -223,7 +223,7 @@ postgres-# SELECT * FROM table1 t1 WHERE key = 'value';

GUC parameters for pg_hint_plan

-

GUC parameters below affect the behavior of pg_hint_planpg_hint_plan.

+

GUC parameters below affect the behavior of pg_hint_plan.

@@ -233,7 +233,7 @@ postgres-# SELECT * FROM table1 t1 WHERE key = 'value'; - + @@ -266,7 +266,7 @@ postgres=#

Do CREATE EXTENSION and SET pg_hint_plan.enable_hint_tables TO on if you are planning to hint tables.

-

Unistallation

+

Uninstallation

"make uninstall" in the top directory of source tree will uninstall the installed files if you installed from the source tree and it is left available. 

@@ -344,10 +344,10 @@ postgres$# $$ LANGUAGE plpgsql;
 
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.
 

 
-
Distinction between multiple occurences of a table

+
Distinction between multiple occurrences of a table

 
pg_hint_plan identifies the target object by using aliases if
-exists. This behavior is usable to point a specific occurence
-among multiple occurences of one table.
+exists. This behavior is usable to point a specific occurrence
+among multiple occurrences of one table.
 
 postgres=# /*+ HashJoin(t1 t1) */
 postgres-# EXPLAIN SELECT * FROM s1.t1
@@ -393,8 +393,8 @@ hint affect all the inheritance. Hints simultaneously point directly
 to children are not in effect.
 

 
-
Hinting on multistatements

-
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.

+
Hinting on multi-statements

+
One multi statement can have exactly one hint comment and the hints affects all of the individual statement in the multi statement. Notice that the seemingly multi statement on the interactive interface of psql is internally a sequence of single statements so hints affects only on the statement just following.

 
 
VALUES expressions

 
VALUES expressions in FROM clause are named as *VALUES* internally
@@ -471,9 +471,9 @@ from being executed in parallel.

 
pg_hint_plan stops parsing on any error and uses hints already parsed on the most cases. Followings are the typical errors.

 

 
Syntax errors 

-
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.

+
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 or above.

 
Object misspecifications

-
Object misspecifications results silent ingnorance of the hints. This kind of error is reported as "not used hints" in the server log by the same condition to syntax errors.

+
Object misspecifications results silent ignorance of the hints. This kind of error is reported as "not used hints" in the server log by the same condition to syntax errors.

 
 
Redundant or conflicting hints

 
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.

@@ -498,7 +498,7 @@ from being executed in parallel.
 
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 unmodified. Please consider hint tables in the case.

 
 
Work with pg_stat_statements

-
pg_stat_statements generates a query id ignoring comments. As the result the identical queires with different hints are summarized as the same query.

+
pg_stat_statements generates a query id ignoring comments. As the result the identical queries with different hints are summarized as the same query.

 
 
Requirements

 pg_hint_plan14 1.6 requires PostgreSQL 14.
pg_hint_plan.enable_hint True enables pg_hint_plan.on
pg_hint_plan.enable_hint_tableTrue enbles hinting by table. true or false.off
True enables hinting by table. true or false.off
pg_hint_plan.parse_messages Specifies the log level of hint parse error. Valid values are error, warning, notice, info, log, debug.INFO
pg_hint_plan.debug_print