Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit c8967be

Browse files
author
Liudmila Mantrova
committed
DOC: grammar fixes in plantuner docs
1 parent 0a3c12a commit c8967be

File tree

1 file changed

+24
-29
lines changed

1 file changed

+24
-29
lines changed

doc/src/sgml/plantuner.sgml

Lines changed: 24 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,45 @@
11
<sect1 id="plantuner">
22
<title>plantuner</title>
33
<para>
4-
The <literal>plantuner</literal> module provides hits for planner,
5-
which can disable or enable indexes for query execution.
4+
The <filename>plantuner</filename> module provides hints
5+
for the planner that can disable or enable indexes for query execution.
66
</para>
77

88
<sect2 id="plantuner-motivation">
99
<title>Motivation</title>
1010
<para>
11-
Whether somebody think it's bad or not, but sometime it's very
12-
interesting to be able to control planner (provide hints, which tell
13-
optimizer to ignore its algorithm in part), which is currently
14-
impossible in &productname; (and PostgreSQL).
15-
Oracle, for example, has over 120 hints,
16-
and Microsoft SQL Server also supports hints.
11+
In some cases, it may be required to control the planner
12+
by providing hints that make the optimizer ignore some
13+
parts of its algorithm. There are many situations when
14+
a developer may want to temporarily disable specific
15+
index(es), without dropping them, or to instruct the planner to
16+
use a specific index.
1717
</para>
1818
<para>
19-
This first version of plantuner provides a possibility to hide
20-
specified indexes from &productname; planner, so it will not use them.
21-
</para>
22-
<para>
23-
There are many situations when developer want to temporarily disable
24-
specific index(es), without dropping them, or to instruct planner to
25-
use specific index.
26-
</para>
27-
<para>
28-
Next, for some workload &productname; could be too pessimistic for
29-
newly created tables and assumes much more rows in table than
30-
it actually has. If plantuner.fix_empty_table GUC variable is set
31-
to true then module will set to zero the number of pages/tuples of
32-
table which hasn't blocks in a file.
19+
This version of <filename>plantuner</filename> provides a
20+
possibility to hide the specified indexes from &productname;
21+
planner, so it will not use them.For some workloads, &productname;
22+
could be too pessimistic about newly created tables and assume
23+
that there are much more rows in a table than it actually has. If the
24+
<varname>plantuner.fix_empty_table</varname> GUC variable is set
25+
to <literal>true</literal>, <filename>plantuner</filename> sets to zero
26+
the number of pages/tuples of the table that has no blocks in a file.
3327
</para>
3428
</sect2>
3529

36-
<sect2 id="plantuner-syntax">
37-
<title>Syntax</title>
38-
<para>plantuner.disable_index &mdash; List of indexes invisible to planner</para>
39-
<para>plantuner.enable_index &mdash; List of indexes visible to planner even they are hidden by plantuner.disable_index.</para>
30+
<sect2 id="plantuner-guc-variables">
31+
<title>GUC Variables</title>
32+
<para><varname>plantuner.disable_index</varname> &mdash; list of indexes invisible to planner.</para>
33+
<para><varname>plantuner.enable_index</varname> &mdash; list of indexes visible to planner even if they are hidden by <varname>plantuner.disable_index</varname>.</para>
4034
</sect2>
4135

4236
<sect2 id="plantuner-usage-example">
4337
<title>Example</title>
4438
<para>
45-
To enable the module you can either load shared library 'plantuner' in
46-
psql session or specify 'shared_preload_libraries' option in
47-
postgresql.conf.
39+
To enable the module, you can either load <literal>plantuner</literal>
40+
shared library in a <literal>psql</literal> session or specify
41+
<varname>shared_preload_libraries</varname> option in
42+
<filename>postgresql.conf</filename>.
4843
<programlisting>
4944
=# LOAD 'plantuner';
5045
=# create table test(id int);

0 commit comments

Comments
 (0)