Skip to content

Commit

Permalink
doc: Fix typos in hint_details.md
Browse files Browse the repository at this point in the history
Per pull request #172.  Backpatch down to 14, where the new
documentation has been introduced.

Author: Qilong Li
Backpatch-through: 14
  • Loading branch information
michaelpq committed Feb 20, 2024
1 parent e41d3bd commit a21d3b3
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/hint_details.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ underscores, commas and parentheses. In the following example,
`pg_hint_plan` works for queries in PL/pgSQL scripts with some restrictions.

- Hints affect only on the following kind of queries:
- Queries that returns one row (`SELECT`, `INSERT`, `UPDATE` and `DELETE`)
- Queries that returns multiple rows (`RETURN QUERY`)
- Queries that return one row (`SELECT`, `INSERT`, `UPDATE` and `DELETE`)
- Queries that return multiple rows (`RETURN QUERY`)
- Dynamic SQL statements (`EXECUTE`)
- Cursor open (`OPEN`)
- Loop over result of a query (`FOR`)
Expand Down Expand Up @@ -70,7 +70,7 @@ TBL, tbl or Tbl.
## Escaping special characters in object names

The objects defined in a hint's parameter can use double quotes if they
includes parentheses, double quotes and white spaces. The escaping rules are
include parentheses, double quotes and white spaces. The escaping rules are
the same as PostgreSQL.

## Distinction between multiple occurences of a table
Expand Down Expand Up @@ -120,7 +120,7 @@ from outside the view.

## Inheritance

Hints can only point to the parent of an inheritance tree and the hint saffect
Hints can only point to the parent of an inheritance tree and the hints affect
all the tables in an inheritance tree. Hints pointing directly to inherited
children have no effect.

Expand All @@ -133,7 +133,7 @@ of the individual statements in the multistatement.

`VALUES` expressions in `FROM` clause are named as `*VALUES*` internally these
can be hinted if it is the only `VALUES` of a query. Two or more `VALUES`
expressions in a query cannot be distinguised by looking at an `EXPLAIN` result,
expressions in a query cannot be distinguished by looking at an `EXPLAIN` result,
resulting in ambiguous results:

```sql
Expand Down Expand Up @@ -197,7 +197,7 @@ zero workers prevents a scan from being executed in parallel.

## Setting `pg_hint_plan` parameters by Set hints

`pg_hint_plan` parameters influence its own behavior so some parameters
`pg_hint_plan` parameters influence their own behavior so some parameters
will not work as one could expect:

- Hints to change `enable_hint`, `enable_hint_tables` are ignored even though
Expand Down

0 comments on commit a21d3b3

Please sign in to comment.