schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
liquibase-3.2.json | onSqlOutput | Controls what to do in the updateSQL mode. Since 1.9.5 | {"type": "string", "oneOf": [{"const": "TEST"}, {"const": "FAIL"}, {"const": "IGNORE"}], "default": "IGNORE"} |
liquibase-3.2.json | onSqlOutput | Runs the changeset in the updateSQL mode. | {"const": "TEST"} |
liquibase-3.2.json | onSqlOutput | Fails the preCondition in the updateSQL mode. | {"const": "FAIL"} |
liquibase-3.2.json | onSqlOutput | Ignores the preCondition in the updateSQL mode (default). | {"const": "IGNORE"} |
liquibase-3.2.json | dbms | Defines if the database executed against matches the type specified. | {"type": "object", "default": {}, "required": ["type"], "properties": {"type": {"type": "string"}}} |
liquibase-3.2.json | type | The type of database expected. Multiple dbms values can be specified using comma-separated values. (required) | {"type": "string"} |
liquibase-3.2.json | runningAs | Defines if the database user executed under matches the username specified. | {"type": "object", "default": {}, "required": ["username"], "properties": {"username": {"type": "string"}}} |
liquibase-3.2.json | username | The database user script which is expected to run as. (required) | {"type": "string"} |
liquibase-3.2.json | changeSetExecuted | Defines if the specified changeset has already been executed. | {"type": "object", "default": {}, "required": ["id", "author", "changeLogFile"], "properties": {"id": {"type": "string"}, "author": {"type": "string"}, "changeLogFile": {"type": "string"}}} |
liquibase-3.2.json | id | The changeset id. (required) | {"type": "string"} |
liquibase-3.2.json | author | The changeset author. (required) | {"type": "string"} |
liquibase-3.2.json | changeLogFile | The file name (including classpath relative path) of the changeset. (required) | {"type": "string"} |
liquibase-3.2.json | columnExists | Defines if the specified column exists in the database. | {"type": "object", "default": {}, "required": ["tableName", "columnName"], "properties": {"schemaName": {"type": "string"}, "tableName": {"type": "string"}, "columnName": {"type": "string"}}} |
liquibase-3.2.json | schemaName | The name of the table's schema. | {"type": "string"} |
liquibase-3.2.json | tableName | The name of the column's table. (required) | {"type": "string"} |
liquibase-3.2.json | columnName | The name of the column. (required) | {"type": "string"} |
liquibase-3.2.json | tableExists | Defines if the specified table exists in the database. | {"type": "object", "default": {}, "required": ["tableName"], "properties": {"schemaName": {"type": "string"}, "tableName": {"type": "string"}}} |
liquibase-3.2.json | schemaName | The name of the table's schema. | {"type": "string"} |
liquibase-3.2.json | tableName | The name of the table. (required) | {"type": "string"} |
liquibase-3.2.json | viewExists | Defines if the specified view exists in the database. | {"type": "object", "default": {}, "required": ["viewName"], "properties": {"schemaName": {"type": "string"}, "viewName": {"type": "string"}}} |
liquibase-3.2.json | schemaName | The name of the view's schema. | {"type": "string"} |
liquibase-3.2.json | viewName | The name of the view. (required) | {"type": "string"} |
liquibase-3.2.json | foreignKeyConstraintExists | Defines if the specified foreign key exists in the database. | {"type": "object", "default": {}, "required": ["foreignKeyName"], "properties": {"schemaName": {"type": "string"}, "foreignKeyName": {"type": "string"}}} |
liquibase-3.2.json | schemaName | The name of the foreign key's schema. | {"type": "string"} |
liquibase-3.2.json | foreignKeyName | The name of the foreign key. (required) | {"type": "string"} |
liquibase-3.2.json | indexExists | Defines if the specified index exists in the database. You can either specify the indexName attribute or tableName and columnName attributes.
Note: There are a few databases where the indexName is not unique, that's why both indexName and tableName can be used. | {"type": "object", "default": {}, "properties": {"schemaName": {"type": "string"}, "indexName": {"type": "string"}, "tableName": {"type": "string"}, "columnName": {"type": "string"}}} |
liquibase-3.2.json | schemaName | The name of the index's schema. | {"type": "string"} |
liquibase-3.2.json | indexName | The name of the index. | {"type": "string"} |
liquibase-3.2.json | tableName | The name of the table. | {"type": "string"} |
liquibase-3.2.json | columnName | The name of the column. | {"type": "string"} |
liquibase-3.2.json | sequenceExists | Defines if the specified sequence exists in the database. | {"type": "object", "default": {}, "required": ["sequenceName"], "properties": {"schemaName": {"type": "string"}, "sequenceName": {"type": "string"}}} |
liquibase-3.2.json | schemaName | The name of the sequences' schema. | {"type": "string"} |
liquibase-3.2.json | sequenceName | The name of the sequence. (required) | {"type": "string"} |
liquibase-3.2.json | primaryKeyExists | Defines if the specified primary key exists in the database.
(tableName or primaryKeyName is required) | {"type": "object", "default": {}, "properties": {"schemaName": {"type": "string"}, "primaryKeyName": {"type": "string"}, "tableName": {"type": "string"}}} |
liquibase-3.2.json | schemaName | The name of the primary key's schema. | {"type": "string"} |
liquibase-3.2.json | primaryKeyName | The name of the primary key. | {"type": "string"} |
liquibase-3.2.json | tableName | The name of the table containing primary key. | {"type": "string"} |
liquibase-3.2.json | sqlCheck | Executes an SQL string and checks the returned value. The SQL must return a single row with a single value.
To check a number of rows, use the count SQL function.
To check for ranges of values, perform the check in the SQL and return a value that can be easily compared against. | {"type": "object", "default": {}, "required": ["expectedResult"], "properties": {"expectedResult": {"type": "integer"}, "sql": {"type": "string"}}} |
liquibase-3.2.json | expectedResult | The value to compare the SQL result to. (required) | {"type": "integer"} |
liquibase-3.2.json | changeLogPropertyDefined | Checks whether given changelog attribute is present. It fails if the value is not the same as given. | {"type": "object", "default": {}, "required": ["property"], "properties": {"property": {"type": "string"}, "value": {"type": "string"}}} |
liquibase-3.2.json | property | The name of the property to check. (required) | {"type": "string"} |
liquibase-3.2.json | value | The required value for a given property. | {"type": "string"} |
liquibase-3.2.json | customPrecondition | Can be created by adding a class that implements the liquibase.precondition.CustomPrecondition interface. Parameters on custom classes are set through reflection based on the <param> sub-tags. Pass parameters as strings to the custom precondition.
The customPrecondition sub-tags:
param - the parameter to pass to the custom precondition.
name - the name of the parameter to set. (required)
value - a string value to set parameter to. (required) | {"type": "object", "default": {}, "required": ["className"], "properties": {"className": {"type": "string"}}, "additionalProperties": true} |
liquibase-3.2.json | className | The name of the custom precondition class. (required) | {"type": "string"} |
liquibase-3.2.json | createTable | You can typically use the createTable Change Type when you want to create a table in your changelog file and then deploy it to your database. It can include columns and another values listed in this documentation. | {"type": "object", "default": {}, "required": ["tableName", "columns"], "properties": {"catalogName": {}, "schemaName": {}, "tableName": {}, "tablespace": {"type": "string", "default": ""}, "remarks": {}, "columns": {}}, "additionalProperties": true} |
liquibase-3.2.json | tablespace | The name of the tablespace in which the table is created | {"type": "string", "default": ""} |
liquibase-3.2.json | createView | Creates a new database view. | {"type": "object", "default": {}, "properties": {"catalogName": {}, "schemaName": {}, "viewName": {"type": "string", "default": ""}, "remarks": {}, "replaceIfExists": {"type": "boolean", "default": false}, "fullDefinition": {"type": "boolean", "default": false}, "path": {"type": "string", "default": ""}, "encoding": {"type": "string", "default": ""}, "relativeToChangelogFile": {"type": "boolean", "default": false}, "selectQuery": {"type": "string", "default": ""}}, "additionalProperties": true} |
liquibase-3.2.json | viewName | Name of the view to create | {"type": "string", "default": ""} |
liquibase-3.2.json | replaceIfExists | Use 'create or replace' syntax | {"type": "boolean", "default": false} |
liquibase-3.2.json | fullDefinition | Set to true if selectQuery is the entire view definition. False if the CREATE VIEW header should be added. | {"type": "boolean", "default": false} |
liquibase-3.2.json | path | Path to file containing view definition | {"type": "string", "default": ""} |
liquibase-3.2.json | encoding | Encoding used in the file defined in the `path` attribute | {"type": "string", "default": ""} |
liquibase-3.2.json | relativeToChangelogFile | Whether the file path relative to the root changelog file rather than to the classpath. | {"type": "boolean", "default": false} |
liquibase-3.2.json | selectQuery | SQL for generating the view | {"type": "string", "default": ""} |
liquibase-3.2.json | sql | It is useful for complex changes that aren't supported through Liquibase's automated Change Types and to work around bugs and limitations of Liquibase. The SQL contained in the <SQL> Change Type can be multi-line. | {"type": "object", "default": {}, "required": ["sql"], "properties": {"stripComments": {"type": "boolean", "default": false}, "splitStatements": {"type": "boolean", "default": false}, "endDelimiter": {"type": "string", "default": ""}, "dbms": {}, "comment": {"type": "string", "default": ""}, "sql": {"type": "string", "default": ""}}, "additionalProperties": true} |
liquibase-3.2.json | stripComments | Set to true to remove any comments in the SQL before executing, otherwise false. | {"type": "boolean", "default": false} |
liquibase-3.2.json | splitStatements | Set to false to not have Liquibase split statements on ;'s and GO's. Defaults to true if not set | {"type": "boolean", "default": false} |
liquibase-3.2.json | endDelimiter | Indicates the end of the SQL statement and prevents incomplete SQL statements from being processed when the SQL files contain statements referencing a ; which Liquibase treats as the default end delimiter. You can use the endDelimiter when the changeset contains SQL to create a stored procedure or function that contains the default ; end delimiter to separate the statements inside the procedure.
For more information, see The endDelimiter SQL attribute. | {"type": "string", "default": ""} |
liquibase-3.2.json | sql | Specifies the SQL to execute | {"type": "string", "default": ""} |
liquibase-3.2.json | update | You can typically use the update Change Type when you want to update a table in your changelog file and then deploy this update to your database. It can include columns and another values listed in this documentation. | {"type": "object", "default": {}, "required": ["tableName", "columns"], "properties": {"catalogName": {}, "schemaName": {}, "tableName": {}, "columns": {}, "where": {}, "whereParams": {}}, "additionalProperties": true} |
liquibase-3.2.json | delete | Deletes data from an existing table. | {"type": "object", "default": {}, "required": ["tableName"], "properties": {"catalogName": {}, "schemaName": {}, "tableName": {}, "where": {}, "whereParams": {}}, "additionalProperties": true} |
liquibase-3.2.json | value | Value of the attribute.
Note: If not set, then the first valueXXX defined is used in the order they appear. | {"type": "string", "default": ""} |
liquibase-3.2.json | valueNumeric | integer value of the attribute. | {"type": "number", "default": ""} |
liquibase-3.2.json | valueBoolean | boolean value of the attribute. | {"type": "boolean", "default": ""} |
liquibase-3.2.json | valueDate | Date and/or Time value to set the attribute to. The value shall be specified in one of the following forms: "YYYY-MM-DD", "hh:mm:ss" or "YYYY-MM-DDThh:mm:ss". | {"type": "string", "default": ""} |
liquibase-3.2.json | valueComputed | A value that is returned from a function or procedure call. This attribute shall contain the function name to call. | {"type": "string", "default": ""} |
liquibase-3.2.json | valueSequenceNext | Name of the sequence which next value is used | {"type": "string", "default": ""} |
liquibase-3.2.json | valueSequenceCurrent | Name of the sequence which current value is used | {"type": "string", "default": ""} |
liquibase-3.2.json | tagDatabase | The tagDatabase Change Type applies a tag to the database for future update or rollback. | {"type": "object", "default": {}, "required": ["tag"], "properties": {"tag": {"type": "string", "default": ""}}, "additionalProperties": true} |
liquibase-3.2.json | tag | The tag to apply | {"type": "string", "default": ""} |
liquibase-3.2.json | dropTable | Drops an existing table from your database. | {"type": "object", "default": {}, "required": ["tableName"], "properties": {"catalogName": {}, "schemaName": {}, "tableName": {}, "cascadeConstraints": {"type": "boolean", "default": false}}, "additionalProperties": true} |
liquibase-3.2.json | cascadeConstraints | Add the `CASCADE CONSTRAINTS` to the statement | {"type": "boolean", "default": false} |
liquibase-3.2.json | oldViewName | Name of the view to rename | {"type": "string", "default": ""} |
liquibase-3.2.json | newViewName | Name to rename the view to | {"type": "string", "default": ""} |
liquibase-3.2.json | dropView | Drops an existing view. | {"type": "object", "default": {}, "required": ["viewName"], "properties": {"viewName": {"type": "string", "default": ""}, "catalogName": {}, "schemaName": {}}, "additionalProperties": true} |
liquibase-3.2.json | viewName | Name of the view to drop | {"type": "string", "default": ""} |
liquibase-3.2.json | empty | empty | {"type": "object", "default": {}, "additionalProperties": true} |
liquibase-3.2.json | insert | You can typically use the insert Change Type when you want to add and deploy the specific data or values to the existing table in your database. It can include columns and another attributes listed in this documentation. | {"type": "object", "default": {}, "required": ["tableName"], "properties": {"catalogName": {}, "schemaName": {}, "tableName": {}, "dbms": {}, "columns": {}}, "additionalProperties": true} |
liquibase-3.2.json | addColumn | You can typically use the addColumn Change Type when you want to add a new column and deploy it to the table in your database. | {"type": "object", "default": {}, "required": ["tableName", "columns"], "properties": {"catalogName": {}, "schemaName": {}, "tableName": {}, "columns": {}}, "additionalProperties": true} |
liquibase-3.2.json | createProcedure | The createProcedure Change Type defines the definition for a stored procedure. This Change Type is better to use for creating procedures than the raw SQL command because it will not attempt to strip comments or break up lines.
Often times it is best to use the CREATE OR REPLACE syntax along with setting runOnChange='true' on the enclosing changeset tag. That way if you need to make a change to your procedure, you can change your existing code rather than creating a new REPLACE PROCEDURE call. The advantage to this approach is that it keeps your changelog smaller and allows you to more easily see what has changed in your procedure code through your source control system's diff command. | {"type": "object", "default": {}, "required": ["path", "procedureText"], "properties": {"catalogName": {}, "schemaName": {}, "procedureText": {"type": "string", "default": ""}, "procedureName": {"type": "string", "default": ""}, "path": {"type": "string", "default": ""}, "encoding": {"type": "string", "default": ""}, "relativeToChangelogFile": {"type": "boolean", "default": false}, "dbms": {}, "replaceIfExists": {"type": "boolean", "default": ""}, "comments": {"type": "string", "default": ""}}, "additionalProperties": true} |
liquibase-3.2.json | procedureText | The SQL creating the procedure. You need to define either this attribute or the path attribute. The procedureText attribute is not supported in the XML format; however, you can specify the procedure SQL within <createProcedure></<createProcedure> tags. See the XML example. | {"type": "string", "default": ""} |
liquibase-3.2.json | procedureName | The name of the procedure. It is required if replaceIfExists= true | {"type": "string", "default": ""} |
liquibase-3.2.json | path | The file containing the procedure text. Either this attribute or a nested procedure text is required. | {"type": "string", "default": ""} |
liquibase-3.2.json | encoding | The encoding used in the file defined in the `path` attribute | {"type": "string", "default": ""} |
liquibase-3.2.json | relativeToChangelogFile | Defines whether the file path is relative to the root changelog file rather than to the classpath. | {"type": "boolean", "default": false} |
liquibase-3.2.json | replaceIfExists | If the stored procedure defined by procedureName already exits, alter it instead of creating it. | {"type": "boolean", "default": ""} |
liquibase-3.2.json | comments | The comments you can specify in the changeset. | {"type": "string", "default": ""} |
liquibase-3.2.json | dropProcedure | Drops an existing procedure | {"type": "object", "default": {}, "required": ["procedureName"], "properties": {"procedureName": {"type": "string", "default": ""}, "catalogName": {}, "schemaName": {}}, "additionalProperties": true} |
liquibase-3.2.json | procedureName | Name of the stored procedure to drop | {"type": "string", "default": ""} |
liquibase-3.2.json | sqlFile | The <sqlFile> Change Type is useful for complex changes that are not supported through Liquibase automated Change Types such as stored procedures. The SQL contained in the <sqlFile> Change Type can be multi-line. | {"type": "object", "default": {}, "required": ["path"], "properties": {"path": {"type": "string", "default": ""}, "stripComments": {"type": "boolean", "default": false}, "splitStatements": {"type": "boolean", "default": false}, "encoding": {"type": "string", "default": ""}, "endDelimiter": {"type": "string", "default": ""}, "relativeToChangelogFile": {"type": "boolean", "default": false}, "dbms": {}, "comment": {"type": "string", "default": ""}}, "additionalProperties": true} |
liquibase-3.2.json | path | Specifies the file path of the SQL file to load. | {"type": "string", "default": ""} |
liquibase-3.2.json | stripComments | Set to true to remove any comments in the SQL before executing, otherwise false. | {"type": "boolean", "default": false} |
liquibase-3.2.json | splitStatements | Set to false to not have Liquibase split statements on ;'s and GO's. Defaults to true if not set. | {"type": "boolean", "default": false} |
liquibase-3.2.json | encoding | Specifies encoding used in the file defined in the `path` attribute. | {"type": "string", "default": ""} |
liquibase-3.2.json | endDelimiter | Indicates the end of the SQL statement and prevents incomplete SQL statements from being processed when the SQL files contain statements referencing a ; which Liquibase treats as the default end delimiter. You can use the endDelimiter when the changeset contains SQL to create a stored procedure or function that contains the default ; end delimiter to separate the statements inside the procedure.
For more information, see The endDelimiter SQL attribute. | {"type": "string", "default": ""} |
liquibase-3.2.json | relativeToChangelogFile | Indicates whether the file path is relative to the root changelog file rather than to the classpath. | {"type": "boolean", "default": false} |
liquibase-3.2.json | stop | Stops Liquibase execution with a message. Mainly useful for debugging and stepping through a changelog | {"type": "object", "default": {}, "properties": {"message": {"type": "string", "default": ""}}, "additionalProperties": true} |
liquibase-3.2.json | message | Message to output when execution stops | {"type": "string", "default": ""} |
liquibase-3.2.json | renameTable | Renames an existing table. | {"type": "object", "default": {}, "required": ["newTableName", "oldTableName"], "properties": {"catalogName": {}, "schemaName": {}, "oldTableName": {"type": "string", "default": ""}, "newTableName": {"type": "string", "default": ""}}, "additionalProperties": true} |
liquibase-3.2.json | oldTableName | Name of the table to rename | {"type": "string", "default": ""} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.