createSequence
Creates a new database sequence.
Run createSequence
To run this Change Type, follow these steps:
- Add the Change Type to your changeset, as shown in the examples on this page.
- Specify any required attributes. Use the table on this page to see which ones your database requires.
- Deploy your changeset by running the
update
command:
liquibase update
Available attributes
Name | Description | Required | Supports |
---|---|---|---|
cacheSize
|
Number of values to fetch per query |
asany, db2, db2z, derby, h2, hsqldb, informix, ingres, mariadb, mssql, mysql, oracle, postgresql, sqlite, sybase | |
catalogName
|
Name of the catalog |
asany, db2, db2z, derby, h2, hsqldb, informix, ingres, mariadb, mssql, mysql, oracle, postgresql, sqlite, sybase | |
cycle
|
Boolean. Can the sequence cycle when it hits the max value? |
asany, db2, db2z, derby, h2, hsqldb, informix, ingres, mariadb, mssql, mysql, oracle, postgresql, sqlite, sybase | |
dataType
|
Data type of the sequence |
asany, db2z, derby, informix, postgresql | |
incrementBy
|
Integer amount to increment by at each call |
asany, db2, db2z, derby, h2, hsqldb, informix, mssql, oracle, postgresql | |
maxValue
|
Sets the maximum value of the sequence |
asany, db2, db2z, derby, h2, informix, mssql, oracle, postgresql | |
minValue
|
Sets the minimum value of the sequence |
asany, db2, db2z, derby, h2, informix, mssql, oracle, postgresql | |
ordered
|
Boolean. Does the sequence need to be guaranteed to be generated in the order of request? |
asany, db2, db2z, derby, h2, informix, oracle | |
schemaName
|
Name of the schema |
asany, db2, db2z, derby, h2, hsqldb, informix, ingres, mariadb, mssql, mysql, oracle, postgresql, sqlite, sybase | |
sequenceName
|
Name of the sequence |
all | all |
startValue
|
Initial integer value of the increment |
asany, db2, db2z, derby, h2, hsqldb, informix, mssql, oracle, postgresql |
Examples
--liquibase formatted sql
--changeset liquibase-docs:createSequence-example
CREATE SEQUENCE [public].seq_id AS int START WITH 5 INCREMENT BY 2 MINVALUE 10 MAXVALUE 1000 ORDER CYCLE;
databaseChangeLog:
- changeSet:
id: createSequence-example
author: liquibase-docs
changes:
- createSequence:
cacheSize: 371717
catalogName: cat
cycle: true
dataType: int
incrementBy: 2
maxValue: 1000
minValue: 10
ordered: true
schemaName: public
sequenceName: seq_id
startValue: 5
{
"databaseChangeLog": [
{
"changeSet": {
"id": "createSequence-example",
"author": "liquibase-docs",
"changes": [
{
"createSequence": {
"cacheSize": 371717,
"catalogName": "cat",
"cycle": true,
"dataType": "int",
"incrementBy": 2,
"maxValue": 1000,
"minValue": 10,
"ordered": true,
"schemaName": "public",
"sequenceName": "seq_id",
"startValue": 5
}
}
]
}
}
]
}
<databaseChangeLog
xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:ext="http://www.liquibase.org/xml/ns/dbchangelog-ext"
xmlns:pro="http://www.liquibase.org/xml/ns/pro"
xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog
http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-latest.xsd
http://www.liquibase.org/xml/ns/dbchangelog-ext http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-ext.xsd
http://www.liquibase.org/xml/ns/pro http://www.liquibase.org/xml/ns/pro/liquibase-pro-latest.xsd">
<changeSet author="liquibase-docs" id="createSequence-example">
<createSequence cacheSize="371717"
catalogName="cat"
cycle="true"
dataType="int"
incrementBy="2"
maxValue="1000"
minValue="10"
ordered="true"
schemaName="public"
sequenceName="seq_id"
startValue="5"/>
</changeSet>
</databaseChangeLog>
Database support
Database | Notes | Auto Rollback |
---|---|---|
DB2/LUW | Supported | Yes |
DB2/z | Supported | Yes |
Derby | Supported | Yes |
Firebird | Supported | Yes |
H2 | Supported | Yes |
HyperSQL | Supported | Yes |
INGRES | Not Supported | No |
Informix | Supported | Yes |
MariaDB | Not Supported | No |
MySQL | Not Supported | No |
Oracle | Supported | Yes |
PostgreSQL | Supported | Yes |
Snowflake | Supported | Yes |
SQL Server | Supported | Yes |
SQLite | Not Supported | No |
Sybase | Not Supported | No |
Sybase Anywhere | Supported | Yes |