CREATE SEQUENCE
Synopsis
CREATE [ TEMPORARY | TEMP ] SEQUENCEname [ INCREMENT [ BY ]increment ] [ MINVALUEminvalue | NO MINVALUE ] [ MAXVALUEmaxvalue | NO MAXVALUE ] [ START [ WITH ]start ] [ CACHEcache ] [ [ NO ] CYCLE ] [ OWNED BY {table_name.column_name | NONE } ]
Description
CREATE SEQUENCE creates a new sequence number generator. This involves creating and initializing a new special single-row table with the namename. The generator will be owned by the user issuing the command.
If a schema name is given then the sequence is created in the specified schema. Otherwise it is created in the current schema. Temporary sequences exist in a special schema, so a schema name cannot be given when creating a temporary sequence. The sequence name must be distinct from the name of any other sequence, table, index, view, or foreign table in the same schema.
After a sequence is created, you use the functionsnextval
,currval
, andsetval
to operate on the sequence. These functions are documented inSection 9.16.
Although you cannot update a sequence directly, you can use a query like:
SELECT * FROMname;
to examine the parameters and current state of a sequence. In particular, thelast_value field of the sequence shows the last value allocated by any session. (Of course, this value might be obsolete by the time it's printed, if other sessions are actively doingnextval
calls.)
Parameters
- TEMPORARY orTEMP
If specified, the sequence object is created only for this session, and is automatically dropped on session exit. Existing permanent sequences with the same name are not visible (in this session) while the temporary sequence exists, unless they are referenced with schema-qualified names.
- name
The name (optionally schema-qualified) of the sequence to be created.
- increment
The optional clauseINCREMENT BYincrement specifies which value is added to the current sequence value to create a new value. A positive value will make an ascending sequence, a negative one a descending sequence. The default value is 1.
- minvalue
NO MINVALUE The optional clauseMINVALUEminvalue determines the minimum value a sequence can generate. If this clause is not supplied orNO MINVALUE is specified, then defaults will be used. The defaults are 1 and -263-1 for ascending and descending sequences, respectively.
- maxvalue
NO MAXVALUE The optional clauseMAXVALUEmaxvalue determines the maximum value for the sequence. If this clause is not supplied orNO MAXVALUE is specified, then default values will be used. The defaults are 263-1 and -1 for ascending and descending sequences, respectively.
- start
The optional clauseSTART WITHstart allows the sequence to begin anywhere. The default starting value isminvalue for ascending sequences andmaxvalue for descending ones.
- cache
The optional clauseCACHEcache specifies how many sequence numbers are 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
NO CYCLE TheCYCLE option allows the sequence to wrap around when themaxvalue orminvalue has been reached by an ascending or descending sequence respectively. If the limit is reached, the next number generated will be theminvalue ormaxvalue, respectively.
IfNO CYCLE is specified, any calls to
nextval
after the sequence has reached its maximum value will return an error. If neitherCYCLE orNO CYCLE are specified,NO CYCLE is the default.- OWNED BYtable_name.column_name
OWNED BY NONE TheOWNED BY option causes the sequence to be associated with a specific table column, such that if that column (or its whole table) is dropped, the sequence will be automatically dropped as well. The specified table must have the same owner and be in the same schema as the sequence.OWNED BY NONE, the default, specifies that there is no such association.
Notes
UseDROP SEQUENCE to remove a sequence.
Sequences are based onbigint arithmetic, so the range cannot exceed the range of an eight-byte integer (-9223372036854775808 to 9223372036854775807).
Unexpected results might be obtained if acache setting greater than one is used for a sequence object that will be used concurrently by multiple sessions. Each session will allocate and cache successive sequence values during one access to the sequence object and increase the sequence object'slast_value accordingly. Then, the nextcache-1 uses ofnextval
within that session simply return the preallocated values without touching the sequence object. So, any numbers allocated but not used within a session will be lost when that session ends, resulting in"holes" in the sequence.
Furthermore, although multiple sessions are guaranteed to allocate distinct sequence values, the values might be generated out of sequence when all the sessions are considered. For example, with acache setting of 10, session A might reserve values 1..10 and returnnextval
=1, then session B might reserve values 11..20 and returnnextval
=11 before session A has generatednextval=2. Thus, with acache setting of one it is safe to assume thatnextval
values are generated sequentially; with acache setting greater than one you should only assume that thenextval
values are all distinct, not that they are generated purely sequentially. Also,last_value will reflect the latest value reserved by any session, whether or not it has yet been returned bynextval
.
Another consideration is that asetval
executed on such a sequence will not be noticed by other sessions until they have used up any preallocated values they have cached.
Examples
Create an ascending sequence calledserial, starting at 101:
CREATE SEQUENCE serial START 101;
Select the next number from this sequence:
SELECT nextval('serial'); nextval--------- 101
Select the next number from this sequence:
SELECT nextval('serial'); nextval--------- 102
Use this sequence in anINSERT command:
INSERT INTO distributors VALUES (nextval('serial'), 'nothing');
Update the sequence value after aCOPY FROM:
BEGIN;COPY distributors FROM 'input_file';SELECT setval('serial', max(id)) FROM distributors;END;
Compatibility
CREATE SEQUENCE conforms to theSQL standard, with the following exceptions: The standard'sAS <data type> expression is not supported. Obtaining the next value is done using the TheOWNED BY clause is aPostgreSQL extension.nextval()
function instead of the standard'sNEXT VALUE FOR expression.