summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHeikki Linnakangas2015-04-20 15:37:51 +0000
committerHeikki Linnakangas2015-04-20 15:37:51 +0000
commit99c657c9e7b2073c3b4f566b9442ad220585a44b (patch)
tree14d179508f8e3d070a5c77c99b193761059cc9d7
parent5ec27ca46dfef7e14d891071ec45596cd9c047b4 (diff)
Minor rewording of the docs.seqam
-rw-r--r--doc/src/sgml/seqam.sgml42
1 files changed, 24 insertions, 18 deletions
diff --git a/doc/src/sgml/seqam.sgml b/doc/src/sgml/seqam.sgml
index e3a5764cf4..3caab4d80c 100644
--- a/doc/src/sgml/seqam.sgml
+++ b/doc/src/sgml/seqam.sgml
@@ -14,11 +14,6 @@
application context.
</para>
- <para>
- All sequence access method share same storage. The storage API is provided
- by <productname>PostgreSQL</> backend.
- </para>
-
<sect1 id="seqam-catalog">
<title>Catalog Entries for Sequence Access Method</title>
@@ -38,7 +33,13 @@
<title>Sequence Access Method Functions</title>
<para>
- The functions defining the sequence access method API are:
+ The behaviour of a sequence access method is defined by a set of functions.
+ These functions are implemented by the sequence access method.
+ </para>
+
+
+ <para>
+ The functions defining a sequence access method are:
</para>
<para>
@@ -47,14 +48,19 @@ void
seqam_init (Oid seqrelid, List *seqparams, bytea *reloptions,
Datum *value, bool *nulls);
</programlisting>
- Initialize sequence. This function is called both for new sequence
- initilization and for reinitialization when the sequence access method
- has been changed by <command>ALTER SEQUENCE</>. The <literal>seqrelid</>
- is set InvalidOid if new sequence is being initialized, otherwise it points
- to <link linkend="catalog-pg-class"><structname>pg_class</structname></link>
+ Initialize the sequence's internal state. This function is called both
+ when a new sequence is created, and when the sequence access method of an
+ existing sequence is changed by the <command>ALTER SEQUENCE</> command.
+ </para>
+
+ <para>
+ The <literal>seqrelid</> is InvalidOid if new sequence is being
+ initialized, otherwise it points to
+ <link linkend="catalog-pg-class"><structname>pg_class</structname></link>
tuple representing the existing sequence.
- The <literal>seqparams</> is list of <structname>DefElem</>s as passed to
- the <command>CREATE SEQUENCE</> or <command>ALTER SEQUENCE</> statements.
+ <literal>seqparams</> is list of <structname>DefElem</>s corresponding
+ to the options in the <command>CREATE SEQUENCE</> or
+ <command>ALTER SEQUENCE</> statement.
<literal>reloptions</> contains parsed reloptions passed to the
<command>CREATE SEQUENCE</> or <command>ALTER SEQUENCE</> statements.
The <literal>values</> and <literal>nulls</> describe new tuple for the
@@ -107,7 +113,7 @@ int
seqam_get_state (Relation seqrel, SequenceHandle *seqh, char ***keys,
char ***values);
</programlisting>
- Dump the current state of the sequence. Return value is number of elements
+ Dump the current state of the sequence. Return value is the number of elements
in the output arrays <literal>keys</> and <literal>values</> which in turn
define the key/value pairs of the current state description. This interface
is mainly used by <command>pg_dump</command>.
@@ -131,16 +137,16 @@ seqam_set_state (Relation seqrel, SequenceHandle *seqh, char **keys,
<title>Sequence Access Method Storage API</title>
<para>
- To store the current state of the sequence backend provides following
- functions which the sequence access method can use:
+ To store the current state of the sequence, the backend provides the
+ following functions which the sequence access method can use:
</para>
<para>
<programlisting>
void
-sequence_open(Oid seqrelid, SequenceHandle *seqh);
+sequence_open(Oid relid, SequenceHandle *seqh);
</programlisting>
- Open sequence with given <literal>seqrelid</>. The <literal>seqh</> is
+ Open sequence with given <literal>relid</>. The <literal>seqh</> is
output parameter which will be set to the sequence handle.
</para>