シーケンスを作成

CREATE SEQUENCEステートメントは、TiDB にシーケンスオブジェクトを作成します。シーケンスは、テーブルやViewのオブジェクトと同等のデータベースオブジェクトです。シーケンスは、カスタマイズされた方法でシリアル化された ID を生成するために使用されます。

概要

CreateSequenceStmt ::=
    'CREATE' 'SEQUENCE' IfNotExists TableName CreateSequenceOptionListOpt

IfNotExists ::=
    ('IF' 'NOT' 'EXISTS')?

TableName ::=
    Identifier ('.' Identifier)?

CreateSequenceOptionListOpt ::=
    SequenceOption*

SequenceOptionList ::=
    SequenceOption

SequenceOption ::=
    ( 'INCREMENT' ( '='? | 'BY' ) | 'START' ( '='? | 'WITH' ) | ( 'MINVALUE' | 'MAXVALUE' | 'CACHE' ) '='? ) SignedNum
|   'COMMENT' '='? stringLit
|   'NOMINVALUE'
|   'NO' ( 'MINVALUE' | 'MAXVALUE' | 'CACHE' | 'CYCLE' )
|   'NOMAXVALUE'
|   'NOCACHE'
|   'CYCLE'
|   'NOCYCLE'

構文

CREATE [TEMPORARY] SEQUENCE [IF NOT EXISTS] sequence_name
    [ INCREMENT [ BY | = ] increment ]
    [ MINVALUE [=] minvalue | NO MINVALUE | NOMINVALUE ]
    [ MAXVALUE [=] maxvalue | NO MAXVALUE | NOMAXVALUE ]
    [ START [ WITH | = ] start ]
    [ CACHE [=] cache | NOCACHE | NO CACHE]
    [ CYCLE | NOCYCLE | NO CYCLE]
    [table_options]

パラメータ

SEQUENCE関数

次の式関数を通じてシーケンスを制御できます。

• NEXTVALまたはNEXT VALUE FOR

  基本的に、どちらもシーケンスオブジェクトの次の有効な値を取得するNEXTVAL()関数です。3 NEXTVAL()の関数の引数は、シーケンスのidentifierの値です。

• LASTVAL

  この関数は、このセッションで最後に使用された値を取得します。値が存在しない場合はNULL使用されます。この関数の引数は、シーケンスのidentifierです。

• SETVAL

  この関数は、シーケンスの現在の値の進行を設定します。この関数の最初のパラメータはシーケンスのidentifier 、2番目のパラメータはnumです。

注記：

TiDBにおけるシーケンスの実装において、 SETVAL関数はシーケンスの初期進行またはサイクル進行を変更できません。この関数は、この進行に基づいて次の有効な値を返すだけです。

例

• デフォルトのパラメータを使用してシーケンス オブジェクトを作成します。

  CREATE SEQUENCE seq;
  

  Query OK, 0 rows affected (0.06 sec)
  

• シーケンス オブジェクトの次の値を取得するには、 NEXTVAL()関数を使用します。

  SELECT NEXTVAL(seq);
  

  +--------------+
  | NEXTVAL(seq) |
  +--------------+
  |            1 |
  +--------------+
  1 row in set (0.02 sec)
  

• このセッションでのシーケンス オブジェクトへの最後の呼び出しによって生成された値を取得するには、 LASTVAL()関数を使用します。

  SELECT LASTVAL(seq);
  

  +--------------+
  | LASTVAL(seq) |
  +--------------+
  |            1 |
  +--------------+
  1 row in set (0.02 sec)
  

• シーケンス オブジェクトの現在の値 (または現在の位置) を設定するには、 SETVAL()関数を使用します。

  SELECT SETVAL(seq, 10);
  

  +-----------------+
  | SETVAL(seq, 10) |
  +-----------------+
  |              10 |
  +-----------------+
  1 row in set (0.01 sec)
  

• next value for構文を使用して、シーケンスの次の値を取得することもできます。

  SELECT next value for seq;
  

  +--------------------+
  | next value for seq |
  +--------------------+
  |                 11 |
  +--------------------+
  1 row in set (0.00 sec)
  

• デフォルトのカスタム パラメータを使用してシーケンス オブジェクトを作成します。

  CREATE SEQUENCE seq2 start 3 increment 2 minvalue 1 maxvalue 10 cache 3;
  

  Query OK, 0 rows affected (0.01 sec)
  

• このセッションでシーケンス オブジェクトが使用されていない場合、 LASTVAL()関数はNULL値を返します。

  SELECT LASTVAL(seq2);
  

  +---------------+
  | LASTVAL(seq2) |
  +---------------+
  |          NULL |
  +---------------+
  1 row in set (0.01 sec)
  

• シーケンス オブジェクトのNEXTVAL()関数の最初の有効な値は、 STARTパラメータの値です。

  SELECT NEXTVAL(seq2);
  

  +---------------+
  | NEXTVAL(seq2) |
  +---------------+
  |             3 |
  +---------------+
  1 row in set (0.00 sec)
  

• SETVAL()関数はシーケンス オブジェクトの現在の値を変更できますが、次の値の等差数列の規則を変更することはできません。

  SELECT SETVAL(seq2, 6);
  

  +-----------------+
  | SETVAL(seq2, 6) |
  +-----------------+
  |               6 |
  +-----------------+
  1 row in set (0.00 sec)
  

• NEXTVAL()使用して次の値を取得する場合、次の値はシーケンスによって定義された等差数列の規則に従います。

  SELECT next value for seq2;
  

  +---------------------+
  | next value for seq2 |
  +---------------------+
  |                   7 |
  +---------------------+
  1 row in set (0.00 sec)
  

• 次の例のように、シーケンスの次の値を列のデフォルト値として使用できます。

  CREATE table t(a int default next value for seq2);
  

  Query OK, 0 rows affected (0.02 sec)
  

• 次の例では、値が指定されていないため、デフォルト値のseq2が使用されます。

  INSERT into t values();
  

  Query OK, 1 row affected (0.00 sec)
  

  SELECT * from t;
  

  +------+
  | a    |
  +------+
  |    9 |
  +------+
  1 row in set (0.00 sec)
  

• 次の例では、値が指定されていないため、デフォルト値のseq2が使用されます。しかし、次の値seq2は上記の例で定義された範囲（ CREATE SEQUENCE seq2 start 3 increment 2 minvalue 1 maxvalue 10 cache 3; ）外であるため、エラーが返されます。

  INSERT into t values();
  

  ERROR 4135 (HY000): Sequence 'test.seq2' has run out
  

MySQLの互換性

このステートメントはTiDBの拡張機能です。実装はMariaDBで利用可能なシーケンスをモデルにしています。

SETVAL関数を除くすべての関数は、MariaDB と同じ数列規則に従います。ここでの「数列規則」とは、シーケンス内の数値が、シーケンスによって定義された特定の等差数列規則に従うことを意味します。シーケンスの現在の値を設定するのにSETVAL使用できますが、シーケンスのそれ以降の値は元の数列規則に従います。

例えば：

1, 3, 5, ...            // The sequence starts from 1 and increments by 2.
select SETVAL(seq, 6)   // Sets the current value of a sequence to 6.
7, 9, 11, ...           // Subsequent values still follow the progression rule.

CYCLEモードでは、最初のラウンドのシーケンスの初期値はSTARTパラメータの値であり、後続のラウンドの初期値はMinValue ( INCREMENT > 0) またはMaxValue ( INCREMENT < 0) の値です。

参照

• シーケンスの変更
• ドロップシーケンス
• シーケンスの作成を表示
• シーケンス関数