Skip to content

Commit 8f854b3

Browse files
author
Liudmila Mantrova
committed
DOC: added local_tracking, lower_limit, capacity_threshold to online-analyze docs; grammar fixes
1 parent 876c1ea commit 8f854b3

File tree

1 file changed

+46
-18
lines changed

1 file changed

+46
-18
lines changed

‎doc/src/sgml/online-analyze.sgml

Lines changed: 46 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,94 @@
11
<sect1 id="online-analyze">
22
<title>online-analyze</title>
33
<para>
4-
The <literal>online_analyze</literal> module provides set of
5-
features, which immediately update stats after INSERT, UPDATE, DELETE
6-
or SELECT INTO operations applied for affected tables.
4+
The <filename>online_analyze</filename> module provides a set of
5+
features that immediately update statistics after <command>INSERT</command>,
6+
<command>UPDATE</command>, <command>DELETE</command>, or <command>SELECT INTO</command>
7+
operations for the affected tables.
78
</para>
89

910
<sect2 id="online-analyze-loading">
10-
<title>Module loading</title>
11+
<title>Module Loading</title>
1112
<para>
12-
To use <literal>online_analyze</literal> module the first thing you need is to
13-
load shared library:
13+
To use <filename>online_analyze</filename> module, load the shared library:
1414

1515
<programlisting>
16-
LOAD 'online_analyze';
17-
</programlisting>
16+
LOAD 'online_analyze';
17+
</programlisting>
1818
</para>
1919
</sect2>
2020

2121
<sect2 id="online-analyze-configuration">
22-
<title>Module configuration</title>
22+
<title>Module Configuration</title>
2323

2424
<para>
25-
Custom variables (default values are shown):
25+
You can configure <filename>online_analyze</filename> using
26+
the following custom variables (default values are shown):
2627

2728
<itemizedlist>
2829
<listitem>
2930
<para>online_analyze.enable = on</para>
30-
<para>Enables online analyze</para>
31+
<para>Enables <filename>online_analyze</filename>.</para>
3132
</listitem>
3233
<listitem>
3334
<para>online_analyze.verbose = on</para>
34-
<para>Execute ANALYZE VERBOSE</para>
35+
<para>Executes <command>ANALYZE VERBOSE</command>.</para>
3536
</listitem>
3637
<listitem>
3738
<para>online_analyze.scale_factor = 0.1</para>
38-
<para>Fraction of table size to start online analyze (similar to autovacuum_analyze_scale_factor)</para>
39+
<para>Fraction of table size to start online analysis
40+
(similar to <xref linkend="guc-autovacuum-analyze-scale-factor">).</para>
3941
</listitem>
4042

4143
<listitem>
4244
<para>online_analyze.threshold = 50</para>
43-
<para>Min number of row updates before online analyze (similar to autovacuum_analyze_threshold)</para>
45+
<para>Minimum number of row updates before starting online analysis
46+
(similar to <xref linkend="guc-autovacuum-analyze-threshold">).</para>
4447
</listitem>
4548

4649
<listitem>
4750
<para>online_analyze.min_interval = 10000</para>
48-
<para>Minimum time interval between analyze call per table (in milliseconds)</para>
51+
<para>Minimum time interval between <command>ANALYZE</command>
52+
calls per table, in milliseconds.</para>
4953
</listitem>
5054

5155
<listitem>
5256
<para>online_analyze.table_type = "all"</para>
53-
<para>Type(s) of tables for online analyze: all, persistent, temporary, none</para>
57+
<para>Type(s) of tables for online analysis. Possible values are:
58+
<literal>all</literal>, <literal>persistent</literal>,
59+
<literal>temporary</literal>, <literal>none</literal>.</para>
5460
</listitem>
5561

5662
<listitem>
5763
<para>online_analyze.exclude_tables = ""</para>
58-
<para>List of tables to exclude from online analyze</para>
64+
<para>List of tables to exclude from online analysis.</para>
5965
</listitem>
6066

6167
<listitem>
6268
<para>online_analyze.include_tables = ""</para>
63-
<para>List of tables to include in online analyze (online_analyze.include_tables overrides online_analyze.exclude_tables).</para>
69+
<para>List of tables to include in online analysis
70+
(<varname>online_analyze.include_tables</varname> overrides
71+
<varname>online_analyze.exclude_tables</varname>).</para>
72+
</listitem>
73+
74+
<listitem>
75+
<para>online_analyze.local_tracking = off</para>
76+
<para>Enables per-backend tracking for temporary tables by
77+
<filename>online_analyze</filename>. When this variable is set
78+
to <literal>off</literal>, <filename>online_analyze</filename>
79+
uses the default system statistics for temporary tables.</para>
80+
</listitem>
81+
82+
<listitem>
83+
<para>online_analyze.lower_limit = 0</para>
84+
<para>Minimum number of rows in a table required to trigger
85+
<filename>online_analyze</filename>.</para>
86+
</listitem>
87+
88+
<listitem>
89+
<para>online_analyze.capacity_threshold = 100000</para>
90+
<para>Maximum number of temporary tables to store
91+
in local cache.</para>
6492
</listitem>
6593
</itemizedlist>
6694
</para>

0 commit comments

Comments
 (0)