mirror of
https://github.com/xataio/pgroll.git
synced 2024-07-07 02:16:27 +03:00
4f0a715613
Build on #344 to allow removing column comments by setting them to `null`. Make use of https://github.com/omissis/go-jsonschema/pull/220 and use the [nullable](https://github.com/oapi-codegen/nullable) package so that it's possible to distingush between a missing `comment` field and one that is explicitly set to `null`. With https://github.com/omissis/go-jsonschema/pull/220 not being part of a release yet, use a custom build of `go-jsonschema`. It should be possible to switch back to the official release images once https://github.com/omissis/go-jsonschema/pull/220 is part of a release. Without this change it becomes impossible to remove a comment from a column using the 'set comment' 'alter column' sub-operation (https://github.com/xataio/pgroll/pull/344).
609 lines
17 KiB
JSON
609 lines
17 KiB
JSON
{
|
|
"$id": "https://raw.githubusercontent.com/xataio/pgroll/main/schema.json",
|
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
"title": "JSON Schema for pgroll migrations",
|
|
"description": "This JSON schema defines the structure and properties of pgroll migrations.",
|
|
"allOf": [{ "$ref": "#/$defs/PgRollMigration" }],
|
|
"$defs": {
|
|
"CheckConstraint": {
|
|
"additionalProperties": false,
|
|
"description": "Check constraint definition",
|
|
"properties": {
|
|
"constraint": {
|
|
"description": "Constraint expression",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Name of check constraint",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": ["constraint", "name"],
|
|
"type": "object"
|
|
},
|
|
"Column": {
|
|
"additionalProperties": false,
|
|
"description": "Column definition",
|
|
"properties": {
|
|
"check": {
|
|
"$ref": "#/$defs/CheckConstraint",
|
|
"description": "Check constraint for the column"
|
|
},
|
|
"default": {
|
|
"description": "Default value for the column",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Name of the column",
|
|
"type": "string"
|
|
},
|
|
"nullable": {
|
|
"description": "Indicates if the column is nullable",
|
|
"type": "boolean"
|
|
},
|
|
"pk": {
|
|
"description": "Indicates if the column is part of the primary key",
|
|
"type": "boolean"
|
|
},
|
|
"references": {
|
|
"$ref": "#/$defs/ForeignKeyReference",
|
|
"description": "Foreign key constraint for the column"
|
|
},
|
|
"type": {
|
|
"description": "Postgres type of the column",
|
|
"type": "string"
|
|
},
|
|
"unique": {
|
|
"description": "Indicates if the column values must be unique",
|
|
"type": "boolean"
|
|
},
|
|
"comment": {
|
|
"description": "Postgres comment for the column",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": ["name", "type"],
|
|
"type": "object"
|
|
},
|
|
"ForeignKeyReference": {
|
|
"additionalProperties": false,
|
|
"description": "Foreign key reference definition",
|
|
"properties": {
|
|
"column": {
|
|
"description": "Name of the referenced column",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Name of the foreign key constraint",
|
|
"type": "string"
|
|
},
|
|
"table": {
|
|
"description": "Name of the referenced table",
|
|
"type": "string"
|
|
},
|
|
"on_delete": {
|
|
"description": "On delete behavior of the foreign key constraint",
|
|
"type": "string",
|
|
"enum": ["NO ACTION", "RESTRICT", "CASCADE", "SET NULL", "SET DEFAULT"],
|
|
"default": "NO ACTION"
|
|
}
|
|
},
|
|
"required": ["column", "name", "table"],
|
|
"type": "object"
|
|
},
|
|
"OpAddColumn": {
|
|
"additionalProperties": false,
|
|
"description": "Add column operation",
|
|
"properties": {
|
|
"column": {
|
|
"$ref": "#/$defs/Column",
|
|
"description": "Column to add"
|
|
},
|
|
"table": {
|
|
"description": "Name of the table",
|
|
"type": "string"
|
|
},
|
|
"up": {
|
|
"default": "",
|
|
"description": "SQL expression for up migration",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": ["column", "table"],
|
|
"type": "object"
|
|
},
|
|
"OpAlterColumn": {
|
|
"additionalProperties": false,
|
|
"description": "Alter column operation",
|
|
"properties": {
|
|
"check": {
|
|
"$ref": "#/$defs/CheckConstraint",
|
|
"description": "Add check constraint to the column"
|
|
},
|
|
"column": {
|
|
"description": "Name of the column",
|
|
"type": "string"
|
|
},
|
|
"down": {
|
|
"default": "",
|
|
"description": "SQL expression for down migration",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "New name of the column (for rename column operation)",
|
|
"type": "string"
|
|
},
|
|
"default": {
|
|
"description": "Default value of the column",
|
|
"type": "string"
|
|
},
|
|
"nullable": {
|
|
"description": "Indicates if the column is nullable (for add/remove not null constraint operation)",
|
|
"type": "boolean"
|
|
},
|
|
"references": {
|
|
"$ref": "#/$defs/ForeignKeyReference",
|
|
"description": "Add foreign key constraint to the column"
|
|
},
|
|
"table": {
|
|
"description": "Name of the table",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "New type of the column (for change type operation)",
|
|
"type": "string"
|
|
},
|
|
"unique": {
|
|
"$ref": "#/$defs/UniqueConstraint",
|
|
"description": "Add unique constraint to the column"
|
|
},
|
|
"comment": {
|
|
"description": "New comment on the column",
|
|
"type": ["string", "null"],
|
|
"goJSONSchema": {
|
|
"imports": ["github.com/oapi-codegen/nullable"],
|
|
"nillable": true,
|
|
"type": "nullable.Nullable[string]"
|
|
}
|
|
},
|
|
"up": {
|
|
"default": "",
|
|
"description": "SQL expression for up migration",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": ["table", "column"],
|
|
"oneOf": [
|
|
{
|
|
"anyOf": [
|
|
{ "required": ["check"] },
|
|
{ "required": ["type"] },
|
|
{ "required": ["nullable"] },
|
|
{ "required": ["default"] },
|
|
{ "required": ["comment"] },
|
|
{ "required": ["unique"] },
|
|
{ "required": ["references"] }
|
|
],
|
|
"required": ["up", "down"]
|
|
},
|
|
{
|
|
"required": ["name"],
|
|
"not": {
|
|
"anyOf": [
|
|
{ "required": ["check"] },
|
|
{ "required": ["type"] },
|
|
{ "required": ["nullable"] },
|
|
{ "required": ["default"] },
|
|
{ "required": ["comment"] },
|
|
{ "required": ["unique"] },
|
|
{ "required": ["references"] },
|
|
{ "required": ["up"] },
|
|
{ "required": ["down"] }
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": "object"
|
|
},
|
|
"OpCreateIndex": {
|
|
"additionalProperties": false,
|
|
"description": "Create index operation",
|
|
"properties": {
|
|
"columns": {
|
|
"description": "Names of columns on which to define the index",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"description": "Index name",
|
|
"type": "string"
|
|
},
|
|
"table": {
|
|
"description": "Name of table on which to define the index",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": ["columns", "name", "table"],
|
|
"type": "object"
|
|
},
|
|
"OpCreateTable": {
|
|
"additionalProperties": false,
|
|
"description": "Create table operation",
|
|
"properties": {
|
|
"columns": {
|
|
"items": {
|
|
"$ref": "#/$defs/Column",
|
|
"description": "Columns to add to the table"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"description": "Name of the table",
|
|
"type": "string"
|
|
},
|
|
"comment": {
|
|
"description": "Postgres comment for the table",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": ["columns", "name"],
|
|
"type": "object"
|
|
},
|
|
"OpDropColumn": {
|
|
"additionalProperties": false,
|
|
"description": "Drop column operation",
|
|
"properties": {
|
|
"column": {
|
|
"description": "Name of the column",
|
|
"type": "string"
|
|
},
|
|
"down": {
|
|
"default": "",
|
|
"description": "SQL expression for down migration",
|
|
"type": "string"
|
|
},
|
|
"table": {
|
|
"description": "Name of the table",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": ["column", "table"],
|
|
"type": "object"
|
|
},
|
|
"OpDropConstraint": {
|
|
"additionalProperties": false,
|
|
"description": "Drop constraint operation",
|
|
"properties": {
|
|
"column": {
|
|
"description": "Name of the column",
|
|
"type": "string"
|
|
},
|
|
"down": {
|
|
"default": "",
|
|
"description": "SQL expression for down migration",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Name of the constraint",
|
|
"type": "string"
|
|
},
|
|
"table": {
|
|
"description": "Name of the table",
|
|
"type": "string"
|
|
},
|
|
"up": {
|
|
"description": "SQL expression for up migration",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": ["column", "down", "name", "table", "up"],
|
|
"type": "object"
|
|
},
|
|
"OpDropIndex": {
|
|
"additionalProperties": false,
|
|
"description": "Drop index operation",
|
|
"properties": {
|
|
"name": {
|
|
"description": "Index name",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": ["name"],
|
|
"type": "object"
|
|
},
|
|
"OpDropTable": {
|
|
"additionalProperties": false,
|
|
"description": "Drop table operation",
|
|
"properties": {
|
|
"name": {
|
|
"description": "Name of the table",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": ["name"],
|
|
"type": "object"
|
|
},
|
|
"OpRawSQL": {
|
|
"additionalProperties": false,
|
|
"description": "Raw SQL operation",
|
|
"properties": {
|
|
"down": {
|
|
"default": "",
|
|
"description": "SQL expression for down migration",
|
|
"type": "string"
|
|
},
|
|
"up": {
|
|
"description": "SQL expression for up migration",
|
|
"type": "string"
|
|
},
|
|
"onComplete": {
|
|
"description": "SQL expression will run on complete step (rather than on start)",
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
},
|
|
"required": ["up"],
|
|
"oneOf": [
|
|
{
|
|
"required": ["down"]
|
|
},
|
|
{
|
|
"required": ["onComplete"]
|
|
},
|
|
{
|
|
"not": {
|
|
"anyOf": [
|
|
{
|
|
"required": ["down"]
|
|
},
|
|
{
|
|
"required": ["onComplete"]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": "object"
|
|
},
|
|
"OpRenameConstraint": {
|
|
"additionalProperties": false,
|
|
"description": "Rename constraint operation",
|
|
"properties": {
|
|
"from": {
|
|
"description": "Name of the constraint",
|
|
"type": "string"
|
|
},
|
|
"to": {
|
|
"description": "New name of the constraint",
|
|
"type": "string"
|
|
},
|
|
"table": {
|
|
"description": "Name of the table",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": ["from", "to", "table"],
|
|
"type": "object"
|
|
},
|
|
"OpRenameTable": {
|
|
"additionalProperties": false,
|
|
"description": "Rename table operation",
|
|
"properties": {
|
|
"from": {
|
|
"description": "Old name of the table",
|
|
"type": "string"
|
|
},
|
|
"to": {
|
|
"description": "New name of the table",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": ["from", "to"],
|
|
"type": "object"
|
|
},
|
|
"OpSetReplicaIdentity": {
|
|
"additionalProperties": false,
|
|
"description": "Set replica identity operation",
|
|
"properties": {
|
|
"identity": {
|
|
"$ref": "#/$defs/ReplicaIdentity",
|
|
"description": "Replica identity to set"
|
|
},
|
|
"table": {
|
|
"description": "Name of the table",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": ["identity", "table"],
|
|
"type": "object"
|
|
},
|
|
"PgRollOperation": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"description": "Add column operation",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"add_column": {
|
|
"$ref": "#/$defs/OpAddColumn"
|
|
}
|
|
},
|
|
"required": ["add_column"]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"description": "Alter column operation",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"alter_column": {
|
|
"$ref": "#/$defs/OpAlterColumn"
|
|
}
|
|
},
|
|
"required": ["alter_column"]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"description": "Create index operation",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"create_index": {
|
|
"$ref": "#/$defs/OpCreateIndex"
|
|
}
|
|
},
|
|
"required": ["create_index"]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"description": "Create table operation",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"create_table": {
|
|
"$ref": "#/$defs/OpCreateTable"
|
|
}
|
|
},
|
|
"required": ["create_table"]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"description": "Drop column operation",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"drop_column": {
|
|
"$ref": "#/$defs/OpDropColumn"
|
|
}
|
|
},
|
|
"required": ["drop_column"]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"description": "Drop constraint operation",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"drop_constraint": {
|
|
"$ref": "#/$defs/OpDropConstraint"
|
|
}
|
|
},
|
|
"required": ["drop_constraint"]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"description": "Rename constraint operation",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"rename_constraint": {
|
|
"$ref": "#/$defs/OpRenameConstraint"
|
|
}
|
|
},
|
|
"required": ["rename_constraint"]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"description": "Drop index operation",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"drop_index": {
|
|
"$ref": "#/$defs/OpDropIndex"
|
|
}
|
|
},
|
|
"required": ["drop_index"]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"description": "Drop table operation",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"drop_table": {
|
|
"$ref": "#/$defs/OpDropTable"
|
|
}
|
|
},
|
|
"required": ["drop_table"]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"description": "Raw SQL operation",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"sql": {
|
|
"$ref": "#/$defs/OpRawSQL"
|
|
}
|
|
},
|
|
"required": ["sql"]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"description": "Rename table operation",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"rename_table": {
|
|
"$ref": "#/$defs/OpRenameTable"
|
|
}
|
|
},
|
|
"required": ["rename_table"]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"description": "Set replica identity operation",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"set_replica_identity": {
|
|
"$ref": "#/$defs/OpSetReplicaIdentity"
|
|
}
|
|
},
|
|
"required": ["set_replica_identity"]
|
|
}
|
|
]
|
|
},
|
|
"PgRollOperations": {
|
|
"items": {
|
|
"$ref": "#/$defs/PgRollOperation"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"PgRollMigration": {
|
|
"additionalProperties": false,
|
|
"description": "PgRoll migration definition",
|
|
"properties": {
|
|
"name": {
|
|
"description": "Name of the migration",
|
|
"type": "string"
|
|
},
|
|
"operations": {
|
|
"$ref": "#/$defs/PgRollOperations"
|
|
}
|
|
},
|
|
"required": ["operations"],
|
|
"type": "object"
|
|
},
|
|
"ReplicaIdentity": {
|
|
"additionalProperties": false,
|
|
"description": "Replica identity definition",
|
|
"properties": {
|
|
"index": {
|
|
"description": "Name of the index to use as replica identity",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Type of replica identity",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": ["index", "type"],
|
|
"type": "object"
|
|
},
|
|
"UniqueConstraint": {
|
|
"additionalProperties": false,
|
|
"description": "Unique constraint definition",
|
|
"properties": {
|
|
"name": {
|
|
"description": "Name of unique constraint",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": ["name"],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|