schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
liquibase-3.2.json
newTableName
New name for the table
{"type": "string", "default": ""}
liquibase-3.2.json
renameColumn
Renames an existing column.
{"type": "object", "default": {}, "required": ["newColumnName", "oldColumnName", "tableName"], "properties": {"catalogName": {}, "schemaName": {}, "tableName": {}, "oldColumnName": {"type": "string", "default": ""}, "newColumnName": {"type": "string", "default": ""}, "columnDataType": {"type": "string", "default": ""}, "remarks": {"type": "string", "default": ""}}, "additionalProperties": true}
liquibase-3.2.json
oldColumnName
Name of the existing column to rename
{"type": "string", "default": ""}
liquibase-3.2.json
newColumnName
Name to rename the column to
{"type": "string", "default": ""}
liquibase-3.2.json
columnDataType
Data type of the column
{"type": "string", "default": ""}
liquibase-3.2.json
remarks
Remarks of the column
{"type": "string", "default": ""}
liquibase-3.2.json
dropColumn
Drops an existing column(s). To drop a single column, use the simple form of this element where the tableName and columnName are specified as attributes. To drop several columns, specify the tableName as an attribute, and then specify a set of nested <column> tags. If nested <column> tags are present, the columnName attribute will be ignored.
{"type": "object", "default": {}, "required": ["tableName"], "properties": {"catalogName": {}, "schemaName": {}, "tableName": {}, "columnName": {"type": "string", "default": ""}, "columns": {}}, "additionalProperties": true}
liquibase-3.2.json
columnName
Name of the column to drop, if dropping a single column. Ignored if nested 'column's are defined
{"type": "string", "default": ""}
liquibase-3.2.json
mergeColumns
The mergeColumns Change Type concatenates the values in two columns and joins them with a string. The Change Type stores the resulting value in a new column. You can typically use the mergeColumns Change Type when you want to combine the values from two columns into one.
{"type": "object", "default": {}, "required": ["column1Name", "column2Name", "finalColumnName", "finalColumnType", "tableName"], "properties": {"catalogName": {}, "schemaName": {}, "tableName": {}, "column1Name": {"type": "string", "default": ""}, "joinString": {"type": "string", "default": ""}, "column2Name": {"type": "string", "default": ""}, "finalColumnName": {"type": "string", "default": ""}, "finalColumnType": {"type": "string", "default": ""}}, "additionalProperties": true}
liquibase-3.2.json
column1Name
The name of the column containing the first half of the data
{"type": "string", "default": ""}
liquibase-3.2.json
joinString
The string to place between the values from column1 and column2 (may be empty)
{"type": "string", "default": ""}
liquibase-3.2.json
column2Name
The name of the column containing the second half of the data
{"type": "string", "default": ""}
liquibase-3.2.json
finalColumnName
The name of the column to create
{"type": "string", "default": ""}
liquibase-3.2.json
finalColumnType
The data type of the column to create
{"type": "string", "default": ""}
liquibase-3.2.json
modifyDataType
Allows you to modify data types.
{"type": "object", "default": {}, "required": ["columnName", "newDataType", "tableName"], "properties": {"catalogName": {}, "schemaName": {}, "tableName": {}, "columnName": {"type": "string", "default": ""}, "newDataType": {"type": "string", "default": ""}}, "additionalProperties": true}
liquibase-3.2.json
columnName
Name of the column
{"type": "string", "default": ""}
liquibase-3.2.json
createSequence
Creates a new database sequence.
{"type": "object", "default": {}, "required": ["sequenceName"], "properties": {"catalogName": {}, "schemaName": {}, "sequenceName": {"type": "string", "default": ""}, "startValue": {"type": "integer", "default": ""}, "incrementBy": {"type": "integer", "default": ""}, "maxValue": {"type": "integer", "default": ""}, "minValue": {"type": "integer", "default": ""}, "ordered": {"type": "boolean", "default": ""}, "cacheSize": {"type": "integer", "default": ""}, "dataType": {"type": "string", "default": ""}, "cycle": {"type": "boolean", "default": ""}}, "additionalProperties": true}
liquibase-3.2.json
sequenceName
Name of the sequence to create
{"type": "string", "default": ""}
liquibase-3.2.json
startValue
The first sequence number to be generated.
{"type": "integer", "default": ""}
liquibase-3.2.json
incrementBy
Interval between sequence numbers
{"type": "integer", "default": ""}
liquibase-3.2.json
maxValue
The maximum value of the sequence
{"type": "integer", "default": ""}
liquibase-3.2.json
minValue
The minimum value of the sequence
{"type": "integer", "default": ""}
liquibase-3.2.json
ordered
Does the sequence need to be guaranteed to be generated in the order of request?
{"type": "boolean", "default": ""}
liquibase-3.2.json
cacheSize
Number of values to fetch per query
{"type": "integer", "default": ""}
liquibase-3.2.json
dataType
Data type of the sequence
{"type": "string", "default": ""}
liquibase-3.2.json
cycle
Can the sequence cycle when it hits the max value?
{"type": "boolean", "default": ""}
liquibase-3.2.json
alterSequence
Alters properties of an existing sequence.
{"type": "object", "default": {}, "required": ["sequenceName"], "properties": {"catalogName": {}, "schemaName": {}, "sequenceName": {"type": "string", "default": ""}, "incrementBy": {"type": "integer", "default": ""}, "maxValue": {"type": "integer", "default": ""}, "minValue": {"type": "integer", "default": ""}, "ordered": {"type": "boolean", "default": ""}, "cacheSize": {"type": "integer", "default": ""}, "dataType": {"type": "string", "default": ""}, "cycle": {"type": "boolean", "default": ""}}, "additionalProperties": true}
liquibase-3.2.json
sequenceName
Name of the sequence to alter
{"type": "string", "default": ""}
liquibase-3.2.json
incrementBy
New amount the sequence should increment by
{"type": "integer", "default": ""}
liquibase-3.2.json
maxValue
New maximum value for the sequence
{"type": "integer", "default": ""}
liquibase-3.2.json
minValue
New minimum value for the sequence
{"type": "integer", "default": ""}
liquibase-3.2.json
ordered
Does the sequence need to be guaranteed to be generated in the order of request?
{"type": "boolean", "default": ""}
liquibase-3.2.json
cacheSize
Change the cache size
{"type": "integer", "default": ""}
liquibase-3.2.json
dataType
Data type of the sequence
{"type": "string", "default": ""}
liquibase-3.2.json
cycle
Can the sequence cycle when it hits the max value?
{"type": "boolean", "default": ""}
liquibase-3.2.json
dropSequence
Drops an existing sequence.
{"type": "object", "default": {}, "required": ["sequenceName"], "properties": {"catalogName": {}, "schemaName": {}, "sequenceName": {"type": "string", "default": ""}}, "additionalProperties": true}
liquibase-3.2.json
sequenceName
Name of the sequence to drop
{"type": "string", "default": ""}
liquibase-3.2.json
renameSequence
Renames an existing sequence.
{"type": "object", "default": {}, "required": ["newSequenceName", "oldSequenceName"], "properties": {"catalogName": {}, "schemaName": {}, "oldSequenceName": {"type": "string", "default": ""}, "newSequenceName": {"type": "string", "default": ""}}, "additionalProperties": true}
liquibase-3.2.json
oldSequenceName
Name of the sequence to rename
{"type": "string", "default": ""}
liquibase-3.2.json
newSequenceName
New name for the sequence
{"type": "string", "default": ""}
liquibase-3.2.json
createIndex
The createIndex Change Type creates an index on an existing column or a set of columns.
{"type": "object", "default": {}, "required": ["tableName"], "properties": {"catalogName": {}, "schemaName": {}, "tableName": {}, "indexName": {"type": "string", "default": ""}, "associatedWith": {"type": "string", "default": ""}, "unique": {"type": "boolean", "default": false}, "clustered": {"type": "boolean", "default": false}, "tablespace": {"type": "string", "default": ""}, "column": {}, "columns": {}}, "additionalProperties": true}
liquibase-3.2.json
indexName
The name of the index to create.
{"type": "string", "default": ""}
liquibase-3.2.json
unique
The unique values in the index.
{"type": "boolean", "default": false}
liquibase-3.2.json
clustered
The attribute that creates a clustered index.
{"type": "boolean", "default": false}
liquibase-3.2.json
tablespace
The tablespace in which you create the index.
{"type": "string", "default": ""}
liquibase-3.2.json
dropIndex
The dropIndex Change Type drops an existing index on a column.
{"type": "object", "default": {}, "required": ["indexName"], "properties": {"catalogName": {}, "schemaName": {}, "tableName": {}, "indexName": {"type": "string", "default": ""}, "associatedWith": {"type": "string", "default": ""}}, "additionalProperties": true}
liquibase-3.2.json
indexName
The name of the index to drop.
{"type": "string", "default": ""}
liquibase-3.2.json
addNotNullConstraint
The addNotNullConstraint Change Type adds a NOT NULL constraint to an existing table.
{"type": "object", "default": {}, "required": ["columnName", "tableName"], "properties": {"catalogName": {}, "schemaName": {}, "tableName": {}, "columnName": {"type": "string", "default": ""}, "defaultNullValue": {"type": "string", "default": ""}, "columnDataType": {"type": "string", "default": ""}, "constraintName": {"type": "string", "default": ""}, "validate": {"type": "boolean", "default": false}}, "additionalProperties": true}
liquibase-3.2.json
columnName
The name of the column for which to add the constraint.
{"type": "string", "default": ""}
liquibase-3.2.json
defaultNullValue
The value for which you can set all values that currently equal null in a column. If null values exist and if defaultNullValue is not set, the change will fail.
{"type": "string", "default": ""}
liquibase-3.2.json
columnDataType
The current data type of the column.
{"type": "string", "default": ""}
liquibase-3.2.json
constraintName
The created constraint name (if database supports names for NOT NULL constraints).
{"type": "string", "default": ""}
liquibase-3.2.json
validate
The attribute which is true if the NOT NULL constraint has 'ENABLE VALIDATE' set, or which is false if the NOT NULL constrain has 'ENABLE NOVALIDATE' set.
{"type": "boolean", "default": false}
liquibase-3.2.json
dropNotNullConstraint
Makes a column nullable.
{"type": "object", "default": {}, "required": ["columnName", "tableName"], "properties": {"catalogName": {}, "schemaName": {}, "tableName": {}, "columnName": {"type": "string", "default": ""}, "columnDataType": {"type": "string", "default": ""}}, "additionalProperties": true}
liquibase-3.2.json
columnName
Name of the column to drop the constraint from
{"type": "string", "default": ""}
liquibase-3.2.json
columnDataType
Current data type of the column
{"type": "string", "default": ""}
liquibase-3.2.json
addForeignKeyConstraint
Adds a foreign key constraint to an existing column.
{"type": "object", "default": {}, "required": ["baseColumnNames", "baseTableName", "constraintName", "referencedColumnNames", "referencedTableName"], "properties": {"baseTableCatalogName": {"type": "string", "default": ""}, "baseTableSchemaName": {"type": "string", "default": ""}, "baseTableName": {"type": "string", "default": ""}, "baseColumnNames": {"type": "string", "default": ""}, "constraintName": {"type": "string", "default": ""}, "referencedTableCatalogName": {"type": "string", "default": ""}, "referencedTableSchemaName": {"type": "string", "default": ""}, "referencedTableName": {"type": "string", "default": ""}, "referencedColumnNames": {"type": "string", "default": ""}, "deferrable": {"type": "boolean", "default": false}, "initiallyDeferred": {"type": "boolean", "default": false}, "deleteCascade": {"type": "boolean", "default": false}, "onDelete": {"type": "string", "default": ""}, "onUpdate": {"type": "string", "default": ""}, "referencesUniqueColumn": {"type": "boolean", "default": false}, "validate": {"type": "boolean", "default": false}}, "additionalProperties": true}
liquibase-3.2.json
baseTableCatalogName
Catalog name of the base table
{"type": "string", "default": ""}
liquibase-3.2.json
baseTableSchemaName
Schema name of the base table
{"type": "string", "default": ""}
liquibase-3.2.json
baseTableName
Name of the table containing the column to constraint
{"type": "string", "default": ""}
liquibase-3.2.json
baseColumnNames
Name of column(s) to place the foreign key constraint on. Comma-separate if multiple
{"type": "string", "default": ""}
liquibase-3.2.json
constraintName
Name of the new foreign key constraint
{"type": "string", "default": ""}
liquibase-3.2.json
referencedTableCatalogName
Schema name of the referenced table
{"type": "string", "default": ""}
liquibase-3.2.json
referencedTableSchemaName
Schema name of the referenced table
{"type": "string", "default": ""}
liquibase-3.2.json
referencedTableName
Name of the table the foreign key points to
{"type": "string", "default": ""}
liquibase-3.2.json
referencedColumnNames
Column(s) the foreign key points to. Comma-separate if multiple
{"type": "string", "default": ""}
liquibase-3.2.json
deferrable
Is the foreign key deferrable
{"type": "boolean", "default": false}
liquibase-3.2.json
initiallyDeferred
Is the foreign key initially deferred
{"type": "boolean", "default": false}
liquibase-3.2.json
onDelete
ON DELETE functionality. Possible values: 'CASCADE', 'SET NULL', 'SET DEFAULT', 'RESTRICT', 'NO ACTION'
{"type": "string", "default": ""}
liquibase-3.2.json
onUpdate
ON UPDATE functionality. Possible values: 'CASCADE', 'SET NULL', 'SET DEFAULT', 'RESTRICT', 'NO ACTION'
{"type": "string", "default": ""}
liquibase-3.2.json
validate
Shall be true if the foreign key should 'ENABLE VALIDATE' set, or false if the foreign key should 'ENABLE NOVALIDATE' set.
{"type": "boolean", "default": false}
liquibase-3.2.json
dropForeignKeyConstraint
Drops an existing foreign key.
{"type": "object", "default": {}, "required": ["baseTableName", "constraintName"], "properties": {"baseTableCatalogName": {"type": "string", "default": ""}, "baseTableSchemaName": {"type": "string", "default": ""}, "baseTableName": {"type": "string", "default": ""}, "constraintName": {"type": "string", "default": ""}}, "additionalProperties": true}
liquibase-3.2.json
baseTableName
Name of the table containing the column constrained by the foreign key
{"type": "string", "default": ""}
liquibase-3.2.json
constraintName
Name of the foreign key constraint to drop
{"type": "string", "default": ""}
liquibase-3.2.json
dropAllForeignKeyConstraints
Drops all foreign key constraints for a table.
{"type": "object", "default": {}, "required": ["baseTableName"], "properties": {"baseTableCatalogName": {"type": "string", "default": ""}, "baseTableSchemaName": {"type": "string", "default": ""}, "baseTableName": {"type": "string", "default": ""}}, "additionalProperties": true}
liquibase-3.2.json
baseTableCatalogName
Catalog name of the table containing columns constrained by foreign keys
{"type": "string", "default": ""}
liquibase-3.2.json
baseTableSchemaName
Schema name of the table containing columns constrained by foreign keys
{"type": "string", "default": ""}
liquibase-3.2.json
baseTableName
Name of the table containing columns constrained by foreign keys
{"type": "string", "default": ""}
liquibase-3.2.json
addPrimaryKey
Adds a primary key out of an existing column or set of columns.
{"type": "object", "default": {}, "required": ["columnNames", "tableName"], "properties": {"catalogName": {}, "schemaName": {}, "tableName": {}, "columnNames": {"type": "string", "default": ""}, "constraintName": {"type": "string", "default": ""}, "tablespace": {"type": "string", "default": ""}, "clustered": {"type": "boolean", "default": false}, "forIndexCatalogName": {"type": "string", "default": ""}, "forIndexSchemaName": {"type": "string", "default": ""}, "forIndexName": {"type": "string", "default": ""}, "validate": {"type": "boolean", "default": false}}, "additionalProperties": true}
liquibase-3.2.json
columnNames
Name of the column(s) to create the primary key on. Comma separated if multiple
{"type": "string", "default": ""}
liquibase-3.2.json
constraintName
Name of primary key constraint
{"type": "string", "default": ""}
liquibase-3.2.json
validate
This is true if the primary key has 'ENABLE VALIDATE' set, or false if the primary key has 'ENABLE NOVALIDATE' set.
{"type": "boolean", "default": false}
liquibase-3.2.json
dropPrimaryKey
The dropPrimaryKey Change Type drops an existing primary key in the table.
{"type": "object", "default": {}, "required": ["tableName"], "properties": {"catalogName": {}, "schemaName": {}, "tableName": {}, "constraintName": {"type": "string", "default": ""}, "dropIndex": {"type": "boolean", "default": ""}}, "additionalProperties": true}
liquibase-3.2.json
constraintName
The name of the primary key.
{"type": "string", "default": ""}
liquibase-3.2.json
dropIndex
The index to drop.
{"type": "boolean", "default": ""}
liquibase-3.2.json
addLookupTable
Creates a lookup table containing values stored in a column and creates a foreign key to the new table.
{"type": "object", "default": {}, "required": ["existingColumnName", "existingTableName", "newColumnName", "newTableName"], "properties": {"existingTableCatalogName": {"type": "string", "default": ""}, "existingTableSchemaName": {"type": "string", "default": ""}, "existingTableName": {"type": "string", "default": ""}, "existingColumnName": {"type": "string", "default": ""}, "newTableCatalogName": {"type": "string", "default": ""}, "newTableSchemaName": {"type": "string", "default": ""}, "newTableName": {"type": "string", "default": ""}, "newColumnName": {"type": "string", "default": ""}, "newColumnDataType": {"type": "string", "default": ""}, "constraintName": {"type": "string", "default": ""}}, "additionalProperties": true}
liquibase-3.2.json
existingTableName
Name of the table containing the data to extract
{"type": "string", "default": ""}
liquibase-3.2.json
existingColumnName
Name of the column in the new table to create
{"type": "string", "default": ""}
liquibase-3.2.json
newTableName
Name of lookup table to create
{"type": "string", "default": ""}
liquibase-3.2.json
newColumnName
Name of the column in the new table to create
{"type": "string", "default": ""}
liquibase-3.2.json
newColumnDataType
Data type of the new table column
{"type": "string", "default": ""}
liquibase-3.2.json
constraintName
Name of the foreign-key constraint to create between the existing table and the lookup table
{"type": "string", "default": ""}
liquibase-3.2.json
addAutoIncrement
Converts an existing column to be an auto-increment (a.k.a 'identity') column.
{"type": "object", "default": {}, "required": ["columnName", "tableName"], "properties": {"catalogName": {}, "schemaName": {}, "tableName": {}, "columnName": {"type": "string", "default": ""}, "defaultOnNull": {"type": "boolean", "default": ""}, "generationType": {"enum": ["ALWAYS", "BY DEFAULT"], "default": ""}, "columnDataType": {"type": "string", "default": ""}, "startWith": {"type": "integer", "default": 0}, "incrementBy": {"type": "integer", "default": 0}}, "additionalProperties": true}
liquibase-3.2.json
columnName
Name of the column
{"type": "string", "default": ""}
liquibase-3.2.json
defaultOnNull
When using generationType 'BY DEFAULT' then defaultOnNull = true allows the identity to be used if the identity column is referenced, but a value of NULL is specified.
{"type": "boolean", "default": ""}
liquibase-3.2.json
generationType
Type of the generation in 'GENERATED %s AS IDENTITY'. ALWAYS | BY DEFAULT
{"enum": ["ALWAYS", "BY DEFAULT"], "default": ""}
liquibase-3.2.json
columnDataType
Current data type of the column to make auto-increment
{"type": "string", "default": ""}
liquibase-3.2.json
startWith
Initial integer value of the increment
{"type": "integer", "default": 0}
liquibase-3.2.json
incrementBy
Integer value the increment increments at each call
{"type": "integer", "default": 0}
liquibase-3.2.json
addDefaultValue
The addDefaultValue Change Type adds a default value to the database definition for the specified column.
{"type": "object", "default": {}, "required": ["columnName", "tableName"], "properties": {"catalogName": {}, "schemaName": {}, "tableName": {}, "columnName": {"type": "string", "default": ""}, "columnDataType": {"type": "string", "default": ""}, "defaultValue": {"type": "string", "default": ""}, "defaultValueNumeric": {"type": "number", "default": ""}, "defaultValueDate": {"type": "string", "default": ""}, "defaultValueBoolean": {"type": "boolean", "default": ""}, "defaultValueComputed": {"type": "string", "default": ""}, "defaultValueSequenceNext": {"type": "string", "default": ""}, "defaultValueConstraintName": {"type": "string", "default": ""}}, "additionalProperties": true}