pg.ddx.io pgsql-docs@postgresql.org mailing list archive
help / color / mirror / Atom feedAbout contrib modules
7+ messages / 4 participants
[nested] [flat]
* About contrib modules
@ 2007-11-22 09:08 albert@nan-tic.com
0 siblings, 1 reply; 7+ messages in thread
From: albert@nan-tic.com @ 2007-11-22 09:08 UTC (permalink / raw)
To: pgsql-docs
I'm sorry I haven't said anything yet. I've got no Internet connection at
home. I'll work on the remaining work on contrib docs as soon as my
Internet connection is restablished.
^ permalink raw reply [nested|flat] 7+ messages in thread
* Re: About contrib modules
@ 2007-11-22 16:23 Bruce Momjian <bruce@momjian.us>
parent: albert@nan-tic.com
0 siblings, 2 replies; 7+ messages in thread
From: Bruce Momjian @ 2007-11-22 16:23 UTC (permalink / raw)
To: albert@nan-tic.com; +Cc: pgsql-docs
albert@nan-tic.com wrote:
> I'm sorry I haven't said anything yet. I've got no Internet connection at
> home. I'll work on the remaining work on contrib docs as soon as my
> Internet connection is restablished.
Thanks. We probably have 1-2 weeks left to get it into 8.3 final.
--
Bruce Momjian <bruce@momjian.us> http://momjian.us
EnterpriseDB http://postgres.enterprisedb.com
+ If your life is a hard drive, Christ can be your backup. +
^ permalink raw reply [nested|flat] 7+ messages in thread
* Re: About contrib modules
@ 2007-12-02 17:34 Albert Cervera i Areny <albert@nan-tic.com>
parent: Bruce Momjian <bruce@momjian.us>
1 sibling, 1 reply; 7+ messages in thread
From: Albert Cervera i Areny @ 2007-12-02 17:34 UTC (permalink / raw)
To: Bruce Momjian <bruce@momjian.us>; +Cc: pgsql-docs
A Dijous 22 Novembre 2007, Bruce Momjian va escriure:
> albert@nan-tic.com wrote:
> > I'm sorry I haven't said anything yet. I've got no Internet connection at
> > home. I'll work on the remaining work on contrib docs as soon as my
> > Internet connection is restablished.
>
> Thanks. We probably have 1-2 weeks left to get it into 8.3 final.
Attached, the dict_int and dict_xsyn SGML docs.
Now I'll work on the lost changes of the already SGML'ed docs.
--
Albert Cervera i Areny
http://www.NaN-tic.com
Attachments:
dicts.diff (text/x-diff, 1.2K) download
Index: contrib.sgml
===================================================================
RCS file: /projects/cvsroot/pgsql/doc/src/sgml/contrib.sgml,v
retrieving revision 1.4
diff -c -r1.4 contrib.sgml
*** contrib.sgml 14 Nov 2007 02:36:43 -0000 1.4
--- contrib.sgml 2 Dec 2007 17:32:09 -0000
***************
*** 82,87 ****
--- 82,89 ----
&chkpass;
&cube;
&dblink;
+ &dict-int;
+ &dict-xsyn;
&earthdistance;
&fuzzystrmatch;
&hstore;
Index: filelist.sgml
===================================================================
RCS file: /projects/cvsroot/pgsql/doc/src/sgml/filelist.sgml,v
retrieving revision 1.53
diff -c -r1.53 filelist.sgml
*** filelist.sgml 14 Nov 2007 01:09:50 -0000 1.53
--- filelist.sgml 2 Dec 2007 17:32:10 -0000
***************
*** 96,101 ****
--- 96,103 ----
<!entity chkpass SYSTEM "chkpass.sgml">
<!entity cube SYSTEM "cube.sgml">
<!entity dblink SYSTEM "dblink.sgml">
+ <!entity dict-int SYSTEM "dict-int.sgml">
+ <!entity dict-xsyn SYSTEM "dict-xsyn.sgml">
<!entity earthdistance SYSTEM "earthdistance.sgml">
<!entity fuzzystrmatch SYSTEM "fuzzystrmatch.sgml">
<!entity hstore SYSTEM "hstore.sgml">
dict-int.sgml (text/sgml, 1.3K) download
<sect1>
<title>dict_int</title>
<para>
The motivation for this example dictionary is to control the indexing of
integers (signed and unsigned), and, consequently, to minimize the number of
unique words which greatly affect the performance of searching.
</para>
<sect2>
<title>Configuration</title>
<para>
The dictionary accepts two options:
</para>
<itemizedlist>
<listitem>
<para>
The MAXLEN parameter specifies the maximum length (number of digits)
allowed in an integer word. The default value is 6.
</para>
</listitem>
<listitem>
<para>
The REJECTLONG parameter specifies if an overlength integer should be
truncated or ignored. If REJECTLONG=FALSE (default), the dictionary returns
the first MAXLEN digits of the integer. If REJECTLONG=TRUE, the
dictionary treats an overlength integer as a stop word, so that it will
not be indexed.
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title>Usage</title>
<programlisting>
mydb# select ts_lexize('intdict', '12345678');
ts_lexize
-----------
{123456}
</programlisting>
<para>
Change dictionary options:
</para>
<programlisting>
mydb# ALTER TEXT SEARCH DICTIONARY intdict (MAXLEN = 4, REJECTLONG = true);
ALTER TEXT SEARCH DICTIONARY
</programlisting>
</sect2>
</sect1>
dict-xsyn.sgml (text/sgml, 1.8K) download
<sect1>
<title>dict_xsyn</title>
<para>
The Extended Synonym Dictionary module replaces words with groups of their
synonyms, and so makes it possible to search for a word using any of its
synonyms.
</para>
<sect2>
<title>Configuration</title>
<para>
It accepts the following options:
</para>
<itemizedlist>
<listitem>
<para>
KEEPORIG controls whether the original word is included, or only its
synonyms. Default is 'true'.
</para>
</listitem>
<listitem>
<para>
RULES is the base name of the file containing the list of synonyms.
This file must be in $(prefix)/share/tsearch_data/, and its name must
end in ".rules" (which is not included in the RULES parameter).
</para>
</listitem>
</itemizedlist>
<para>
The rules file has the following format:
</para>
<itemizedlist>
<listitem>
<para>
Each line represents a group of synonyms for a single word, which is
given first on the line. Synonyms are separated by whitespace:
</para>
<programlisting>
word syn1 syn2 syn3
</programlisting>
</listitem>
<listitem>
<para>
Sharp ('#') sign is a comment delimiter. It may appear at any position
inside the line. The rest of the line will be skipped.
</para>
</listitem>
</itemizedlist>
<para>
Look at xsyn_sample.rules, which is installed in $(prefix)/share/tsearch_data/,
for an example.
</para>
</sect2>
<sect2>
<title>Usage</title>
<programlisting>
mydb=# SELECT ts_lexize('xsyn','word');
ts_lexize
----------------
{word,syn1,syn2,syn3)
</programlisting>
<para>
Change dictionary options:
</para>
<programlisting>
mydb# ALTER TEXT SEARCH DICTIONARY xsyn (KEEPORIG=false);
ALTER TEXT SEARCH DICTIONARY
</programlisting>
</sect2>
</sect1>
* Re: About contrib modules
@ 2007-12-02 21:17 Tom Lane <tgl@sss.pgh.pa.us>
parent: Albert Cervera i Areny <albert@nan-tic.com>
0 siblings, 0 replies; 7+ messages in thread
From: Tom Lane @ 2007-12-02 21:17 UTC (permalink / raw)
To: Albert Cervera i Areny <albert@nan-tic.com>; +Cc: Bruce Momjian <bruce@momjian.us>; pgsql-docs
Albert Cervera i Areny <albert@nan-tic.com> writes:
> Attached, the dict_int and dict_xsyn SGML docs.
Applied, thanks.
regards, tom lane
^ permalink raw reply [nested|flat] 7+ messages in thread
* Re: About contrib modules
@ 2007-12-02 23:36 Albert Cervera i Areny <albert@nan-tic.com>
parent: Bruce Momjian <bruce@momjian.us>
1 sibling, 1 reply; 7+ messages in thread
From: Albert Cervera i Areny @ 2007-12-02 23:36 UTC (permalink / raw)
To: Bruce Momjian <bruce@momjian.us>; +Cc: pgsql-docs
A Dijous 22 Novembre 2007, Bruce Momjian va escriure:
> albert@nan-tic.com wrote:
> > I'm sorry I haven't said anything yet. I've got no Internet connection at
> > home. I'll work on the remaining work on contrib docs as soon as my
> > Internet connection is restablished.
>
> Thanks. We probably have 1-2 weeks left to get it into 8.3 final.
Attached, contrib docs with the changes of the last months. Had to update
cube, apart from most modules of Tom's list. Everything should be up to date
now.
--
Albert Cervera i Areny
http://www.NaN-tic.com
Attachments:
old.diff (text/x-diff, 14.1K) download
Index: cube.sgml
===================================================================
RCS file: /projects/cvsroot/pgsql/doc/src/sgml/cube.sgml,v
retrieving revision 1.2
diff -c -r1.2 cube.sgml
*** cube.sgml 11 Nov 2007 14:23:18 -0000 1.2
--- cube.sgml 2 Dec 2007 23:32:29 -0000
***************
*** 353,358 ****
--- 353,364 ----
</entry>
</row>
<row>
+ <entry><literal>cube(text)</literal></entry>
+ <entry>Takes text input and returns a cube. This is useful for making
+ cubes from computed strings.
+ </entry>
+ </row>
+ <row>
<entry><literal>cube(float8) returns cube</literal></entry>
<entry>This makes a one dimensional cube with both coordinates the same.
If the type of the argument is a numeric type other than float8 an
Index: intarray.sgml
===================================================================
RCS file: /projects/cvsroot/pgsql/doc/src/sgml/intarray.sgml,v
retrieving revision 1.2
diff -c -r1.2 intarray.sgml
*** intarray.sgml 12 Nov 2007 01:37:34 -0000 1.2
--- intarray.sgml 2 Dec 2007 23:32:29 -0000
***************
*** 12,20 ****
<para>
Current implementation provides index support for one-dimensional array of
! int4's - gist__int_ops, suitable for small and medium size of arrays (used on
default), and gist__intbig_ops for indexing large arrays (we use superimposed
! signature with length of 4096 bits to represent sets).
</para>
<sect2>
--- 12,21 ----
<para>
Current implementation provides index support for one-dimensional array of
! integers: gist__int_ops, suitable for small and medium size of arrays (used by
default), and gist__intbig_ops for indexing large arrays (we use superimposed
! signature with length of 4096 bits to represent sets). There is also a
! non-default gin__int_ops for GIN indexes on integer arrays.
</para>
<sect2>
Index: pageinspect.sgml
===================================================================
RCS file: /projects/cvsroot/pgsql/doc/src/sgml/pageinspect.sgml,v
retrieving revision 1.1
diff -c -r1.1 pageinspect.sgml
*** pageinspect.sgml 10 Nov 2007 23:30:46 -0000 1.1
--- pageinspect.sgml 2 Dec 2007 23:32:29 -0000
***************
*** 32,46 ****
A page image obtained with <literal>get_raw_page</literal> should be passed as argument:
</para>
<programlisting>
! test=# SELECT * FROM page_header(get_raw_page('pg_class',0));
! lsn | tli | flags | lower | upper | special | pagesize | version
! ----------+-----+-------+-------+-------+---------+----------+---------
! 0/3C5614 | 1 | 1 | 216 | 256 | 8192 | 8192 | 4
! (1 row)
</programlisting>
<para>
! The returned columns correspond to the fields in the PageHeaderData-struct,
! see src/include/storage/bufpage.h for more details.
</para>
</listitem>
--- 32,45 ----
A page image obtained with <literal>get_raw_page</literal> should be passed as argument:
</para>
<programlisting>
! regression=# SELECT * FROM page_header(get_raw_page('pg_class',0));
! lsn | tli | flags | lower | upper | special | pagesize | version | prune_xid
! -----------+-----+-------+-------+-------+---------+----------+---------+-----------
! 0/24A1B50 | 1 | 1 | 232 | 368 | 8192 | 8192 | 4 | 0
</programlisting>
<para>
! The returned columns correspond to the fields in the PageHeaderData struct.
! See src/include/storage/bufpage.h for more details.
</para>
</listitem>
Index: pgbench.sgml
===================================================================
RCS file: /projects/cvsroot/pgsql/doc/src/sgml/pgbench.sgml,v
retrieving revision 1.2
diff -c -r1.2 pgbench.sgml
*** pgbench.sgml 11 Nov 2007 14:23:18 -0000 1.2
--- pgbench.sgml 2 Dec 2007 23:32:29 -0000
***************
*** 379,384 ****
--- 379,399 ----
<para>
Variables can also be defined by using -D option.
</para>
+ <program
+ </listitem>
+ <listitem>
+ <para>
+ <literal>\sleep num [us|ms|s] - Causes script execution to sleep for the
+ specified duration of microseconds (us), milliseconds (ms) or the default
+ seconds (s).
+ </para>
+ <para>
+ Example:
+ </para>
+ <programlisting>
+ \setrandom millisec 1000 2500
+ \sleep : millisec ms
+ </programlisting>
</listitem>
</itemizedlist>
</sect2>
Index: pgrowlocks.sgml
===================================================================
RCS file: /projects/cvsroot/pgsql/doc/src/sgml/pgrowlocks.sgml,v
retrieving revision 1.2
diff -c -r1.2 pgrowlocks.sgml
*** pgrowlocks.sgml 11 Nov 2007 14:23:18 -0000 1.2
--- pgrowlocks.sgml 2 Dec 2007 23:32:29 -0000
***************
*** 102,108 ****
<sect2>
<title>Example</title>
<para>
! <literal>pgrowlocks</literal> returns the following data type:
</para>
<para>
Here is a sample execution of pgrowlocks:
--- 102,108 ----
<sect2>
<title>Example</title>
<para>
! <literal>pgrowlocks</literal> returns the following columns:
</para>
<para>
Here is a sample execution of pgrowlocks:
Index: standby.sgml
===================================================================
RCS file: /projects/cvsroot/pgsql/doc/src/sgml/Attic/standby.sgml,v
retrieving revision 1.1
diff -c -r1.1 standby.sgml
*** standby.sgml 10 Nov 2007 23:30:46 -0000 1.1
--- standby.sgml 2 Dec 2007 23:32:30 -0000
***************
*** 7,15 ****
</indexterm>
<para>
! <literal>pg_standby</literal> is a production-ready program that can be used
! to create a Warm Standby server. Other configuration is required as well,
! all of which is described in the main server manual.
</para>
<para>
The program is designed to be a wait-for <literal>restore_command</literal>,
--- 7,15 ----
</indexterm>
<para>
! <literal>pg_standby</literal> allows the creation of a Warm Standby server.
! Other configuration is required as well, all of which is described in the
! main server manual.
</para>
<para>
The program is designed to be a wait-for <literal>restore_command</literal>,
***************
*** 18,24 ****
you could configure <literal>pg_standby</literal> in the following way:
</para>
<programlisting>
! restore_command = 'pg_standby archiveDir %f %p'
</programlisting>
<para>
which would be sufficient to define that files will be restored from
--- 18,24 ----
you could configure <literal>pg_standby</literal> in the following way:
</para>
<programlisting>
! restore_command = 'pg_standby archiveDir %f %p %r'
</programlisting>
<para>
which would be sufficient to define that files will be restored from
***************
*** 72,83 ****
with the pg_standby command usage as
</para>
<programlisting>
! pg_standby [OPTION]... [ARCHIVELOCATION] [NEXTWALFILE] [XLOGFILEPATH]
</programlisting>
<para>
When used within the <literal>restore_command</literal> the %f and %p macros
will provide the actual file and path required for the restore/recovery.
</para>
<table>
<title>Options</title>
--- 72,96 ----
with the pg_standby command usage as
</para>
<programlisting>
! pg_standby [OPTION]... ARCHIVELOCATION NEXTWALFILE XLOGFILEPATH [RESTARTWALFILE]
</programlisting>
<para>
When used within the <literal>restore_command</literal> the %f and %p macros
will provide the actual file and path required for the restore/recovery.
</para>
+ <para>
+ </para>
+ <literal>pg_standby</literal> assumes that <literal>ARCHIVELOCATION</literal>
+ is a directory accessible by the server-owning user.
+ </para>
+ <para>
+ If <literal>RESTARTWALFILE</literal> is specified, typically by using the
+ <literal>%r</literal> option, then all files prior to this file will be
+ removed from <literal>ARCHIVELOCATION</literal>. This then minimises the
+ number of files that need to be held, whilst at the same time maintaining
+ restart capability. This capability additionally assumes that
+ <literal>ARCHIVELOCATION</literal> directory is writable.
+ </para>
<table>
<title>Options</title>
***************
*** 95,102 ****
<entry>-k numfiles</entry>
<entry>
<para>
! Cleanup files in the archive so that we maintain no more
! than this many files in the archive.
</para>
<para>
You should be wary against setting this number too low,
--- 108,118 ----
<entry>-k numfiles</entry>
<entry>
<para>
! Cleanup files in the archive so that we maintain no more than this
! many files in the archive. This parameter will be silently ignored if
! <literal>RESTARTWALFILE</literal> is specified, since that
! specification method is more accurate in determining the correct
! cut-off point in archive.
</para>
<para>
You should be wary against setting this number too low,
***************
*** 110,117 ****
--- 126,142 ----
on either primary or standby.
</para>
<para>
+ Setting <literal>numfiles</literal> to be zero will disable deletion
+ of files from <literal>ARCHIVELOCATION</literal>.
+ </para>
+ <para>
If in doubt, use a large value or do not set a value at all.
</para>
+ <para>
+ If you specify neither <literal>RESTARTWALFILE nor -k, then -k 0 will
+ be assumed, i.e. keep all files in archive. <literal>Default=0,
+ Min=0</literal>
+ </para>
</entry>
</row>
<row>
***************
*** 122,130 ****
WAL files will remain in archive
</para>
<para>
! Link is more efficient, but the default is copy to
! allow you to maintain the WAL archive for recovery
! purposes as well as high-availability.
</para>
<para>
This option uses the Windows Vista command mklink
--- 147,156 ----
WAL files will remain in archive
</para>
<para>
! Link is more efficient, but the default is copy to allow you to
! maintain the WAL archive for recovery purposes as well as
! high-availability. The default setting is not necessarily recommended,
! consult the main database server manual for discussion.
</para>
<para>
This option uses the Windows Vista command mklink
***************
*** 145,151 ****
we will wait 5 secs, 10 secs then 15 secs before reporting
the failure back to the database server. This will be
interpreted as and end of recovery and the Standby will come
! up fully as a result. <literal>Default=3</literal>
</para>
</entry>
</row>
--- 171,177 ----
we will wait 5 secs, 10 secs then 15 secs before reporting
the failure back to the database server. This will be
interpreted as and end of recovery and the Standby will come
! up fully as a result. <literal>Default=3 Min=0</literal>
</para>
</entry>
</row>
***************
*** 156,162 ****
if the file to be restored is available in the archive yet.
The default setting is not necessarily recommended,
consult the main database server manual for discussion.
! <literal>Default=5</literal>
</entry>
</row>
<row>
--- 182,188 ----
if the file to be restored is available in the archive yet.
The default setting is not necessarily recommended,
consult the main database server manual for discussion.
! <literal>Default=5, Min=1, Max=60</literal>
</entry>
</row>
<row>
***************
*** 176,183 ****
the maximum number of seconds to wait for the next file,
after which recovery will end and the Standby will come up.
The default setting is not necessarily recommended,
! consult the main database server manual for discussion.
! <literal>Default=0</literal>
</entry>
</row>
</tbody>
--- 202,210 ----
the maximum number of seconds to wait for the next file,
after which recovery will end and the Standby will come up.
The default setting is not necessarily recommended,
! consult the main database server manual for discussion. A setting of
! zero means wait forever.
! <literal>Default=0, Min=0</literal>
</entry>
</row>
</tbody>
***************
*** 193,198 ****
--- 220,251 ----
</sect2>
<sect2>
+ <title>Supported versions</title>
+ <para>
+ <literal>pg_standby</literal> is designed to work with PostgreSQL 8.2 and
+ and later. It is currently compatible across minor changes between the way
+ 8.3 and 8.2 operate.
+ </para>
+ <para>
+ PostgreSQL 8.3 provides the <literal>%r</literal> command line substitution,
+ designed to let <literal>pg_standby</literal> know the last file it needs to
+ keep. If the last parameter is omitted, no error is generated, allowing
+ <literal>pg_standby</literal> to function correctly with PostgreSQL 8.2
+ also. With PostgreSQL 8.2, the <literal>-k</literal> option must be used if
+ archive cleanup is required. This option remains available in 8.3.
+ </para>
+ </sect2>
+
+ <sect2>
+ <title>Additional design notes</title>
+ <para>
+ The use of a move command seems like it would be a good idea, but this would
+ prevent recovery from being restartable. Also, the last WAL file is always
+ requested twice from the archive.
+ </para>
+ </sect2>
+
+ <sect2>
<title>Examples</title>
<itemizedlist>
***************
*** 228,235 ****
*not* in the restore_command, in 8.2, 8.1, 8.0 on Windows.
</para>
<programlisting>
! restore_command = 'pg_standby -c -d -s 5 -w 0 -t C:\pgsql.trigger.5442
! ..\archive %f %p 2>> standby.log'
</programlisting>
<para>
which will
--- 281,287 ----
*not* in the restore_command, in 8.2, 8.1, 8.0 on Windows.
</para>
<programlisting>
! restore_command = 'pg_standby -c -d -s 5 -w 0 -t C:\pgsql.trigger.5442 ..\archive %f %p 2>> standby.log'
</programlisting>
<para>
which will
* Re: About contrib modules
@ 2007-12-03 03:08 Tom Lane <tgl@sss.pgh.pa.us>
parent: Albert Cervera i Areny <albert@nan-tic.com>
0 siblings, 1 reply; 7+ messages in thread
From: Tom Lane @ 2007-12-03 03:08 UTC (permalink / raw)
To: Albert Cervera i Areny <albert@nan-tic.com>; +Cc: Bruce Momjian <bruce@momjian.us>; pgsql-docs
Albert Cervera i Areny <albert@nan-tic.com> writes:
> Attached, contrib docs with the changes of the last months. Had to update
> cube, apart from most modules of Tom's list. Everything should be up to date
> now.
Applied, thanks.
Are you planning to do any further work on the contrib docs? I'm
interested in making an editorial pass over them in the next day or two,
but I don't want to create merge conflicts for you if you are about to
do more work.
regards, tom lane
^ permalink raw reply [nested|flat] 7+ messages in thread
* Re: About contrib modules
@ 2007-12-03 14:42 Albert Cervera i Areny <albert@nan-tic.com>
parent: Tom Lane <tgl@sss.pgh.pa.us>
0 siblings, 0 replies; 7+ messages in thread
From: Albert Cervera i Areny @ 2007-12-03 14:42 UTC (permalink / raw)
To: Tom Lane <tgl@sss.pgh.pa.us>; +Cc: Bruce Momjian <bruce@momjian.us>; pgsql-docs
A Dilluns 03 Desembre 2007, Tom Lane va escriure:
> Are you planning to do any further work on the contrib docs? I'm
I don't have any further work planned by now. Please, go on with the changes..
--
Albert Cervera i Areny
http://www.NaN-tic.com
^ permalink raw reply [nested|flat] 7+ messages in thread
end of thread, other threads:[~2007-12-03 14:42 UTC | newest]
Thread overview: 7+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2007-11-22 09:08 About contrib modules albert@nan-tic.com
2007-11-22 16:23 ` Bruce Momjian <bruce@momjian.us>
2007-12-02 17:34 ` Albert Cervera i Areny <albert@nan-tic.com>
2007-12-02 21:17 ` Tom Lane <tgl@sss.pgh.pa.us>
2007-12-02 23:36 ` Albert Cervera i Areny <albert@nan-tic.com>
2007-12-03 03:08 ` Tom Lane <tgl@sss.pgh.pa.us>
2007-12-03 14:42 ` Albert Cervera i Areny <albert@nan-tic.com>
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox