rdelaage
/
postgresql
mirror of https://git.postgresql.org/git/postgresql.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
postgresql/doc/src/sgml/contrib.sgml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

237 lines
7.4 KiB
Plaintext
Raw Normal View History

Remove cvs keywords from all files.
2010-09-20 22:08:53 +02:00
<!-- doc/src/sgml/contrib.sgml -->
Move contrib docs to an appendix (next door to External Projects). Change title to Additional Supplied Modules. Improve discussion of how to build and install 'em.
2007-11-14 03:36:43 +01:00
<appendix id="contrib">
Describe each contrib module in its SGML section title The original titles only had the module name, which is not very useful when scanning the list. By adding a very brief description to each title, the table of contents becomes friendlier. Also amend the introduction in the "additional modules" appendix, using the word "Extension" more extensively. Nowadays, almost all contrib modules are extensions, so this is also helpful. Author: Karl O. Pinc <kop@karlpinc.com> Reviewed-by: Brar Piening <brar@gmx.de> Discussion: https://postgr.es/m/20230102180015.372995a9@slate.karlpinc.com
2023-01-20 20:01:59 +01:00
<title>Additional Supplied Modules and Extensions</title>
Move most /contrib README files into SGML. Some still need conversion or will never be converted.
2007-11-11 00:30:46 +01:00
<para>
Describe each contrib module in its SGML section title The original titles only had the module name, which is not very useful when scanning the list. By adding a very brief description to each title, the table of contents becomes friendlier. Also amend the introduction in the "additional modules" appendix, using the word "Extension" more extensively. Nowadays, almost all contrib modules are extensions, so this is also helpful. Author: Karl O. Pinc <kop@karlpinc.com> Reviewed-by: Brar Piening <brar@gmx.de> Discussion: https://postgr.es/m/20230102180015.372995a9@slate.karlpinc.com
2023-01-20 20:01:59 +01:00
This appendix and the next one contain information on the
optional components
found in the <literal>contrib</literal> directory of the
Don't use SGML empty tags For DocBook XML compatibility, don't use SGML empty tags (</>) anymore, replace by the full tag name. Add a warning option to catch future occurrences. Alexander Lakhin, Jürgen Purtz
2017-10-09 03:44:17 +02:00
<productname>PostgreSQL</productname> distribution.
Move contrib docs to an appendix (next door to External Projects). Change title to Additional Supplied Modules. Improve discussion of how to build and install 'em.
2007-11-14 03:36:43 +01:00
These include porting tools, analysis utilities,
Describe each contrib module in its SGML section title The original titles only had the module name, which is not very useful when scanning the list. By adding a very brief description to each title, the table of contents becomes friendlier. Also amend the introduction in the "additional modules" appendix, using the word "Extension" more extensively. Nowadays, almost all contrib modules are extensions, so this is also helpful. Author: Karl O. Pinc <kop@karlpinc.com> Reviewed-by: Brar Piening <brar@gmx.de> Discussion: https://postgr.es/m/20230102180015.372995a9@slate.karlpinc.com
2023-01-20 20:01:59 +01:00
and plug-in features that are not part of the core PostgreSQL system.
They are separate mainly
because they address a limited audience or are too experimental
Move most /contrib README files into SGML. Some still need conversion or will never be converted.
2007-11-11 00:30:46 +01:00
to be part of the main source tree. This does not preclude their
usefulness.
</para>
<para>
Describe each contrib module in its SGML section title The original titles only had the module name, which is not very useful when scanning the list. By adding a very brief description to each title, the table of contents becomes friendlier. Also amend the introduction in the "additional modules" appendix, using the word "Extension" more extensively. Nowadays, almost all contrib modules are extensions, so this is also helpful. Author: Karl O. Pinc <kop@karlpinc.com> Reviewed-by: Brar Piening <brar@gmx.de> Discussion: https://postgr.es/m/20230102180015.372995a9@slate.karlpinc.com
2023-01-20 20:01:59 +01:00
This appendix covers extensions and other server plug-in module
libraries found in
Convert documentation to DocBook XML Since some preparation work had already been done, the only source changes left were changing empty-element tags like <xref linkend="foo"> to <xref linkend="foo"/>, and changing the DOCTYPE. The source files are still named *.sgml, but they are actually XML files now. Renaming could be considered later. In the build system, the intermediate step to convert from SGML to XML is removed. Everything is build straight from the source files again. The OpenSP (or the old SP) package is no longer needed. The documentation toolchain instructions are updated and are much simpler now. Peter Eisentraut, Alexander Lakhin, Jürgen Purtz
2017-11-23 15:39:47 +01:00
<literal>contrib</literal>. <xref linkend="contrib-prog"/> covers utility
Split contrib documentation into extensions and programs Create separate appendixes for contrib extensions and other server plugins on the one hand, and utility programs on the other. Recast the documentation of the latter as refentries, so that man pages are generated.
2012-05-09 19:39:53 +02:00
programs.
</para>
<para>
Describe each contrib module in its SGML section title The original titles only had the module name, which is not very useful when scanning the list. By adding a very brief description to each title, the table of contents becomes friendlier. Also amend the introduction in the "additional modules" appendix, using the word "Extension" more extensively. Nowadays, almost all contrib modules are extensions, so this is also helpful. Author: Karl O. Pinc <kop@karlpinc.com> Reviewed-by: Brar Piening <brar@gmx.de> Discussion: https://postgr.es/m/20230102180015.372995a9@slate.karlpinc.com
2023-01-20 20:01:59 +01:00
When building from the source distribution, these optional
components are not built
Remove useless whitespace at end of lines
2010-11-23 21:27:50 +01:00
automatically, unless you build the "world" target
Convert documentation to DocBook XML Since some preparation work had already been done, the only source changes left were changing empty-element tags like <xref linkend="foo"> to <xref linkend="foo"/>, and changing the DOCTYPE. The source files are still named *.sgml, but they are actually XML files now. Renaming could be considered later. In the build system, the intermediate step to convert from SGML to XML is removed. Everything is build straight from the source files again. The OpenSP (or the old SP) package is no longer needed. The documentation toolchain instructions are updated and are much simpler now. Peter Eisentraut, Alexander Lakhin, Jürgen Purtz
2017-11-23 15:39:47 +01:00
(see <xref linkend="build"/>).
Add new make targets "world", "install-world" and "installcheck-world" to build, install and check just about everything. In addition to everything built installed and tested by all, install and installcheck targets, these build HTML Docs, build and test contrib, and test PLs and ECPG.
2010-01-29 00:59:52 +01:00
You can build and install all of them by running:
Move contrib docs to an appendix (next door to External Projects). Change title to Additional Supplied Modules. Improve discussion of how to build and install 'em.
2007-11-14 03:36:43 +01:00
<screen>
Rename 'gmake' to 'make' in docs and recommended commands This simplifies the docs and makes it easier to cut/paste command lines.
2014-02-12 23:29:19 +01:00
<userinput>make</userinput>
<userinput>make install</userinput>
Move contrib docs to an appendix (next door to External Projects). Change title to Additional Supplied Modules. Improve discussion of how to build and install 'em.
2007-11-14 03:36:43 +01:00
</screen>
in the <literal>contrib</literal> directory of a configured source tree;
or to build and install
just one selected module, do the same in that module's subdirectory.
Many of the modules have regression tests, which can be executed by
Proofreading adjustments for first two parts of documentation (Tutorial and SQL).
2009-04-27 18:27:36 +02:00
running:
Move contrib docs to an appendix (next door to External Projects). Change title to Additional Supplied Modules. Improve discussion of how to build and install 'em.
2007-11-14 03:36:43 +01:00
<screen>
Rename 'gmake' to 'make' in docs and recommended commands This simplifies the docs and makes it easier to cut/paste command lines.
2014-02-12 23:29:19 +01:00
<userinput>make check</userinput>
Update documentation to say that gmake check in contrib is supported
2012-05-09 19:37:09 +02:00
</screen>
before installation or
<screen>
Rename 'gmake' to 'make' in docs and recommended commands This simplifies the docs and makes it easier to cut/paste command lines.
2014-02-12 23:29:19 +01:00
<userinput>make installcheck</userinput>
Move contrib docs to an appendix (next door to External Projects). Change title to Additional Supplied Modules. Improve discussion of how to build and install 'em.
2007-11-14 03:36:43 +01:00
</screen>
Don't use SGML empty tags For DocBook XML compatibility, don't use SGML empty tags (</>) anymore, replace by the full tag name. Add a warning option to catch future occurrences. Alexander Lakhin, Jürgen Purtz
2017-10-09 03:44:17 +02:00
once you have a <productname>PostgreSQL</productname> server running.
Move contrib docs to an appendix (next door to External Projects). Change title to Additional Supplied Modules. Improve discussion of how to build and install 'em.
2007-11-14 03:36:43 +01:00
</para>
<para>
Don't use SGML empty tags For DocBook XML compatibility, don't use SGML empty tags (</>) anymore, replace by the full tag name. Add a warning option to catch future occurrences. Alexander Lakhin, Jürgen Purtz
2017-10-09 03:44:17 +02:00
If you are using a pre-packaged version of <productname>PostgreSQL</productname>,
Describe each contrib module in its SGML section title The original titles only had the module name, which is not very useful when scanning the list. By adding a very brief description to each title, the table of contents becomes friendlier. Also amend the introduction in the "additional modules" appendix, using the word "Extension" more extensively. Nowadays, almost all contrib modules are extensions, so this is also helpful. Author: Karl O. Pinc <kop@karlpinc.com> Reviewed-by: Brar Piening <brar@gmx.de> Discussion: https://postgr.es/m/20230102180015.372995a9@slate.karlpinc.com
2023-01-20 20:01:59 +01:00
these components are typically made available as a separate subpackage,
Don't use SGML empty tags For DocBook XML compatibility, don't use SGML empty tags (</>) anymore, replace by the full tag name. Add a warning option to catch future occurrences. Alexander Lakhin, Jürgen Purtz
2017-10-09 03:44:17 +02:00
such as <literal>postgresql-contrib</literal>.
Move contrib docs to an appendix (next door to External Projects). Change title to Additional Supplied Modules. Improve discussion of how to build and install 'em.
2007-11-14 03:36:43 +01:00
</para>
<para>
Describe each contrib module in its SGML section title The original titles only had the module name, which is not very useful when scanning the list. By adding a very brief description to each title, the table of contents becomes friendlier. Also amend the introduction in the "additional modules" appendix, using the word "Extension" more extensively. Nowadays, almost all contrib modules are extensions, so this is also helpful. Author: Karl O. Pinc <kop@karlpinc.com> Reviewed-by: Brar Piening <brar@gmx.de> Discussion: https://postgr.es/m/20230102180015.372995a9@slate.karlpinc.com
2023-01-20 20:01:59 +01:00
Many components supply new user-defined functions, operators, or types,
packaged as <firstterm>extensions</firstterm>.
To make use of one of these extensions, after you have installed the code
Fix obsolete references to old-style contrib installation methods.
2011-02-14 07:10:44 +01:00
you need to register the new SQL objects in the database system.
Mark some contrib modules as "trusted". This allows these modules to be installed into a database without superuser privileges (assuming that the DBA or sysadmin has installed the module's files in the expected place). You only need CREATE privilege on the current database, which by default would be available to the database owner. The following modules are marked trusted: btree_gin btree_gist citext cube dict_int earthdistance fuzzystrmatch hstore hstore_plperl intarray isn jsonb_plperl lo ltree pg_trgm pgcrypto seg tablefunc tcn tsm_system_rows tsm_system_time unaccent uuid-ossp In the future we might mark some more modules trusted, but there seems to be no debate about these, and on the whole it seems wise to be conservative with use of this feature to start out with. Discussion: https://postgr.es/m/32315.1580326876@sss.pgh.pa.us
2020-02-13 21:02:35 +01:00
This is done by executing
Convert documentation to DocBook XML Since some preparation work had already been done, the only source changes left were changing empty-element tags like <xref linkend="foo"> to <xref linkend="foo"/>, and changing the DOCTYPE. The source files are still named *.sgml, but they are actually XML files now. Renaming could be considered later. In the build system, the intermediate step to convert from SGML to XML is removed. Everything is build straight from the source files again. The OpenSP (or the old SP) package is no longer needed. The documentation toolchain instructions are updated and are much simpler now. Peter Eisentraut, Alexander Lakhin, Jürgen Purtz
2017-11-23 15:39:47 +01:00
a <xref linkend="sql-createextension"/> command. In a fresh database,
Fix obsolete references to old-style contrib installation methods.
2011-02-14 07:10:44 +01:00
you can simply do
Move contrib docs to an appendix (next door to External Projects). Change title to Additional Supplied Modules. Improve discussion of how to build and install 'em.
2007-11-14 03:36:43 +01:00
<programlisting>
Describe each contrib module in its SGML section title The original titles only had the module name, which is not very useful when scanning the list. By adding a very brief description to each title, the table of contents becomes friendlier. Also amend the introduction in the "additional modules" appendix, using the word "Extension" more extensively. Nowadays, almost all contrib modules are extensions, so this is also helpful. Author: Karl O. Pinc <kop@karlpinc.com> Reviewed-by: Brar Piening <brar@gmx.de> Discussion: https://postgr.es/m/20230102180015.372995a9@slate.karlpinc.com
2023-01-20 20:01:59 +01:00
CREATE EXTENSION <replaceable>extension_name</replaceable>;
Move contrib docs to an appendix (next door to External Projects). Change title to Additional Supplied Modules. Improve discussion of how to build and install 'em.
2007-11-14 03:36:43 +01:00
</programlisting>
Mark some contrib modules as "trusted". This allows these modules to be installed into a database without superuser privileges (assuming that the DBA or sysadmin has installed the module's files in the expected place). You only need CREATE privilege on the current database, which by default would be available to the database owner. The following modules are marked trusted: btree_gin btree_gist citext cube dict_int earthdistance fuzzystrmatch hstore hstore_plperl intarray isn jsonb_plperl lo ltree pg_trgm pgcrypto seg tablefunc tcn tsm_system_rows tsm_system_time unaccent uuid-ossp In the future we might mark some more modules trusted, but there seems to be no debate about these, and on the whole it seems wise to be conservative with use of this feature to start out with. Discussion: https://postgr.es/m/32315.1580326876@sss.pgh.pa.us
2020-02-13 21:02:35 +01:00
This command registers the new SQL objects in the current database only,
Describe each contrib module in its SGML section title The original titles only had the module name, which is not very useful when scanning the list. By adding a very brief description to each title, the table of contents becomes friendlier. Also amend the introduction in the "additional modules" appendix, using the word "Extension" more extensively. Nowadays, almost all contrib modules are extensions, so this is also helpful. Author: Karl O. Pinc <kop@karlpinc.com> Reviewed-by: Brar Piening <brar@gmx.de> Discussion: https://postgr.es/m/20230102180015.372995a9@slate.karlpinc.com
2023-01-20 20:01:59 +01:00
so you need to run it in every database in which you want
the extension's facilities to be available. Alternatively, run it in
Don't use SGML empty tags For DocBook XML compatibility, don't use SGML empty tags (</>) anymore, replace by the full tag name. Add a warning option to catch future occurrences. Alexander Lakhin, Jürgen Purtz
2017-10-09 03:44:17 +02:00
database <literal>template1</literal> so that the extension will be copied into
Move contrib docs to an appendix (next door to External Projects). Change title to Additional Supplied Modules. Improve discussion of how to build and install 'em.
2007-11-14 03:36:43 +01:00
subsequently-created databases by default.
</para>
Mark some contrib modules as "trusted". This allows these modules to be installed into a database without superuser privileges (assuming that the DBA or sysadmin has installed the module's files in the expected place). You only need CREATE privilege on the current database, which by default would be available to the database owner. The following modules are marked trusted: btree_gin btree_gist citext cube dict_int earthdistance fuzzystrmatch hstore hstore_plperl intarray isn jsonb_plperl lo ltree pg_trgm pgcrypto seg tablefunc tcn tsm_system_rows tsm_system_time unaccent uuid-ossp In the future we might mark some more modules trusted, but there seems to be no debate about these, and on the whole it seems wise to be conservative with use of this feature to start out with. Discussion: https://postgr.es/m/32315.1580326876@sss.pgh.pa.us
2020-02-13 21:02:35 +01:00
<para>
Describe each contrib module in its SGML section title The original titles only had the module name, which is not very useful when scanning the list. By adding a very brief description to each title, the table of contents becomes friendlier. Also amend the introduction in the "additional modules" appendix, using the word "Extension" more extensively. Nowadays, almost all contrib modules are extensions, so this is also helpful. Author: Karl O. Pinc <kop@karlpinc.com> Reviewed-by: Brar Piening <brar@gmx.de> Discussion: https://postgr.es/m/20230102180015.372995a9@slate.karlpinc.com
2023-01-20 20:01:59 +01:00
For all extensions, the <command>CREATE EXTENSION</command> command must be
run by a database superuser, unless the extension is
considered <quote>trusted</quote>. Trusted extensions can be run by any
Mark some contrib modules as "trusted". This allows these modules to be installed into a database without superuser privileges (assuming that the DBA or sysadmin has installed the module's files in the expected place). You only need CREATE privilege on the current database, which by default would be available to the database owner. The following modules are marked trusted: btree_gin btree_gist citext cube dict_int earthdistance fuzzystrmatch hstore hstore_plperl intarray isn jsonb_plperl lo ltree pg_trgm pgcrypto seg tablefunc tcn tsm_system_rows tsm_system_time unaccent uuid-ossp In the future we might mark some more modules trusted, but there seems to be no debate about these, and on the whole it seems wise to be conservative with use of this feature to start out with. Discussion: https://postgr.es/m/32315.1580326876@sss.pgh.pa.us
2020-02-13 21:02:35 +01:00
user who has <literal>CREATE</literal> privilege on the current
Describe each contrib module in its SGML section title The original titles only had the module name, which is not very useful when scanning the list. By adding a very brief description to each title, the table of contents becomes friendlier. Also amend the introduction in the "additional modules" appendix, using the word "Extension" more extensively. Nowadays, almost all contrib modules are extensions, so this is also helpful. Author: Karl O. Pinc <kop@karlpinc.com> Reviewed-by: Brar Piening <brar@gmx.de> Discussion: https://postgr.es/m/20230102180015.372995a9@slate.karlpinc.com
2023-01-20 20:01:59 +01:00
database. Extensions that are trusted are identified as such in the
sections that follow. Generally, trusted extensions are ones that cannot
Mark some contrib modules as "trusted". This allows these modules to be installed into a database without superuser privileges (assuming that the DBA or sysadmin has installed the module's files in the expected place). You only need CREATE privilege on the current database, which by default would be available to the database owner. The following modules are marked trusted: btree_gin btree_gist citext cube dict_int earthdistance fuzzystrmatch hstore hstore_plperl intarray isn jsonb_plperl lo ltree pg_trgm pgcrypto seg tablefunc tcn tsm_system_rows tsm_system_time unaccent uuid-ossp In the future we might mark some more modules trusted, but there seems to be no debate about these, and on the whole it seems wise to be conservative with use of this feature to start out with. Discussion: https://postgr.es/m/32315.1580326876@sss.pgh.pa.us
2020-02-13 21:02:35 +01:00
provide access to outside-the-database functionality.
</para>
doc: Add lists of modules trusted/obsolete Author: Karl Pinc <kop@karlpinc.com> Discussion: https://postgr.es/m/20230102180015.372995a9@slate.karlpinc.com
2023-03-15 09:32:44 +01:00
<para id="contrib-trusted-extensions">
The following extensions are trusted in a default installation:
<simplelist type="vert" columns="4">
<member><xref linkend="btree-gin"/></member>
<member><xref linkend="btree-gist"/></member>
<member><xref linkend="citext"/></member>
<member><xref linkend="cube"/></member>
<member><xref linkend="dict-int"/></member>
<member><xref linkend="fuzzystrmatch"/></member>
<member><xref linkend="hstore"/></member>
<member><xref linkend="intarray"/></member>
<member><xref linkend="isn"/></member>
<member><xref linkend="lo"/></member>
<member><xref linkend="ltree"/></member>
<member><xref linkend="pgcrypto"/></member>
<member><xref linkend="pgtrgm"/></member>
<member><xref linkend="seg"/></member>
<member><xref linkend="tablefunc"/></member>
<member><xref linkend="tcn"/></member>
<member><xref linkend="tsm-system-rows"/></member>
<member><xref linkend="tsm-system-time"/></member>
<member><xref linkend="unaccent"/></member>
<member><xref linkend="uuid-ossp"/></member>
</simplelist>
</para>
Move contrib docs to an appendix (next door to External Projects). Change title to Additional Supplied Modules. Improve discussion of how to build and install 'em.
2007-11-14 03:36:43 +01:00
<para>
Describe each contrib module in its SGML section title The original titles only had the module name, which is not very useful when scanning the list. By adding a very brief description to each title, the table of contents becomes friendlier. Also amend the introduction in the "additional modules" appendix, using the word "Extension" more extensively. Nowadays, almost all contrib modules are extensions, so this is also helpful. Author: Karl O. Pinc <kop@karlpinc.com> Reviewed-by: Brar Piening <brar@gmx.de> Discussion: https://postgr.es/m/20230102180015.372995a9@slate.karlpinc.com
2023-01-20 20:01:59 +01:00
Many extensions allow you to install their objects in a schema of your
Fix obsolete references to old-style contrib installation methods.
2011-02-14 07:10:44 +01:00
choice. To do that, add <literal>SCHEMA
Don't use SGML empty tags For DocBook XML compatibility, don't use SGML empty tags (</>) anymore, replace by the full tag name. Add a warning option to catch future occurrences. Alexander Lakhin, Jürgen Purtz
2017-10-09 03:44:17 +02:00
<replaceable>schema_name</replaceable></literal> to the <command>CREATE EXTENSION</command>
Fix obsolete references to old-style contrib installation methods.
2011-02-14 07:10:44 +01:00
command. By default, the objects will be placed in your current creation
Document security implications of search_path and the public schema. The ability to create like-named objects in different schemas opens up the potential for users to change the behavior of other users' queries, maliciously or accidentally. When you connect to a PostgreSQL server, you should remove from your search_path any schema for which a user other than yourself or superusers holds the CREATE privilege. If you do not, other users holding CREATE privilege can redefine the behavior of your commands, causing them to perform arbitrary SQL statements under your identity. "SET search_path = ..." and "SELECT pg_catalog.set_config(...)" are not vulnerable to such hijacking, so one can use either as the first command of a session. As special exceptions, the following client applications behave as documented regardless of search_path settings and schema privileges: clusterdb createdb createlang createuser dropdb droplang dropuser ecpg (not programs it generates) initdb oid2name pg_archivecleanup pg_basebackup pg_config pg_controldata pg_ctl pg_dump pg_dumpall pg_isready pg_receivewal pg_recvlogical pg_resetwal pg_restore pg_rewind pg_standby pg_test_fsync pg_test_timing pg_upgrade pg_waldump reindexdb vacuumdb vacuumlo. Not included are core client programs that run user-specified SQL commands, namely psql and pgbench. PostgreSQL encourages non-core client applications to do likewise. Document this in the context of libpq connections, psql connections, dblink connections, ECPG connections, extension packaging, and schema usage patterns. The principal defense for applications is "SELECT pg_catalog.set_config('search_path', '', false)", and the principal defense for databases is "REVOKE CREATE ON SCHEMA public FROM PUBLIC". Either one is sufficient to prevent attack. After a REVOKE, consider auditing the public schema for objects named like pg_catalog objects. Authors of SECURITY DEFINER functions use some of the same defenses, and the CREATE FUNCTION reference page already covered them thoroughly. This is a good opportunity to audit SECURITY DEFINER functions for robust security practice. Back-patch to 9.3 (all supported versions). Reviewed by Michael Paquier and Jonathan S. Katz. Reported by Arseniy Sharoglazov. Security: CVE-2018-1058
2018-02-26 16:39:44 +01:00
target schema, which in turn defaults to <literal>public</literal>.
Move contrib docs to an appendix (next door to External Projects). Change title to Additional Supplied Modules. Improve discussion of how to build and install 'em.
2007-11-14 03:36:43 +01:00
</para>
Split contrib documentation into extensions and programs Create separate appendixes for contrib extensions and other server plugins on the one hand, and utility programs on the other. Recast the documentation of the latter as refentries, so that man pages are generated.
2012-05-09 19:39:53 +02:00
<para>
Describe each contrib module in its SGML section title The original titles only had the module name, which is not very useful when scanning the list. By adding a very brief description to each title, the table of contents becomes friendlier. Also amend the introduction in the "additional modules" appendix, using the word "Extension" more extensively. Nowadays, almost all contrib modules are extensions, so this is also helpful. Author: Karl O. Pinc <kop@karlpinc.com> Reviewed-by: Brar Piening <brar@gmx.de> Discussion: https://postgr.es/m/20230102180015.372995a9@slate.karlpinc.com
2023-01-20 20:01:59 +01:00
Note, however, that some of these components are not <quote>extensions</quote>
Split contrib documentation into extensions and programs Create separate appendixes for contrib extensions and other server plugins on the one hand, and utility programs on the other. Recast the documentation of the latter as refentries, so that man pages are generated.
2012-05-09 19:39:53 +02:00
in this sense, but are loaded into the server in some other way, for instance
by way of
Convert documentation to DocBook XML Since some preparation work had already been done, the only source changes left were changing empty-element tags like <xref linkend="foo"> to <xref linkend="foo"/>, and changing the DOCTYPE. The source files are still named *.sgml, but they are actually XML files now. Renaming could be considered later. In the build system, the intermediate step to convert from SGML to XML is removed. Everything is build straight from the source files again. The OpenSP (or the old SP) package is no longer needed. The documentation toolchain instructions are updated and are much simpler now. Peter Eisentraut, Alexander Lakhin, Jürgen Purtz
2017-11-23 15:39:47 +01:00
<xref linkend="guc-shared-preload-libraries"/>. See the documentation of each
Describe each contrib module in its SGML section title The original titles only had the module name, which is not very useful when scanning the list. By adding a very brief description to each title, the table of contents becomes friendlier. Also amend the introduction in the "additional modules" appendix, using the word "Extension" more extensively. Nowadays, almost all contrib modules are extensions, so this is also helpful. Author: Karl O. Pinc <kop@karlpinc.com> Reviewed-by: Brar Piening <brar@gmx.de> Discussion: https://postgr.es/m/20230102180015.372995a9@slate.karlpinc.com
2023-01-20 20:01:59 +01:00
component for details.
Split contrib documentation into extensions and programs Create separate appendixes for contrib extensions and other server plugins on the one hand, and utility programs on the other. Recast the documentation of the latter as refentries, so that man pages are generated.
2012-05-09 19:39:53 +02:00
</para>
Add amcheck extension to contrib. This is the beginning of a collection of SQL-callable functions to verify the integrity of data files. For now it only contains code to verify B-Tree indexes. This adds two SQL-callable functions, validating B-Tree consistency to a varying degree. Check the, extensive, docs for details. The goal is to later extend the coverage of the module to further access methods, possibly including the heap. Once checks for additional access methods exist, we'll likely add some "dispatch" functions that cover multiple access methods. Author: Peter Geoghegan, editorialized by Andres Freund Reviewed-By: Andres Freund, Tomas Vondra, Thomas Munro, Anastasia Lubennikova, Robert Haas, Amit Langote Discussion: CAM3SWZQzLMhMwmBqjzK+pRKXrNUZ4w90wYMUWfkeV8mZ3Debvw@mail.gmail.com
2017-03-10 00:50:40 +01:00
&amcheck;
New contrib module, auth_delay. KaiGai Kohei, with a few changes by me.
2010-11-27 13:22:25 +01:00
&auth-delay;
Add auto-explain contrib module for automatic logging of the plans of slow-running queries. Takahiro Itagaki
2008-11-19 03:59:28 +01:00
&auto-explain;
Add 'basebackup_to_shell' contrib module. As a demonstration of the sort of thing that can be done by adding a custom backup target, this defines a 'shell' target which executes a command defined by the system administrator. The command is executed once for each tar archive generate by the backup and once for the backup manifest, if any. Each time the command is executed, it receives the contents of th file for which it is executed via standard input. The configured command can use %f to refer to the name of the archive (e.g. base.tar, $TABLESPACE_OID.tar, backup_manifest) and %d to refer to the target detail (pg_basebackup --target shell:DETAIL). A target detail is required if %d appears in the configured command and forbidden if it does not. Patch by me, reviewed by Abhijit Menon-Sen. Discussion: http://postgr.es/m/CA+TgmoaqvdT-u3nt+_kkZ7bgDAyqDB0i-+XOMmr5JN2Rd37hxw@mail.gmail.com
2022-03-15 18:24:23 +01:00
&basebackup-to-shell;
Revert "Rename contrib module basic_archive to basic_wal_module" This reverts commit 0ad3c60, as per feedback from Tom Lane, Robert Haas and Andres Freund. The new name used for the module had little support. This moves back to basic_archive as module name, and we will likely use that as template for recovery modules, as well. Discussion: https://postgr.es/m/CA+TgmoYG5uGOp7DGFT5gzC1kKFWGjkLSj_wOQxGhfMcvVEiKGA@mail.gmail.com
2023-01-26 01:13:39 +01:00
&basic-archive;
Bloom index contrib module Module provides new access method. It is actually a simple Bloom filter implemented as pgsql's index. It could give some benefits on search with large number of columns. Module is a single way to test generic WAL interface committed earlier. Author: Teodor Sigaev, Alexander Korotkov Reviewers: Aleksander Alekseev, Michael Paquier, Jim Nasby
2016-04-01 15:42:24 +02:00
&bloom;
Add btree_gin contrib module. Teodor Sigaev and Oleg Bartunov
2009-03-26 00:20:01 +01:00
&btree-gin;
Move most /contrib README files into SGML. Some still need conversion or will never be converted.
2007-11-11 00:30:46 +01:00
&btree-gist;
Add a new, improved version of citext as a contrib module. David E. Wheeler
2008-07-29 20:31:20 +02:00
&citext;
Move most /contrib README files into SGML. Some still need conversion or will never be converted.
2007-11-11 00:30:46 +01:00
&cube;
&dblink;
Add SGML docs for contrib/dict_int and contrib/dict_xsyn. Albert Cervera i Areny
2007-12-02 22:13:34 +01:00
&dict-int;
&dict-xsyn;
Move most /contrib README files into SGML. Some still need conversion or will never be converted.
2007-11-11 00:30:46 +01:00
&earthdistance;
Add contrib/file_fdw foreign-data wrapper for reading files via COPY. This is both very useful in its own right, and an important test case for the core FDW support. This commit includes a small refactoring of copy.c to expose its option checking code as a separately callable function. The original patch submission duplicated hundreds of lines of that code, which seemed pretty unmaintainable. Shigeru Hanada, reviewed by Itagaki Takahiro and Tom Lane
2011-02-20 20:06:59 +01:00
&file-fdw;
Move most /contrib README files into SGML. Some still need conversion or will never be converted.
2007-11-11 00:30:46 +01:00
&fuzzystrmatch;
&hstore;
&intagg;
&intarray;
&isn;
&lo;
&ltree;
&pageinspect;
Add a hook to CREATE/ALTER ROLE to allow an external module to check the strength of database passwords, and create a sample implementation of such a hook as a new contrib module "passwordcheck". Laurenz Albe, reviewed by Takahiro Itagaki
2009-11-18 22:57:56 +01:00
&passwordcheck;
Ensure that all <sect1> and <refentry> tags have IDs. This is needed to ensure that the resulting webpages have predictable URLs, instead of ever-changing numeric IDs. The new contrib docs were the biggest offender, but some old stuff had the problem too. Also, rename a couple of new contrib sgml files for consistency's sake.
2007-12-02 23:33:20 +01:00
&pgbuffercache;
Move most /contrib README files into SGML. Some still need conversion or will never be converted.
2007-11-11 00:30:46 +01:00
&pgcrypto;
Ensure that all <sect1> and <refentry> tags have IDs. This is needed to ensure that the resulting webpages have predictable URLs, instead of ever-changing numeric IDs. The new contrib docs were the biggest offender, but some old stuff had the problem too. Also, rename a couple of new contrib sgml files for consistency's sake.
2007-12-02 23:33:20 +01:00
&pgfreespacemap;
pg_prewarm, a contrib module for prewarming relationd data. Patch by me. Review by Álvaro Herrera, Amit Kapila, Jeff Janes, Gurjeet Singh, and others.
2013-12-20 14:08:01 +01:00
&pgprewarm;
Move most /contrib README files into SGML. Some still need conversion or will never be converted.
2007-11-11 00:30:46 +01:00
&pgrowlocks;
Add contrib/pg_stat_statements for server-wide tracking of statement execution statistics. Takahiro Itagaki
2009-01-04 23:19:59 +01:00
&pgstatstatements;
Move most /contrib README files into SGML. Some still need conversion or will never be converted.
2007-11-11 00:30:46 +01:00
&pgstattuple;
New contrib module, pg_surgery, with heap surgery functions. Sometimes it happens that the visibility information for a tuple becomes corrupted, either due to bugs in the database software or external factors. Provide a function heap_force_kill() that can be used to truncate such dead tuples to dead line pointers, and a function heap_force_freeze() that can be used to overwrite the visibility information in such a way that the tuple becomes all-visible. These functions are unsafe, in that you can easily use them to corrupt a database that was not previously corrupted, and you can use them to further corrupt an already-corrupted database or to destroy data. The documentation accordingly cautions against casual use. However, in some cases they permit recovery of data that would otherwise be very difficult to recover, or to allow a system to continue to function when it would otherwise be difficult to do so. Because we may want to add other functions for performing other kinds of surgery in the future, the new contrib module is called pg_surgery rather than something specific to these functions. I proposed back-patching this so that it could be more easily used by people running existing releases who are facing these kinds of problems, but that proposal did not attract enough support, so no back-patch for now. Ashutosh Sharma, reviewed and tested by Andrey M. Borodin, M. Beena Emerson, Masahiko Sawada, Rajkumar Raghuwanshi, Asim Praveen, and Mark Dilger, and somewhat revised by me. Discussion: http://postgr.es/m/CA+TgmoZW1fsU-QUNCRUQMGUygBDPVeOTLCqRdQZch=EYZnctSA@mail.gmail.com
2020-09-10 17:10:55 +02:00
&pgsurgery;
Ensure that all <sect1> and <refentry> tags have IDs. This is needed to ensure that the resulting webpages have predictable URLs, instead of ever-changing numeric IDs. The new contrib docs were the biggest offender, but some old stuff had the problem too. Also, rename a couple of new contrib sgml files for consistency's sake.
2007-12-02 23:33:20 +01:00
&pgtrgm;
Add pg_visibility contrib module. This lets you examine the visibility map as well as page-level visibility information. I initially wrote it as a debugging aid, but was encouraged to polish it for commit. Patch by me, reviewed by Masahiko Sawada. Discussion: 56D77803.6080503@BlueTreble.com
2016-03-08 14:38:50 +01:00
&pgvisibility;
Add contrib/pg_walinspect. Provides similar functionality to pg_waldump, but from a SQL interface rather than a separate utility. Author: Bharath Rupireddy Reviewed-by: Greg Stark, Kyotaro Horiguchi, Andres Freund, Ashutosh Sharma, Nitin Jadhav, RKN Sai Krishna Discussion: https://postgr.es/m/CALj2ACUGUYXsEQdKhEdsBzhGEyF3xggvLdD8C0VT72TNEfOiog%40mail.gmail.com
2022-04-08 09:02:10 +02:00
&pgwalinspect;
Add postgres_fdw contrib module. There's still a lot of room for improvement, but it basically works, and we need this to be present before we can do anything much with the writable-foreign-tables patch. So let's commit it and get on with testing. Shigeru Hanada, reviewed by KaiGai Kohei and Tom Lane
2013-02-21 11:26:23 +01:00
&postgres-fdw;
Move most /contrib README files into SGML. Some still need conversion or will never be converted.
2007-11-11 00:30:46 +01:00
&seg;
sepgsql, an SE-Linux integration for PostgreSQL This is still pretty rough - among other things, the documentation needs work, and the messages need a visit from the style police - but this gets the basic framework in place. KaiGai Kohei
2011-01-24 02:44:48 +01:00
&sepgsql;
Add SGML documentation for contrib/spi and contrib/test_parser. The spi documentation is pretty rudimentary, but it's a start.
2007-12-03 05:18:47 +01:00
&contrib-spi;
Move most /contrib README files into SGML. Some still need conversion or will never be converted.
2007-11-11 00:30:46 +01:00
&sslinfo;
&tablefunc;
Triggered change notifications. Kevin Grittner, reviewed (in earlier versions) by Álvaro Herrera
2012-01-20 05:15:15 +01:00
&tcn;
Introduce logical decoding. This feature, building on previous commits, allows the write-ahead log stream to be decoded into a series of logical changes; that is, inserts, updates, and deletes and the transactions which contain them. It is capable of handling decoding even across changes to the schema of the effected tables. The output format is controlled by a so-called "output plugin"; an example is included. To make use of this in a real replication system, the output plugin will need to be modified to produce output in the format appropriate to that system, and to perform filtering. Currently, information can be extracted from the logical decoding system only via SQL; future commits will add the ability to stream changes via walsender. Andres Freund, with review and other contributions from many other people, including Álvaro Herrera, Abhijit Menon-Sen, Peter Gheogegan, Kevin Grittner, Robert Haas, Heikki Linnakangas, Fujii Masao, Abhijit Menon-Sen, Michael Paquier, Simon Riggs, Craig Ringer, and Steve Singer.
2014-03-03 22:32:18 +01:00
&test-decoding;
TABLESAMPLE system_rows(limit) Contrib module implementing a tablesample method that allows you to limit the sample by a hard row limit. Petr Jelinek Reviewed by Michael Paquier, Amit Kapila and Simon Riggs
2015-05-15 21:14:22 +02:00
&tsm-system-rows;
TABLESAMPLE system_time(limit) Contrib module implementing a tablesample method that allows you to limit the sample by a hard time limit. Petr Jelinek Reviewed by Michael Paquier, Amit Kapila and Simon Riggs
2015-05-15 21:18:57 +02:00
&tsm-system-time;
Unaccent dictionary.
2009-08-18 12:34:39 +02:00
&unaccent;
Move most /contrib README files into SGML. Some still need conversion or will never be converted.
2007-11-11 00:30:46 +01:00
&uuid-ossp;
&xml2;
Move contrib docs to an appendix (next door to External Projects). Change title to Additional Supplied Modules. Improve discussion of how to build and install 'em.
2007-11-14 03:36:43 +01:00
</appendix>
Split contrib documentation into extensions and programs Create separate appendixes for contrib extensions and other server plugins on the one hand, and utility programs on the other. Recast the documentation of the latter as refentries, so that man pages are generated.
2012-05-09 19:39:53 +02:00
<!--
These are two separate appendixes because it is difficult to mix regular
sections (for extensions) and refentries (for programs) in one chapter or
appendix. And we do want the programs as refentries so that we can produce man
pages.
-->
<appendix id="contrib-prog">
<title>Additional Supplied Programs</title>
<para>
This appendix and the previous one contain information regarding the modules that
can be found in the <literal>contrib</literal> directory of the
Convert documentation to DocBook XML Since some preparation work had already been done, the only source changes left were changing empty-element tags like <xref linkend="foo"> to <xref linkend="foo"/>, and changing the DOCTYPE. The source files are still named *.sgml, but they are actually XML files now. Renaming could be considered later. In the build system, the intermediate step to convert from SGML to XML is removed. Everything is build straight from the source files again. The OpenSP (or the old SP) package is no longer needed. The documentation toolchain instructions are updated and are much simpler now. Peter Eisentraut, Alexander Lakhin, Jürgen Purtz
2017-11-23 15:39:47 +01:00
<productname>PostgreSQL</productname> distribution. See <xref linkend="contrib"/> for
Split contrib documentation into extensions and programs Create separate appendixes for contrib extensions and other server plugins on the one hand, and utility programs on the other. Recast the documentation of the latter as refentries, so that man pages are generated.
2012-05-09 19:39:53 +02:00
more information about the <literal>contrib</literal> section in general and
server extensions and plug-ins found in <literal>contrib</literal>
specifically.
</para>
<para>
This appendix covers utility programs found in <literal>contrib</literal>.
Once installed, either from source or a packaging system, they are found in
the <filename>bin</filename> directory of the
<productname>PostgreSQL</productname> installation and can be used like any
other program.
</para>
<sect1 id="contrib-prog-client">
<title>Client Applications</title>
<para>
This section covers <productname>PostgreSQL</productname> client
applications in <literal>contrib</literal>. They can be run from anywhere,
independent of where the database server resides. See
Convert documentation to DocBook XML Since some preparation work had already been done, the only source changes left were changing empty-element tags like <xref linkend="foo"> to <xref linkend="foo"/>, and changing the DOCTYPE. The source files are still named *.sgml, but they are actually XML files now. Renaming could be considered later. In the build system, the intermediate step to convert from SGML to XML is removed. Everything is build straight from the source files again. The OpenSP (or the old SP) package is no longer needed. The documentation toolchain instructions are updated and are much simpler now. Peter Eisentraut, Alexander Lakhin, Jürgen Purtz
2017-11-23 15:39:47 +01:00
also <xref linkend="reference-client"/> for information about client
doc: Fix typos Author: Justin Pryzby <pryzby@telsasoft.com> Discussion: https://www.postgresql.org/message-id/20201121194105.GO24784@telsasoft.com
2020-11-25 09:49:00 +01:00
applications that are part of the core <productname>PostgreSQL</productname>
Split contrib documentation into extensions and programs Create separate appendixes for contrib extensions and other server plugins on the one hand, and utility programs on the other. Recast the documentation of the latter as refentries, so that man pages are generated.
2012-05-09 19:39:53 +02:00
distribution.
</para>
&oid2name;
&vacuumlo;
</sect1>
<sect1 id="contrib-prog-server">
<title>Server Applications</title>
<para>
Retire pg_standby. pg_standby was useful more than a decade ago, but now it is obsolete. It has been proposed that we retire it many times. Now seems like a good time to finally do it, because "waiting restore commands" are incompatible with a proposed recovery prefetching feature. Discussion: https://postgr.es/m/20201029024412.GP5380%40telsasoft.com Author: Justin Pryzby <pryzby@telsasoft.com> Reviewed-by: Heikki Linnakangas <hlinnaka@iki.fi> Reviewed-by: Peter Eisentraut <peter.eisentraut@enterprisedb.com> Reviewed-by: Michael Paquier <michael@paquier.xyz> Reviewed-by: Fujii Masao <masao.fujii@oss.nttdata.com>
2021-01-29 01:21:53 +01:00
Some applications run on the <productname>PostgreSQL</productname> server
itself. Currently, no such applications are included in the
<literal>contrib</literal> directory. See also <xref
Convert documentation to DocBook XML Since some preparation work had already been done, the only source changes left were changing empty-element tags like <xref linkend="foo"> to <xref linkend="foo"/>, and changing the DOCTYPE. The source files are still named *.sgml, but they are actually XML files now. Renaming could be considered later. In the build system, the intermediate step to convert from SGML to XML is removed. Everything is build straight from the source files again. The OpenSP (or the old SP) package is no longer needed. The documentation toolchain instructions are updated and are much simpler now. Peter Eisentraut, Alexander Lakhin, Jürgen Purtz
2017-11-23 15:39:47 +01:00
linkend="reference-server"/> for information about server applications that
doc: Fix typos Author: Justin Pryzby <pryzby@telsasoft.com> Discussion: https://www.postgresql.org/message-id/20201121194105.GO24784@telsasoft.com
2020-11-25 09:49:00 +01:00
are part of the core <productname>PostgreSQL</productname> distribution.
Split contrib documentation into extensions and programs Create separate appendixes for contrib extensions and other server plugins on the one hand, and utility programs on the other. Recast the documentation of the latter as refentries, so that man pages are generated.
2012-05-09 19:39:53 +02:00
</para>
</sect1>
</appendix>