Skip to content

Commit 879841d

Browse files
dmpgprodmpgpro
committed
[Doc]: Add docs for 1C modules
1 parent 4405878 commit 879841d

File tree

9 files changed

+418
-5
lines changed

9 files changed

+418
-5
lines changed

‎doc/src/sgml/contrib.sgml

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,13 +110,16 @@ CREATE EXTENSION <replaceable>module_name</> FROM unpackaged;
110110
&btree-gist;
111111
&chkpass;
112112
&citext;
113+
&contrib-spi;
113114
&cube;
114115
&dblink;
115116
&dict-int;
116117
&dict-xsyn;
117118
&dump-stat;
118119
&earthdistance;
120+
&fasttrun;
119121
&file-fdw;
122+
&fulleq;
120123
&fuzzystrmatch;
121124
&hstore;
122125
&hunspell-dict;
@@ -126,6 +129,8 @@ CREATE EXTENSION <replaceable>module_name</> FROM unpackaged;
126129
&jsquery;
127130
&lo;
128131
&ltree;
132+
&mchar;
133+
&online-analyze;
129134
&pageinspect;
130135
&passwordcheck;
131136
&pgarman;
@@ -141,11 +146,11 @@ CREATE EXTENSION <replaceable>module_name</> FROM unpackaged;
141146
&pgtrgm;
142147
&pgvariables;
143148
&pgvisibility;
149+
&plantuner;
144150
&postgres-fdw;
145151
&seg;
146152
&sepgsql;
147153
&shared-ispell;
148-
&contrib-spi;
149154
&sr-plan;
150155
&sslinfo;
151156
&tablefunc;
@@ -157,7 +162,7 @@ CREATE EXTENSION <replaceable>module_name</> FROM unpackaged;
157162
&unaccent;
158163
&uuid-ossp;
159164
&xml2;
160-
165+
161166
</appendix>
162167

163168
<!--

‎doc/src/sgml/fasttrun.sgml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
<sect1 id="fasttrun">
2+
<title>fasttrun</title>
3+
<para>
4+
The <literal>fasttrun</literal> module provides transaction unsafe
5+
function to truncate tempory tables without growing pg_class size.
6+
</para>
7+
8+
<sect2 id="fasttrun-function">
9+
<para>
10+
There is a function call example:
11+
<programlisting>
12+
select fasttruncate('TABLE_NAME');
13+
</programlisting>
14+
</para>
15+
</sect2>
16+
17+
<sect2 id="fasttrun-test">
18+
<para>
19+
For tests you can use this example:
20+
<programlisting>
21+
create or replace function f() returns void as $$
22+
begin
23+
for i in 1..1000
24+
loop
25+
PERFORM fasttruncate('tt1');
26+
end loop;
27+
end;
28+
$$ language plpgsql;
29+
</programlisting>
30+
</para>
31+
</sect2>
32+
33+
<sect2 id="fasttrun-authors">
34+
<title>Authors</title>
35+
<literallayout>
36+
Teodor Sigaev <email>teodor@sigaev.ru</email>
37+
</literallayout>
38+
</sect2>
39+
40+
</sect1>

‎doc/src/sgml/filelist.sgml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,8 +120,10 @@
120120
<!ENTITY dump-stat SYSTEM "dump-stat.sgml">
121121
<!ENTITY dummy-seclabel SYSTEM "dummy-seclabel.sgml">
122122
<!ENTITY earthdistance SYSTEM "earthdistance.sgml">
123+
<!ENTITY fasttrun SYSTEM "fasttrun.sgml">
123124
<!ENTITY file-fdw SYSTEM "file-fdw.sgml">
124125
<!ENTITY fuzzystrmatch SYSTEM "fuzzystrmatch.sgml">
126+
<!ENTITY fulleq SYSTEM "fulleq.sgml">
125127
<!ENTITY hstore SYSTEM "hstore.sgml">
126128
<!ENTITY hunspell-dict SYSTEM "hunspell-dict.sgml">
127129
<!ENTITY intagg SYSTEM "intagg.sgml">
@@ -130,7 +132,9 @@
130132
<!ENTITY jsquery SYSTEM "jsquery.sgml">
131133
<!ENTITY lo SYSTEM "lo.sgml">
132134
<!ENTITY ltree SYSTEM "ltree.sgml">
135+
<!ENTITY mchar SYSTEM "mchar.sgml">
133136
<!ENTITY oid2name SYSTEM "oid2name.sgml">
137+
<!ENTITY online-analyze SYSTEM "online-analyze.sgml">
134138
<!ENTITY pageinspect SYSTEM "pageinspect.sgml">
135139
<!ENTITY passwordcheck SYSTEM "passwordcheck.sgml">
136140
<!ENTITY pgarman SYSTEM "pgarman.sgml">
@@ -148,6 +152,7 @@
148152
<!ENTITY pgvariables SYSTEM "pg_variables.sgml">
149153
<!ENTITY pgvisibility SYSTEM "pgvisibility.sgml">
150154
<!ENTITY postgres-fdw SYSTEM "postgres-fdw.sgml">
155+
<!ENTITY plantuner SYSTEM "plantuner.sgml">
151156
<!ENTITY seg SYSTEM "seg.sgml">
152157
<!ENTITY contrib-spi SYSTEM "contrib-spi.sgml">
153158
<!ENTITY sepgsql SYSTEM "sepgsql.sgml">
@@ -162,7 +167,7 @@
162167
<!ENTITY tsearch2 SYSTEM "tsearch2.sgml">
163168
<!ENTITY tsm-system-rows SYSTEM "tsm-system-rows.sgml">
164169
<!ENTITY tsm-system-time SYSTEM "tsm-system-time.sgml">
165-
<!ENTITY unaccent SYSTEM "unaccent.sgml">
170+
<!ENTITY unaccent SYSTEM "unaccent.sgml">
166171
<!ENTITY uuid-ossp SYSTEM "uuid-ossp.sgml">
167172
<!ENTITY vacuumlo SYSTEM "vacuumlo.sgml">
168173
<!ENTITY xml2 SYSTEM "xml2.sgml">

‎doc/src/sgml/fulleq.sgml

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
<sect1 id="fulleq">
2+
<title>fulleq</title>
3+
<para>
4+
The <literal>fulleq</literal> module provides additional equivalence
5+
operator to compatibility with Microsoft SQL Server.
6+
</para>
7+
8+
<sect2 id="fulleq-overview">
9+
The <productname>&productname;</productname> equivalence operator is
10+
defined to returns NULL when both operands are NULLs. However, the Microsoft
11+
SQL Servers family traditionaly defined other semantic for equivalence
12+
operator, where operator returns TRUE in the case of both nulled operands.
13+
This module provides such operator with MSSQL semantic.
14+
</sect2>
15+
16+
<sect2 id="fulleq-operator">
17+
<title>Operator fulleq</title>
18+
<para>
19+
This operator <emphasis>==</emphasis> is defined for following data
20+
types:
21+
<itemizedlist>
22+
<listitem><para>bool</para></listitem>
23+
<listitem><para>bytea</para></listitem>
24+
<listitem><para>char</para></listitem>
25+
<listitem><para>name</para></listitem>
26+
<listitem><para>int2</para></listitem>
27+
<listitem><para>int4</para></listitem>
28+
<listitem><para>int8</para></listitem>
29+
<listitem><para>int2vector</para></listitem>
30+
<listitem><para>text</para></listitem>
31+
<listitem><para>oid</para></listitem>
32+
<listitem><para>xid</para></listitem>
33+
<listitem><para>cid</para></listitem>
34+
<listitem><para>oidvector</para></listitem>
35+
<listitem><para>float4</para></listitem>
36+
<listitem><para>float8</para></listitem>
37+
<listitem><para>abstime</para></listitem>
38+
<listitem><para>reltime</para></listitem>
39+
<listitem><para>macaddr</para></listitem>
40+
<listitem><para>inet</para></listitem>
41+
<listitem><para>cidr</para></listitem>
42+
<listitem><para>varchar</para></listitem>
43+
<listitem><para>date</para></listitem>
44+
<listitem><para>time</para></listitem>
45+
<listitem><para>timestamp</para></listitem>
46+
<listitem><para>timestamptz</para></listitem>
47+
<listitem><para>interval</para></listitem>
48+
<listitem><para>timetz</para></listitem>
49+
</itemizedlist>
50+
</para>
51+
</sect2>
52+
53+
<sect2 id="fulleq-authors">
54+
<title>Authors</title>
55+
<literallayout>
56+
Teodor Sigaev <email>teodor@sigaev.ru</email>
57+
</literallayout>
58+
</sect2>
59+
60+
</sect1>

‎doc/src/sgml/intro.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -218,8 +218,8 @@
218218
</listitem>
219219
<listitem>
220220
<simpara><application>online_analyze</application> module provides set of
221-
changes, which immediately update stats, after INSERT, UPDATE, DELETE
222-
or SELECT INTO operations, applied for affected tables.</simpara>
221+
changes, which immediately update stats after INSERT, UPDATE, DELETE
222+
or SELECT INTO operations applied for affected tables.</simpara>
223223
</listitem>
224224
<listitem>
225225
<simpara><application>plantuner</application> module provides hits for planner, which can do disable or enable indexes for query execution.</simpara>

‎doc/src/sgml/mchar.sgml

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
<sect1 id="mchar">
2+
<title>mchar</title>
3+
<para>
4+
The <literal>mchar</literal> module provides additional data types
5+
to compatibility with Microsoft SQL Server (MSSQL).
6+
</para>
7+
8+
<sect2 id="mchar-overview">
9+
<title>Overview</title>
10+
<para>
11+
This module has been designed to imporving <application>1C Enterprise</application>
12+
support, most popular russian CRM and ERP systems.
13+
</para>
14+
</sect2>
15+
16+
<sect2 id="mchar-types">
17+
<title>Additional types</title>
18+
<itemizedlist>
19+
<listitem>
20+
<para><type>mchar</type> - analog of the MSSQL char type</para>
21+
</listitem>
22+
<listitem>
23+
<para><type>mvarchar</type> - analog of the MSSQL varchar type</para>
24+
</listitem>
25+
</itemizedlist>
26+
</sect2>
27+
28+
<sect2 id="mchar-features">
29+
<title>MCHAR and MVARCHAR features</title>
30+
<itemizedlist>
31+
<listitem>
32+
<para>defined <function>length(str)<function> function</para>
33+
</listitem>
34+
<listitem>
35+
<para>defined <function>substr(str, pos[, length])<function> function</para>
36+
</listitem>
37+
<listitem>
38+
<para>defined operator <emphasis>||<emphasis>, which would be applied to concatenation any (mchar and mvarchar) arguments</para>
39+
</listitem>
40+
<listitem>
41+
<para>defined set of operators: <emphasis>&lt; &lt;= = &gt;= &gt;</emphasis> to case-insensitive comparations (LibICU)</para>
42+
</listitem>
43+
<listitem>
44+
<para>defined set of operators: <emphasis>&amp;&lt; &amp;&lt;= &amp;= &amp;&gt;= &amp;&gt;</emphasis> to case-sensitive comparations (LibICU)</para>
45+
</listitem>
46+
<listitem>
47+
<para>implicit casting between <type>mchar</type> and <type>mvarchar</type> types</para>
48+
</listitem>
49+
<listitem>
50+
<para>B-tree and Hash-index support</para>
51+
</listitem>
52+
<listitem>
53+
<para>Operator <emphasis>LIKE [ESCAPE]</emphasis> support</para>
54+
</listitem>
55+
<listitem>
56+
<para>Operator <emphasis>SIMILAR TO [ESCAPE]</emphasis> support</para>
57+
</listitem>
58+
<listitem>
59+
<para>Operator <empasis>~</emphasis> (POSIX regexp) supoprt</para>
60+
</listitem>
61+
<listitem>
62+
<para>Index support for <empasis>LIKE</emphasis> operator</para>
63+
</listitem>
64+
</itemizedlist>
65+
</sect2>
66+
67+
<sect2 id="mchar-authors">
68+
<title>Authors</title>
69+
<literallayout>
70+
Oleg Bartunov <email>oleg@sai.msu.ru</email>
71+
Teodor Sigaev <email>teodor@sigaev.ru</email>
72+
</literallayout>
73+
</sect2>
74+
75+
</sect1>

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

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
<sect1 id="online-analyze">
2+
<title>online-analyze</title>
3+
<para>
4+
The <literal>online_analyze</literal> module provides set of
5+
changes, which immediately update stats after INSERT, UPDATE, DELETE
6+
or SELECT INTO operations applied for affected tables.
7+
</para>
8+
9+
<sect2 id="online-analyze-loading">
10+
<title>Module loading</title>
11+
<para>
12+
To use <literal>online_analyze</literal> module the first thing you need to
13+
load shared library:
14+
15+
<programlisting>
16+
LOAD 'online_analyze';
17+
</programlisting>
18+
</para>
19+
</sect2>
20+
21+
<sect2 id="online-analyze-configuration">
22+
<title>Module configuration</title>
23+
24+
<para>
25+
Custom variables (defaults values are shown):
26+
27+
<itemizedlist>
28+
<listitem>
29+
<para>online_analyze.enable = on</para>
30+
<para>Enables on-line analyze</para>
31+
</listitem>
32+
<listitem>
33+
<para>online_analyze.verbose = on</para>
34+
<para>Execute ANALYZE VERBOSE</para>
35+
</listitem>
36+
<listitem>
37+
<para>online_analyze.scale_factor = 0.1</para>
38+
<para>Fraction of table size to start on-line analyze (similar to autovacuum_analyze_scale_factor)</para>
39+
</listitem>
40+
41+
<listitem>
42+
<para>online_analyze.threshold = 50</para>
43+
<para>Min number of row updates before on-line analyze (similar to autovacuum_analyze_threshold)</para>
44+
</listitem>
45+
46+
<listitem>
47+
<para>online_analyze.min_interval = 10000</para>
48+
<para>Minimum time interval between analyze call per table (in milliseconds)</para>
49+
</listitem>
50+
51+
<listitem>
52+
<para>online_analyze.table_type = "all"</para>
53+
<para>Type(s) of table for online analyze: all, persistent, temporary, none</para>
54+
</listitem>
55+
56+
<listitem>
57+
<para>online_analyze.exclude_tables = ""</para>
58+
<para>List of tables which will not online analyze</para>
59+
</listitem>
60+
61+
<listitem>
62+
<para>online_analyze.include_tables = ""</para>
63+
<para>List of tables which will online analyze online_analyze.include_tables overwrites online_analyze.exclude_tables.</para>
64+
</listitem>
65+
</itemizedlist>
66+
</para>
67+
</sect2>
68+
69+
<sect2 id="online-analyze-authors">
70+
<title>Authors</title>
71+
<literallayout>
72+
Teodor Sigaev <email>teodor@sigaev.ru</email>
73+
</literallayout>
74+
</sect2>
75+
76+
</sect1>

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy