schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
ize-spec.json
timeout
(optional) ECS deployment timeout can be specified here.
{"type": "integer"}
ize-spec.json
docker_registry
(optional) Docker registry can be set here. By default it uses ECR repo with the name of the service.
{"type": "string"}
ize-spec.json
skip_deploy
(optional) skip deploy app.
{"type": "boolean"}
ize-spec.json
icon
(optional) set icon
{"type": "string"}
ize-spec.json
aws_region
(optional) ECS-specific AWS Region of this environment should be specified here. Normally global AWS_REGION is used.
{"type": "string"}
ize-spec.json
aws_profile
(optional) ECS-specific AWS profile (optional) can be specified here (but normally it should be inherited from a global AWS_PROFILE).
{"type": "string"}
ize-spec.json
depends_on
(optional) expresses startup and shutdown dependencies between apps
{"type": "array"}
ize-spec.json
serverless
Serverless app configuration.
{"id": "#/definitions/serverless", "type": "object", "properties": {"file": {"type": "string"}, "node_version": {"type": "string"}, "create_domain": {"type": "boolean"}, "path": {"type": "string"}, "sls_node_modules_cache_mount": {"type": "string"}, "env": {"type": "array", "items": {"type": "string"}}, "icon": {"type": "string"}, "aws_region": {"type": "string"}, "aws_profile": {"type": "string"}, "depends_on": {"type": "array"}}, "additionalProperties": false}
ize-spec.json
file
(optional) Path to serverless file can be specified here. Normally it's serverless.yml in the app directory.
{"type": "string"}
ize-spec.json
node_version
(optional) Node version that will be used by nvm can be specified here that. Default is v14.
{"type": "string"}
ize-spec.json
create_domain
(optional) Create domain for the serverless domain manager during the deployment.
{"type": "boolean"}
ize-spec.json
path
(optional) Path to the serverless app directory can be specified here. Normally it's derived from app directory and app name.
{"type": "string"}
ize-spec.json
sls_node_modules_cache_mount
(optional) SLS node_modules cache mount path can be specified here. It's used to store cache during CI/CD process.
{"type": "string"}
ize-spec.json
env
environments
{"type": "array", "items": {"type": "string"}}
ize-spec.json
items
environment
{"type": "string"}
ize-spec.json
icon
(optional) set icon
{"type": "string"}
ize-spec.json
aws_region
(optional) Serverless-specific AWS Region of this environment should be specified here. Normally global AWS_REGION is used.
{"type": "string"}
ize-spec.json
aws_profile
(optional) Serverless-specific AWS profile (optional) can be specified here (but normally it should be inherited from a global AWS_PROFILE).
{"type": "string"}
ize-spec.json
depends_on
(optional) expresses startup and shutdown dependencies between apps
{"type": "array"}
ize-spec.json
alias
Alias configuration.
{"id": "#/definitions/alias", "type": "object", "properties": {"icon": {"type": "string"}, "depends_on": {"type": "array"}}, "additionalProperties": false}
ize-spec.json
icon
(optional) set icon
{"type": "string"}
ize-spec.json
depends_on
(optional) expresses startup and shutdown dependencies between apps
{"type": "array"}
ize-spec.json
terraform
Terraform configuration
{"id": "#/definitions/terraform", "type": "object", "properties": {"version": {"type": "string"}, "state_bucket_region": {"type": "string"}, "state_bucket_name": {"type": "string"}, "state_name": {"type": "string"}, "root_domain_name": {"type": "string"}, "aws_region": {"type": "string"}, "aws_profile": {"type": "string"}}, "additionalProperties": false}
ize-spec.json
version
(optional) Terraform version can be set here. 1.1.3 by default.
{"type": "string"}
ize-spec.json
state_bucket_region
(optional) Terraform state bucket region can be specified here. Normally AWS_REGION is used here. Can be overridden via env vars or flags.
{"type": "string"}
ize-spec.json
state_bucket_name
(optional) Terraform state bucket name can be specified here. Normally it's generated and defaults to <NAMESPACE>-tf-state
{"type": "string"}
ize-spec.json
state_name
(optional) Terraform state name that will be used in the .tfstate file. Normally it's 'terraform' or state name.
{"type": "string"}
ize-spec.json
root_domain_name
(optional) Root domain name can be set here. This is the main domain that will be passed to the terraform. Generally if your app lives at 'api.dev.nutcorp.net' the root domain is `nutcorp.net`
{"type": "string"}
ize-spec.json
aws_region
(optional) Terraform-specific AWS Region of this environment should be specified here. Normally global AWS_REGION is used.
{"type": "string"}
ize-spec.json
aws_profile
(optional) Terraform-specific AWS profile (optional) can be specified here (but normally it should be inherited from a global AWS_PROFILE).
{"type": "string"}
liquibase-3.2.json
catalogName
The name of the catalog
{"type": "string", "default": ""}
liquibase-3.2.json
schemaName
The name of the schema
{"type": "string", "default": ""}
liquibase-3.2.json
remarks
The comments stored for the table/view/column
{"type": "string", "default": ""}
liquibase-3.2.json
tableName
The name of the table
{"type": "string", "default": ""}
liquibase-3.2.json
where
Allows to define the 'where' condition(s) string
{"type": "string", "default": ""}
liquibase-3.2.json
dbms
Specifies logical expression of database type(s) on which the change must be applied. Valid database type names are listed on the supported databases page. It can be a comma-separated list of multiple databases or you can also specify that a change is not applicable to a particular database type by prefixing with !. The keywords all and none are also available.
{"type": "string", "default": ""}
liquibase-3.2.json
name
The name of the column.
{"type": "string", "default": ""}
liquibase-3.2.json
computed
The attribute which is used if the value in name isn't actually a column name but a function. Since 3.3.0
{"type": "boolean", "default": false}
liquibase-3.2.json
descending
The boolean attribute which allows you to specify that a column should be used in a descending order in the index if it is used in a createIndex command. Default value is false (in an ascending order) Since 3.4
{"type": "boolean", "default": false}
liquibase-3.2.json
type
The column data type.
{"type": "string", "default": ""}
liquibase-3.2.json
value
The value for which to set the column. The value will be surrounded by quote marks and nested quote marks will be escaped.
{"type": "string", "default": ""}
liquibase-3.2.json
valueNumeric
The numeric value to set the column to. The value will not be escaped and will not be nested in quote marks.
{"type": "number", "default": ""}
liquibase-3.2.json
valueBoolean
The boolean value to set the column to. The actual value string inserted will depend on the database implementation.
{"type": "boolean", "default": ""}
liquibase-3.2.json
valueDate
The date and time value to set the column to. The value is 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
The value that is returned from a function or procedure call. This attribute will contain the function to call.
{"type": "string", "default": ""}
liquibase-3.2.json
valueSequenceCurrent
The name of the sequence in which the current value is used.
{"type": "string", "default": ""}
liquibase-3.2.json
valueSequenceNext
The name of the sequence in which the next value is used.
{"type": "string", "default": ""}
liquibase-3.2.json
valueBlobFile
The path to a file, whose contents will be written as a BLOB (i.e. chunk of binary data). The path to the changelog file location must be either absolute or relative. An example of an absolute path is: /usr/local/somefile.dat on Unix or c:\Directory\somefile.dat on Windows.
{"type": "string", "default": ""}
liquibase-3.2.json
valueClobFile
The path to a file, whose contents will be written as a CLOB (i.e. chunk of character data). The path to the changelog file location must be either absolute or relative. An example of an absolute path is: /usr/local/somefile.dat on Unix or c:\Directory\somefile.dat on Windows.
{"type": "string", "default": ""}
liquibase-3.2.json
defaultValue
The default value for column.
{"type": "string", "default": ""}
liquibase-3.2.json
defaultValueNumeric
The default numeric value for column.
{"type": "number", "default": ""}
liquibase-3.2.json
defaultValueDate
The default date and time value for column. The value is 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
defaultValueBoolean
The default boolean value for column.
{"type": "boolean", "default": false}
liquibase-3.2.json
defaultValueComputed
The default value that is returned from a function or procedure call. This attribute will contain the function to call.
{"type": "string", "default": ""}
liquibase-3.2.json
autoIncrement
The auto-increment column. Ignored on databases that do not support the autoincrement/identity functionality.
{"type": "boolean", "default": false}
liquibase-3.2.json
startWith
The value auto-increment start. Ignored on databases that do not support autoincrement/identity functionality.
{"type": "integer", "default": 0}
liquibase-3.2.json
incrementBy
The value of each step by auto-increment. Ignored on databases that do not support autoincrement/identity functionality.
{"type": "integer", "default": 0}
liquibase-3.2.json
remarks
A short description of the column (column comment).
{"type": "string", "default": ""}
liquibase-3.2.json
encoding
The name of the encoding (specified in java.nio.Charset javadoc, e.g. "UTF-8") of the CLOB file (specified in valueClobFile) contents.
{"type": "string", "default": ""}
liquibase-3.2.json
beforeColumn
The attribute that allows you to control where in the table column order the new column goes if it is used in an addColumn command. Only one of beforeColumn, afterColumn, or position is allowed. Since 3.1
{"type": "string", "default": ""}
liquibase-3.2.json
afterColumn
The attribute that allows you to control where in the table column order the new column goes if it is used in an addColumn command. Only one of beforeColumn, afterColumn, or position is allowed. Since 3.1
{"type": "string", "default": ""}
liquibase-3.2.json
position
The attribute that allows you to control where in the table column order the new column goes if it is used in an addColumn command. Only one of beforeColumn, afterColumn, or position is allowed. Uses one based index. Since 3.1
{"type": "number", "default": ""}
liquibase-3.2.json
header
Name of the column in the CSV file from which the value for the column will be taken if its different from the column name. Ignored if index is also defined.
{"type": "string", "default": ""}
liquibase-3.2.json
index
Index of the column in the CSV file from which the value for the column will be taken.
{"type": "integer", "default": ""}
liquibase-3.2.json
constraints
Constraint definitions
{"type": "object", "default": {}, "properties": {"nullable": {"type": "boolean", "default": false}, "notNullConstraintName": {"type": "string", "default": ""}, "primaryKey": {"type": "boolean", "default": false}, "primaryKeyName": {"type": "string", "default": ""}, "primaryKeyTablespace": {"type": "string", "default": ""}, "unique": {"type": "boolean", "default": false}, "uniqueConstraintName": {"type": "string", "default": ""}, "references": {"type": "string", "default": ""}, "referencedTableCatalogName": {"type": "string", "default": ""}, "referencedTableSchemaName": {"type": "string", "default": ""}, "referencedTableName": {"type": "string", "default": ""}, "referencedColumnNames": {"type": "string", "default": ""}, "foreignKeyName": {"type": "string", "default": ""}, "deleteCascade": {"type": "boolean", "default": false}, "deferrable": {"type": "boolean", "default": false}, "initiallyDeferred": {"type": "boolean", "default": false}, "checkConstraint": {"type": "string", "default": ""}, "validateNullable": {"type": "boolean", "default": false}, "validateUnique": {"type": "boolean", "default": false}, "validatePrimaryKey": {"type": "boolean", "default": false}, "validateForeignKey": {"type": "boolean", "default": false}}, "additionalProperties": true}
liquibase-3.2.json
nullable
The attribute that defines whether the column is nullable.
{"type": "boolean", "default": false}
liquibase-3.2.json
notNullConstraintName
The not null constraint name.
{"type": "string", "default": ""}
liquibase-3.2.json
primaryKey
The attribute that defines whether the column is a primary key.
{"type": "boolean", "default": false}
liquibase-3.2.json
primaryKeyName
The primary key name Since 1.6.
{"type": "string", "default": ""}
liquibase-3.2.json
primaryKeyTablespace
The tablespace to use for the defined primary key.
{"type": "string", "default": ""}
liquibase-3.2.json
unique
The attribute that defines whether a unique clause should be applied.
{"type": "boolean", "default": false}
liquibase-3.2.json
uniqueConstraintName
The unique constraint name.
{"type": "string", "default": ""}
liquibase-3.2.json
references
The foreign key definition.
{"type": "string", "default": ""}
liquibase-3.2.json
referencedTableCatalogName
The name of the catalog.
{"type": "string", "default": ""}
liquibase-3.2.json
referencedTableSchemaName
The name of the schema.
{"type": "string", "default": ""}
liquibase-3.2.json
referencedTableName
The name of the table.
{"type": "string", "default": ""}
liquibase-3.2.json
referencedColumnNames
The name of the column.
{"type": "string", "default": ""}
liquibase-3.2.json
foreignKeyName
The foreign key name.
{"type": "string", "default": ""}
liquibase-3.2.json
deleteCascade
The attribute that sets delete cascade.
{"type": "boolean", "default": false}
liquibase-3.2.json
deferrable
The attribute that defines whether constraints are deferrable.
{"type": "boolean", "default": false}
liquibase-3.2.json
initiallyDeferred
The attribute that defines whether constraints are initially deferred.
{"type": "boolean", "default": false}
liquibase-3.2.json
checkConstraint
The attribute that defines whether to validate the defined check constraint.
{"type": "string", "default": ""}
liquibase-3.2.json
validateNullable
The attribute that defines whether to validate the defined not null constraint.
{"type": "boolean", "default": false}
liquibase-3.2.json
validateUnique
The attribute that defines whether to validate the defined unique constraint.
{"type": "boolean", "default": false}
liquibase-3.2.json
validatePrimaryKey
The attribute that defines whether to validate the defined primary key constraint.
{"type": "boolean", "default": false}
liquibase-3.2.json
validateForeignKey
The attribute that defines whether to validate the defined foreign key constraint.
{"type": "boolean", "default": false}
liquibase-3.2.json
columns
The column constraint and foreign key information. Setting the defaultValue attribute will specify a default value for the column. Setting the value attribute will set all rows existing to the specified value without modifying the column default. See Information about the <column> tag section for more information.
{"type": "array", "default": [], "minItems": 1, "items": {"anyOf": [{"type": "object", "default": {}, "properties": {"column": {}, "modifySql": {}}, "additionalProperties": true}]}}
liquibase-3.2.json
preConditions
Preconditions are changelog or changeset tags which control the execution of an update based on the state of the database.
{"type": "array", "default": [], "items": {"anyOf": [{"type": "object", "default": {}, "properties": {"onFailMessage": {"type": "string", "default": ""}, "onErrorMessage": {"type": "string", "default": ""}, "onFail": {"type": "string", "oneOf": [{"const": "HALT"}, {"const": "CONTINUE"}, {"const": "MARK_RAN"}, {"const": "WARN"}], "default": "HALT"}, "onError": {"type": "string", "oneOf": [{"const": "HALT"}, {"const": "CONTINUE"}, {"const": "MARK_RAN"}, {"const": "WARN"}], "default": "HALT"}, "onSqlOutput": {"type": "string", "oneOf": [{"const": "TEST"}, {"const": "FAIL"}, {"const": "IGNORE"}], "default": "IGNORE"}, "dbms": {"type": "object", "default": {}, "required": ["type"], "properties": {"type": {"type": "string"}}}, "runningAs": {"type": "object", "default": {}, "required": ["username"], "properties": {"username": {"type": "string"}}}, "changeSetExecuted": {"type": "object", "default": {}, "required": ["id", "author", "changeLogFile"], "properties": {"id": {"type": "string"}, "author": {"type": "string"}, "changeLogFile": {"type": "string"}}}, "columnExists": {"type": "object", "default": {}, "required": ["tableName", "columnName"], "properties": {"schemaName": {"type": "string"}, "tableName": {"type": "string"}, "columnName": {"type": "string"}}}, "tableExists": {"type": "object", "default": {}, "required": ["tableName"], "properties": {"schemaName": {"type": "string"}, "tableName": {"type": "string"}}}, "viewExists": {"type": "object", "default": {}, "required": ["viewName"], "properties": {"schemaName": {"type": "string"}, "viewName": {"type": "string"}}}, "foreignKeyConstraintExists": {"type": "object", "default": {}, "required": ["foreignKeyName"], "properties": {"schemaName": {"type": "string"}, "foreignKeyName": {"type": "string"}}}, "indexExists": {"type": "object", "default": {}, "properties": {"schemaName": {"type": "string"}, "indexName": {"type": "string"}, "tableName": {"type": "string"}, "columnName": {"type": "string"}}}, "sequenceExists": {"type": "object", "default": {}, "required": ["sequenceName"], "properties": {"schemaName": {"type": "string"}, "sequenceName": {"type": "string"}}}, "primaryKeyExists": {"type": "object", "default": {}, "properties": {"schemaName": {"type": "string"}, "primaryKeyName": {"type": "string"}, "tableName": {"type": "string"}}}, "sqlCheck": {"type": "object", "default": {}, "required": ["expectedResult"], "properties": {"expectedResult": {"type": "integer"}, "sql": {"type": "string"}}}, "changeLogPropertyDefined": {"type": "object", "default": {}, "required": ["property"], "properties": {"property": {"type": "string"}, "value": {"type": "string"}}}, "customPrecondition": {"type": "object", "default": {}, "required": ["className"], "properties": {"className": {"type": "string"}}, "additionalProperties": true}, "and": {}, "or": {}, "not": {}}, "additionalProperties": true}]}}
liquibase-3.2.json
onFailMessage
Provides a custom message to output when preconditions fail. Since 2.0
{"type": "string", "default": ""}
liquibase-3.2.json
onErrorMessage
Provides a custom message to output when preconditions fail. Since 2.0
{"type": "string", "default": ""}
liquibase-3.2.json
onFail
Controls what happens if the preconditions check fails.
{"type": "string", "oneOf": [{"const": "HALT"}, {"const": "CONTINUE"}, {"const": "MARK_RAN"}, {"const": "WARN"}], "default": "HALT"}
liquibase-3.2.json
onFail
Halts the execution of the entire changelog (default). HALT can be put outside a changeset (e.g. at the beginning of the changelog).
{"const": "HALT"}
liquibase-3.2.json
onFail
Skips over the changeset. Execution of the changeset will be attempted again on the next update. Continues with the changelog.
{"const": "CONTINUE"}
liquibase-3.2.json
onFail
Skips over the changeset but mark it as executed. Continues with the changelog.
{"const": "MARK_RAN"}
liquibase-3.2.json
onFail
Sends a warning and continues executing the changeset / changelog as normal. WARN can be put outside a changeset (e.g. at the beginning of the changelog).
{"const": "WARN"}
liquibase-3.2.json
onError
Controls what happens if there is an error checking whether the precondition passed or not.
{"type": "string", "oneOf": [{"const": "HALT"}, {"const": "CONTINUE"}, {"const": "MARK_RAN"}, {"const": "WARN"}], "default": "HALT"}
liquibase-3.2.json
onError
Halts the execution of the entire changelog (default). HALT can be put outside a changeset (e.g. at the beginning of the changelog).
{"const": "HALT"}
liquibase-3.2.json
onError
Skips over the changeset. Execution of the changeset will be attempted again on the next update. Continues with the changelog.
{"const": "CONTINUE"}
liquibase-3.2.json
onError
Skips over the changeset but mark it as executed. Continues with the changelog.
{"const": "MARK_RAN"}
liquibase-3.2.json
onError
Sends a warning and continues executing the changeset / changelog as normal. WARN can be put outside a changeset (e.g. at the beginning of the changelog).
{"const": "WARN"}