next up previous contents index
Next: CREATE TABLE Up: Reference Manual Previous: CREATE RULE

Subsections

  
CREATE SEQUENCE

Name

CREATE SEQUENCE -- Creates a new sequence number generator

CREATE SEQUENCE seqname

[ INCREMENT increment ]

[ MINVALUE minvalue ]

[ MAXVALUE maxvalue ]

[ START start ]

[ CACHE cache ]

[ CYCLE ]

Inputs

seqname
The name of a sequence to be created.
increment
The INCREMENT increment 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 MINVALUE minvalue 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 MAXVALUE maxvalue to determine the maximum value for the sequence. The defaults are 2147483647 and -1 for ascending and descending sequences, respectively.
start
The optional START start clause enables the sequence to begin anywhere. The default starting value is minvalue for ascending sequences and maxvalue for descending ones.
cache
The CACHE cache 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.

Outputs

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 inconsistent.

Description

CREATE SEQUENCE will enter a new sequence number generator into the current data base. This involves creating and initializing 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.

Use a query like SELECT * FROM seqname; to get the parameters of a sequence. As an alternative to fetching the parameters from the original definition as above, you can use SELECT last_value FROM seqname; to obtain the last value allocated by any backend.

Low-level locking is used to enable multiple simultaneous calls to a generator.

Notes

Use DROP SEQUENCE 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.

Usage

Create an ascending sequence called serial, starting at 101:

 

        CREATE SEQUENCE serial START 101; 
 

Select the next number from this sequence:

 

        SELECT NEXTVAL ('serial'); 
        nextval 
        ------- 
         114
 

Use this sequence in an INSERT:

 

        INSERT INTO distributors 
        VALUES (NEXTVAL('serial'),'nothing');
 

Set the sequence value after a COPY FROM:

 

        CREATE FUNCTION distributors_id_max() 
        RETURNS INT4 AS '
            SELECT max(id) 
            FROM distributors' 
        LANGUAGE 'sql'; 
        BEGIN; 
            COPY distributors FROM 'input_file'; 
            SELECT setval('serial', distributors_id_max()); 
        END; 
 

Compatibility

SQL92

CREATE SEQUENCE is a Postgres language extension. There is no CREATE SEQUENCE statement in SQL92.  


next up previous contents index
Next: CREATE TABLE Up: Reference Manual Previous: CREATE RULE
Bruce Momjian
2001-05-09