aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Eisentraut <peter_e@gmx.net>2016-04-17 23:13:45 -0400
committerPeter Eisentraut <peter_e@gmx.net>2016-04-17 23:13:45 -0400
commitd460c7cc0fd43a7f7184818c67705a878e938b2d (patch)
tree2fd00d8d459200eeb5b49ee0e4f5040fba5a11de
parent9603a32594d2f5e6d9a1f098bc554a68f44ccb3c (diff)
downloadpostgresql-d460c7cc0fd43a7f7184818c67705a878e938b2d.tar.gz
postgresql-d460c7cc0fd43a7f7184818c67705a878e938b2d.zip
doc: Document that sequences can also be extension configuration tables
From: Michael Paquier <michael.paquier@gmail.com>
-rw-r--r--doc/src/sgml/extend.sgml25
1 files changed, 20 insertions, 5 deletions
diff --git a/doc/src/sgml/extend.sgml b/doc/src/sgml/extend.sgml
index df3b9d9cb22..f050ff1f660 100644
--- a/doc/src/sgml/extend.sgml
+++ b/doc/src/sgml/extend.sgml
@@ -698,17 +698,21 @@ SET LOCAL search_path TO @extschema@;
<para>
To solve this problem, an extension's script file can mark a table
- it has created as a configuration table, which will cause
- <application>pg_dump</> to include the table's contents (not its
- definition) in dumps. To do that, call the function
+ or a sequence it has created as a configuration relation, which will
+ cause <application>pg_dump</> to include the table's or the sequence's
+ contents (not its definition) in dumps. To do that, call the function
<function>pg_extension_config_dump(regclass, text)</> after creating the
- table, for example
+ table or the sequence, for example
<programlisting>
CREATE TABLE my_config (key text, value text);
+CREATE SEQUENCE my_config_seq;
SELECT pg_catalog.pg_extension_config_dump('my_config', '');
+SELECT pg_catalog.pg_extension_config_dump('my_config_seq', '');
</programlisting>
- Any number of tables can be marked this way.
+ Any number of tables or sequences can be marked this way. Sequences
+ associated with <type>serial</> or <type>bigserial</> columns can
+ be marked as well.
</para>
<para>
@@ -730,6 +734,11 @@ SELECT pg_catalog.pg_extension_config_dump('my_config', 'WHERE NOT standard_entr
</para>
<para>
+ For sequences, the second argument of <function>pg_extension_config_dump</>
+ has no effect.
+ </para>
+
+ <para>
More complicated situations, such as initially-provided rows that might
be modified by users, can be handled by creating triggers on the
configuration table to ensure that modified rows are marked correctly.
@@ -753,6 +762,12 @@ SELECT pg_catalog.pg_extension_config_dump('my_config', 'WHERE NOT standard_entr
out but the dump will not be able to be restored directly and user
intervention will be required.
</para>
+
+ <para>
+ Sequences associated with <type>serial</> or <type>bigserial</> columns
+ need to be directly marked to dump their state. Marking their parent
+ relation is not enough for this purpose.
+ </para>
</sect2>
<sect2>