Tarantool CE/EE Documentation portal logo
Помощь
Обновлена 15 сентября 2026 г. в 08:55

box.schema.sequence.create()

create(name[, options])

Создание нового генератора последовательности.

Параметры:

  • name (string) — имя последовательности
  • options (table) — краткий обзор приведен в таблице "Параметры box.schema.sequence.create()" (в разделе Последовательности главы "Модель данных"), подробности см. ниже.

Возвращает

ссылка на новый объект последовательности.

Опции:

  • start — НАЧАЛЬНОЕ значение. Тип: integer, по умолчанию: 1.

  • min — МИНИМАЛЬНОЕ значение. Тип: integer, по умолчанию: 1.

  • max — МАКСИМАЛЬНОЕ значение. Тип: integer, по умолчанию: 9223372036854775807.

    Есть правило: min <- start <- max. Например, нельзя указать {start=0}, потому что тогда указанное начальное значение (0) будет меньше, чем минимальное значение по умолчанию (1).

    Есть правило: min <- следующее-значение <- max. Например, если следующее генерируемое значение будет 1000, а максимальное значение равно 999, то это будет считаться «переполнением».

    Есть правило: start, min и max должны быть <= 9223372036854775807, что равно 2^63 - 1 (а не 2^64).

  • cycle — значение ЦИКЛА. Тип: bool. По умолчанию: false. Если следующее значение в генераторе последовательности будет переполнением, это вызовет ошибку — если только не задан цикл (cycle == true). Но если cycle == true, счет начинается заново с МИНИМАЛЬНОГО значения или с МАКИСМАЛЬНОГО (а не НАЧАЛЬНОГО значения).

  • cache — значение КЭША. Тип: unsigned integer. По умолчанию: 0. В данный момент Tarantool игнорирует это значение, оно зарезервировано для последующего использования.

  • step — значение УВЕЛИЧЕНИЯ. Тип: integer. По умолчанию: 1. Обычно это значение прибавляется к предыдущему.