From a4ac2f458e8cb76177254f4bd7bbd885991379af Mon Sep 17 00:00:00 2001 From: "Thomas G. Lockhart" Date: Tue, 6 Jul 1999 17:16:42 +0000 Subject: Fix markup for docbook2man man page generation. No big deal; fixed lots of other markup at the same time. Bigest change: make sure there is no whitespace in front of contents. This will probably help the other output types too. --- doc/src/sgml/ref/create_sequence.sgml | 497 +++++++++++++++++----------------- 1 file changed, 242 insertions(+), 255 deletions(-) (limited to 'doc/src/sgml/ref/create_sequence.sgml') diff --git a/doc/src/sgml/ref/create_sequence.sgml b/doc/src/sgml/ref/create_sequence.sgml index f6d6ae0b8d4..352c839f917 100644 --- a/doc/src/sgml/ref/create_sequence.sgml +++ b/doc/src/sgml/ref/create_sequence.sgml @@ -1,23 +1,23 @@ - - - + + + CREATE SEQUENCE - - SQL - Language Statements - - - + + SQL - Language Statements + + + CREATE SEQUENCE - - + + Creates a new sequence number generator - + - - - 1998-04-15 - - + + + 1998-04-15 + + CREATE SEQUENCE seqname [ INCREMENT increment ] [ MINVALUE minvalue ] @@ -25,218 +25,207 @@ CREATE SEQUENCE seqname [ START start ] [ CACHE cache ] [ CYCLE ] - + - - - 1998-09-11 - - + <refsect2 id="R2-SQL-CREATESEQUENCE-1"> + <refsect2info> + <date>1998-09-11</date> + </refsect2info> + <title> Inputs - - - - - - - seqname - - - - The name of a sequence to be created. - - - - - - increment - - - - The clause is optional. A positive value will make an - ascending sequence, a negative one a descending sequence. - The default value is one (1). - - - - - - minvalue - - - - The optional clause - determines the minimum value - a sequence can generate. The defaults are 1 and -2147483647 for - ascending and descending sequences, respectively. - - - - - - maxvalue - - - - Use the optional clause to - determine the maximum - value for the sequence. The defaults are 2147483647 and -1 for - ascending and descending sequences, respectively. - - - - - + + + + + + seqname + + + The name of a sequence to be created. + + + + + increment + + + The + + clause is optional. A positive value will make an + ascending sequence, a negative one a descending sequence. + The default value is one (1). + + + + + minvalue + + + The optional clause + determines the minimum value + a sequence can generate. The defaults are 1 and -2147483647 for + ascending and descending sequences, respectively. + + + + + maxvalue + + + Use the optional clause to + determine the maximum + value for the sequence. The defaults are 2147483647 and -1 for + ascending and descending sequences, respectively. + + + + + start + + + The optional - - - The optional enables the sequence to begin anywhere. - The default starting value is - minvalue - for ascending sequences and - maxvalue - for descending ones. - - - - - - cache - - - - The option - enables sequence numbers to be preallocated - and stored in memory for faster access. The minimum - value is 1 (only one value can be generated at a time, i.e. no cache) - and this is also the default. - - - - - - CYCLE - - - - The optional CYCLE keyword may be used to enable the sequence - to continue when the - maxvalue or - minvalue has been - reached by - an ascending or descending sequence respectively. If the limit is - reached, the next number generated will be whatever the - minvalue or - maxvalue is, - as appropriate. - - - - - - - - - 1998-09-11 - - + clause</option> enables the sequence to begin anywhere. + The default starting value is + <replaceable class="parameter">minvalue</replaceable> + for ascending sequences and + <replaceable class="parameter">maxvalue</replaceable> + for descending ones. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><replaceable class="parameter">cache</replaceable></term> + <listitem> + <para> + The <option>CACHE <replaceable class="parameter">cache</replaceable></option> option + enables sequence numbers to be preallocated + and stored in memory for faster access. The minimum + value is 1 (only one value can be generated at a time, i.e. no cache) + and this is also the default. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>CYCLE</term> + <listitem> + <para> + The optional CYCLE keyword may be used to enable the sequence + to continue when the + <replaceable class="parameter">maxvalue</replaceable> or + <replaceable class="parameter">minvalue</replaceable> has been + reached by + an ascending or descending sequence respectively. If the limit is + reached, the next number generated will be whatever the + <replaceable class="parameter">minvalue</replaceable> or + <replaceable class="parameter">maxvalue</replaceable> is, + as appropriate. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect2> + + <refsect2 id="R2-SQL-CREATESEQUENCE-2"> + <refsect2info> + <date>1998-09-11</date> + </refsect2info> + <title> Outputs - - + + - - - - CREATE - - - - Message returned if the command is successful. - - - - - -ERROR: amcreate: 'seqname' relation already exists - - - - If the sequence specified already exists. - - - - - -ERROR: DefineSequence: START value (start) can't be > MAXVALUE (maxvalue) - - - - If the specified starting value is out of range. - - - - - -ERROR: DefineSequence: START value (start) can't be < MINVALUE (minvalue) - - - - If the specified starting value is out of range. - - - - - -ERROR: DefineSequence: MINVALUE (minvalue) can't be >= MAXVALUE (maxvalue) - - - - If the minimum and maximum values are inconsistant. + + + +CREATE + + + + Message returned if the command is successful. + + + + + +ERROR: Relation 'seqname' already exists + + + + If the sequence specified already exists. + + + + + +ERROR: DefineSequence: MINVALUE (start) can't be >= MAXVALUE (max) + + + + If the specified starting value is out of range. + + + + + +ERROR: DefineSequence: START value (start) can't be < MINVALUE (min) + + + + If the specified starting value is out of range. + + + + + +ERROR: DefineSequence: MINVALUE (min) can't be >= MAXVALUE (max) + + + + If the minimum and maximum values are inconsistant. - + - - - - - - 1998-09-11 - - + </refsect2> + </refsynopsisdiv> + + <refsect1 id="R1-SQL-CREATESEQUENCE-1"> + <refsect1info> + <date>1998-09-11</date> + </refsect1info> + <title> Description - - - CREATE SEQUENCE will enter a new sequence number generator + + + CREATE SEQUENCE will enter a new sequence number generator into the current data base. This involves creating and initialising a new single-row table with the name seqname. The generator will be "owned" by the user issuing the command. - + After a sequence is created, you may use the function -nextval(seqname) -to get a new number from the sequence. -The function -currval('seqname') - may be used to determine the number returned by the last call to -nextval(seqname) - for the specified sequence in the current session. -The function -setval('seqname', - newvalue) -may be used to set the current value of the specified sequence. -The next call to -nextval(seqname) -will return the given value plus the sequence increment. + nextval(seqname) + to get a new number from the sequence. + The function + currval('seqname') + may be used to determine the number returned by the last call to + nextval(seqname) + for the specified sequence in the current session. + The function + setval('seqname', + newvalue) + may be used to set the current value of the specified sequence. + The next call to + nextval(seqname) + will return the given value plus the sequence increment. - + Use a query like @@ -256,7 +245,7 @@ SELECT last_value FROM sequence_name; calls to a generator. - + Unexpected results may be obtained if a cache setting greater than one is used for a sequence object that will be used concurrently by multiple @@ -279,35 +268,35 @@ SELECT last_value FROM sequence_name; whether or not it has yet been returned by nextval. - - - - 1998-09-11 - - + + <refsect2 id="R2-SQL-CREATESEQUENCE-3"> + <refsect2info> + <date>1998-09-11</date> + </refsect2info> + <title> Notes - - - Refer to the DROP SEQUENCE statement to remove a sequence. - + + + Refer to the DROP SEQUENCE statement to remove a sequence. + Each backend uses its own cache to store allocated numbers. Numbers that are cached but not used in the current session will be lost, resulting in "holes" in the sequence. - + - - - + + <refsect1 id="R1-SQL-CREATESEQUENCE-2"> + <title> Usage - - + + Create an ascending sequence called serial, starting at 101: - - + + CREATE SEQUENCE serial START 101; - + Select the next number from this sequence @@ -328,47 +317,45 @@ INSERT INTO distributors VALUES (NEXTVAL('serial'),'nothing'); Set the sequence value after a COPY FROM: - CREATE FUNCTION distributors_id_max() RETURNS INT4 +CREATE FUNCTION distributors_id_max() RETURNS INT4 AS 'SELECT max(id) FROM distributors' LANGUAGE 'sql'; - BEGIN; +BEGIN; COPY distributors FROM 'input_file'; SELECT setval('serial', distributors_id_max()); - END; +END; - - - - - + </refsect1> + + <refsect1 id="R1-SQL-CREATESEQUENCE-3"> + <title> Compatibility - - + + CREATE SEQUENCE is a Postgres language extension. - - - - - 1998-09-11 - - + </para> + + <refsect2 id="R2-SQL-CREATESEQUENCE-4"> + <refsect2info> + <date>1998-09-11</date> + </refsect2info> + <title> SQL92 - - + + There is no CREATE SEQUENCE statement - in SQL92. - + in SQL92. + - - +