CREATE SEQUENCE
CREATE SEQUENCE — создать генератор последовательности
Синтаксис
CREATE [ { TEMPORARY | TEMP } | UNLOGGED ] SEQUENCE [ IF NOT EXISTS ]имя
[ ASтип_данных
] [ INCREMENT [ BY ]шаг
] [ MINVALUEмин_значение
| NO MINVALUE ] [ MAXVALUEмакс_значение
| NO MAXVALUE ] [ START [ WITH ]начало
] [ CACHEкеш
] [ [ NO ] CYCLE ] [ OWNED BY {имя_таблицы
.имя_столбца
| NONE } ]
Описание
CREATE SEQUENCE
создаёт генератор последовательности. Эта операция включает создание и инициализацию специальной таблицы имя
, содержащей одну строку. Владельцем генератора будет пользователь, выполняющий эту команду.
Если указано имя схемы, последовательность создаётся в заданной схеме, в противном случае — в текущей. Временные последовательности существуют в специальной схеме, так что при создании таких последовательностей имя схемы задать нельзя. Имя последовательности должно отличаться от имён других отношений (таблиц, последовательностей, индексов, представлений, материализованных представлений или сторонних таблиц), уже существующих в этой схеме.
После создания последовательности работать с ней можно, вызывая функции nextval
, currval
и setval
. Эти функции документированы в Разделе 9.17.
Хотя непосредственно изменить значение последовательности нельзя, получить её параметры и текущее состояние можно таким запросом:
SELECT * FROM name
;
В частности, поле last_value
последовательности будет содержать последнее значение, выделенное для какого-либо сеанса. (Конечно, ко времени вывода это значение может стать неактуальным, если другие сеансы активно вызывают nextval
.)
Параметры
TEMPORARY
илиTEMP
Если указано, объект последовательности создаётся только для данного сеанса и автоматически удаляется при завершении сеанса. Существующая постоянная последовательность с тем же именем не будут видна (в этом сеансе), пока существует временная, однако к ней можно обратиться, дополнив имя указанием схемы.
UNLOGGED
С этим указанием последовательность создаётся как нежурналируемая. Изменения нежурналируемых последовательностей не проходят через журнал предзаписи. Такие последовательности не защищены от сбоев: нежурналируемая последовательность автоматически сбрасывается в исходное состояние после сбоя или аварийного отключения сервера. Кроме того, нежурналируемые последовательности не реплицируются на ведомые серверы.
В отличие от нежурналируемых таблиц, нежурналируемые последовательности не дают значительного выигрыша в производительности. Это указание полезно, в первую очередь, когда последовательность связана через столбцы идентификаторов или столбцы serial с нежурналируемыми таблицами. В таких случаях обычно не имеет смысла журналировать и реплицировать саму последовательность, но не таблицу, с которой она связана.
IF NOT EXISTS
Не считать ошибкой, если отношение с таким именем уже существует. В этом случае будет выдано замечание. Заметьте, что нет никакой гарантии, что существующее отношение как-то соотносится с последовательностью, которая могла бы быть создана — это может быть даже не последовательность.
имя
Имя создаваемой последовательности (возможно, дополненное схемой).
тип_данных
Необязательное предложение
AS
задаёт тип данных для последовательности. Допустимые типы:тип_данных
smallint
,integer
иbigint
. По умолчанию устанавливается типbigint
. От типа данных зависят принимаемые по умолчанию минимальное и максимальное значения последовательности.шаг
Необязательное предложение
INCREMENT BY
определяет, какое число будет добавляться к текущему значению последовательности для получения нового значения. С положительным шагом последовательность будет возрастающей, а с отрицательным — убывающей. Значение по умолчанию: 1.шаг
мин_значение
NO MINVALUE
Необязательное предложение
MINVALUE
определяет наименьшее число, которое будет генерировать последовательность. Если это предложение опущено либо указаномин_значение
NO MINVALUE
, используется значение по умолчанию: 1 для возрастающей последовательности или минимальное значение типа данных — для убывающей.макс_значение
NO MAXVALUE
Необязательное предложение
MAXVALUE
определяет наибольшее число, которое будет генерировать последовательность. Если это предложение опущено либо указаномакс_значение
NO MAXVALUE
, используется значение по умолчанию: максимальное значение типа данных для возрастающей последовательности или -1 — для убывающей.начало
Необязательное предложение
START WITH
позволяет запустить последовательность с любого значения. По умолчанию началом считаетсяначало
мин_значение
для возрастающих последовательностей имакс_значение
для убывающих.кеш
Необязательное предложение
CACHE
определяет, сколько чисел последовательности будет выделяться и сохраняться в памяти для ускорения доступа к ним. Минимальное значение равно 1 (за один раз генерируется только одно значение, т. е. кеширования нет), и оно же предполагается по умолчанию.кеш
CYCLE
NO CYCLE
Параметр
CYCLE
позволяет зациклить последовательность при достижениимакс_значения
илимин_значения
для возрастающей или убывающей последовательности, соответственно. Когда этот предел достигается, следующим числом этих последовательностей будет соответственномин_значение
илимакс_значение
.Если указывается
NO CYCLE
, при каждом вызовеnextval
после достижения предельного значения будет возникать ошибка. Если указанияCYCLE
иNO CYCLE
отсутствуют, по умолчанию предполагаетсяNO CYCLE
.OWNED BY
имя_таблицы
.имя_столбца
OWNED BY NONE
Предложение
OWNED BY
позволяет связать последовательность с определённым столбцом таблицы так, чтобы при удалении этого столбца (или всей таблицы) последовательность удалялась автоматически. Указанная таблица должна иметь того же владельца и находиться в той же схеме, что и последовательность. Подразумеваемое по умолчанию предложениеOWNED BY NONE
указывает, что такая связь не устанавливается.
Примечания
Для удаления последовательности применяется команда DROP SEQUENCE
.
Последовательности основаны на арифметике bigint
, так что их значения не могут выходить за диапазон восьмибайтовых целых (-9223372036854775808 .. 9223372036854775807).
Так как вызовы nextval
и setval
никогда не откатываются, объекты последовательностей не подходят, если требуется обеспечить непрерывное назначение номеров последовательностей. Непрерывное назначение можно организовать, используя исключительную блокировку таблицы со счётчиком; однако это решение будет гораздо дороже, чем применение объектов последовательностей, особенно когда последовательные номера будут затребоваться сразу многими транзакциями.
Если значение параметра кеш
больше единицы, и объект последовательности используется параллельно в нескольких сеансах, результат может оказаться не вполне ожидаемым. Каждый сеанс будет выделять и кешировать несколько очередных значений последовательности при одном обращении к объекту последовательности и соответственно увеличивать последнее_значение
этого объекта. Затем при следующих кеш
-1 вызовах nextval
в этом сеансе будет просто возвращать заготовленные значения, не касаясь объекта последовательности. В результате, все числа, выделенные, но не использованные в сеансе, будут потеряны при завершении сеанса, что приведёт к образовании «дырок» в последовательности.
Более того, хотя разным сеансам гарантированно выделяются различные значения последовательности, если рассмотреть все сеансы в целом, порядок этих значений может быть нарушен. Например, при значении кеш
, равном 10, сеанс A может зарезервировать значения 1..10 и получить nextval
=1, затем сеанс B может зарезервировать значения 11..20 и получить nextval
=11 до того, как в сеансе A сгенерируется nextval
=2. Таким образом, при значении кеш
, равном одному, можно быть уверенными в том, что nextval
генерирует последовательные значения; но если кеш
больше одного, рассчитывать можно только на то, что все значения nextval
различны; их порядок может быть непоследовательным. Кроме того, last_value
возвращает последнее зарезервированное значение для всех сеансов, вне зависимости от того, было ли оно уже возвращено функцией nextval
.
Также следует учитывать, что действие функции setval
, выполненной для такой последовательности, проявится в других сеансах только после того, как в них будут использованы все предварительно закешированные значения.
Примеры
Создание возрастающей последовательности с именем serial
, с начальным значением 101:
CREATE SEQUENCE serial START 101;
Получение следующего номера этой последовательности:
SELECT nextval('serial'); nextval --------- 101
Получение следующего номера этой последовательности:
SELECT nextval('serial'); nextval --------- 102
Использование этой последовательности в команде INSERT
:
INSERT INTO distributors VALUES (nextval('serial'), 'nothing');
Изменение значения последовательности после COPY FROM
:
BEGIN; COPY distributors FROM 'input_file'; SELECT setval('serial', max(id)) FROM distributors; END;
Совместимость
Команда CREATE SEQUENCE
соответствует стандарту SQL, со следующими исключениями:
Для получения следующего значения применяется функция
nextval()
, а не выражениеNEXT VALUE FOR
, как того требует стандарт.Предложение
OWNED BY
является расширением Postgres Pro.
См. также
ALTER SEQUENCE, DROP SEQUENCECREATE SEQUENCE
CREATE SEQUENCE — define a new sequence generator
Synopsis
CREATE [ { TEMPORARY | TEMP } | UNLOGGED ] SEQUENCE [ IF NOT EXISTS ]name
[ ASdata_type
] [ 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 name name
. 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 relation (table, sequence, index, view, materialized view, or foreign table) in the same schema.
After a sequence is created, you use the functions nextval
, currval
, and setval
to operate on the sequence. These functions are documented in Section 9.17.
Although you cannot update a sequence directly, you can use a query like:
SELECT * FROM name
;
to examine the parameters and current state of a sequence. In particular, the last_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 doing nextval
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.
UNLOGGED
If specified, the sequence is created as an unlogged sequence. Changes to unlogged sequences are not written to the write-ahead log. They are not crash-safe: an unlogged sequence is automatically reset to its initial state after a crash or unclean shutdown. Unlogged sequences are also not replicated to standby servers.
Unlike unlogged tables, unlogged sequences do not offer a significant performance advantage. This option is mainly intended for sequences associated with unlogged tables via identity columns or serial columns. In those cases, it usually wouldn't make sense to have the sequence WAL-logged and replicated but not its associated table.
IF NOT EXISTS
Do not throw an error if a relation with the same name already exists. A notice is issued in this case. Note that there is no guarantee that the existing relation is anything like the sequence that would have been created — it might not even be a sequence.
name
The name (optionally schema-qualified) of the sequence to be created.
data_type
The optional clause
AS
specifies the data type of the sequence. Valid types aredata_type
smallint
,integer
, andbigint
.bigint
is the default. The data type determines the default minimum and maximum values of the sequence.increment
The optional clause
INCREMENT BY
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.increment
minvalue
NO MINVALUE
The optional clause
MINVALUE
determines the minimum value a sequence can generate. If this clause is not supplied orminvalue
NO MINVALUE
is specified, then defaults will be used. The default for an ascending sequence is 1. The default for a descending sequence is the minimum value of the data type.maxvalue
NO MAXVALUE
The optional clause
MAXVALUE
determines the maximum value for the sequence. If this clause is not supplied ormaxvalue
NO MAXVALUE
is specified, then default values will be used. The default for an ascending sequence is the maximum value of the data type. The default for a descending sequence is -1.start
The optional clause
START WITH
allows the sequence to begin anywhere. The default starting value isstart
minvalue
for ascending sequences andmaxvalue
for descending ones.cache
The optional clause
CACHE
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.cache
CYCLE
NO CYCLE
The
CYCLE
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.If
NO CYCLE
is specified, any calls tonextval
after the sequence has reached its maximum value will return an error. If neitherCYCLE
orNO CYCLE
are specified,NO CYCLE
is the default.OWNED BY
table_name
.column_name
OWNED BY NONE
The
OWNED 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
Use DROP SEQUENCE
to remove a sequence.
Sequences are based on bigint
arithmetic, so the range cannot exceed the range of an eight-byte integer (-9223372036854775808 to 9223372036854775807).
Because nextval
and setval
calls are never rolled back, sequence objects cannot be used if “gapless” assignment of sequence numbers is needed. It is possible to build gapless assignment by using exclusive locking of a table containing a counter; but this solution is much more expensive than sequence objects, especially if many transactions need sequence numbers concurrently.
Unexpected results might be obtained if a cache
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's last_value
accordingly. Then, the next cache
-1 uses of nextval
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 a cache
setting of 10, session A might reserve values 1..10 and return nextval
=1, then session B might reserve values 11..20 and return nextval
=11 before session A has generated nextval
=2. Thus, with a cache
setting of one it is safe to assume that nextval
values are generated sequentially; with a cache
setting greater than one you should only assume that the nextval
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 by nextval
.
Another consideration is that a setval
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 called serial
, 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 an INSERT
command:
INSERT INTO distributors VALUES (nextval('serial'), 'nothing');
Update the sequence value after a COPY FROM
:
BEGIN; COPY distributors FROM 'input_file'; SELECT setval('serial', max(id)) FROM distributors; END;
Compatibility
CREATE SEQUENCE
conforms to the SQL standard, with the following exceptions:
Obtaining the next value is done using the
nextval()
function instead of the standard'sNEXT VALUE FOR
expression.The
OWNED BY
clause is a Postgres Pro extension.