{ "name": "pgroll", "runtime": "component", "exports": { "run": { "description": "Execute any pgroll feature with literal CSV arguments.", "input": { "type": "object", "properties": { "project": { "type": "string", "default": ".", "minLength": 1, "description": "Working directory containing the source checkout; defaults to the current directory. Default: \".\"." }, "runDir": { "type": "string", "minLength": 1, "description": "Fresh directory for this invocation’s execution report and task logs; must not already exist." }, "executable": { "type": "string", "minLength": 1, "description": "Native CLI executable name or absolute path; defaults to this operation’s tool." }, "timeoutMs": { "type": "integer", "minimum": 1, "default": 900000, "description": "Maximum task duration in milliseconds; defaults to 900000. Default: 900000." }, "artifacts": { "type": "string", "description": "Comma-separated NAME=PATH output artifacts; use CSV double quotes around entries containing commas." }, "arguments": { "type": "string", "minLength": 1, "description": "Additional literal CLI tokens as comma-separated text; double-quote CSV entries containing commas and double embedded quotes. No shell expansion occurs." } }, "required": [ "runDir", "arguments" ], "additionalProperties": false }, "output": { "type": "object", "required": [ "outcome", "runDir", "reportPath", "stdoutPath", "stderrPath" ], "properties": { "outcome": { "type": "string" }, "runDir": { "type": "string" }, "reportPath": { "type": "string" }, "stdoutPath": { "type": "string" }, "stderrPath": { "type": "string" } }, "additionalProperties": false } }, "version": { "description": "Print the installed pgroll version.", "input": { "type": "object", "properties": { "project": { "type": "string", "default": ".", "minLength": 1, "description": "Working directory containing the source checkout; defaults to the current directory. Default: \".\"." }, "runDir": { "type": "string", "minLength": 1, "description": "Fresh directory for this invocation’s execution report and task logs; must not already exist." }, "executable": { "type": "string", "minLength": 1, "description": "Native CLI executable name or absolute path; defaults to this operation’s tool." }, "timeoutMs": { "type": "integer", "minimum": 1, "default": 900000, "description": "Maximum task duration in milliseconds; defaults to 900000. Default: 900000." }, "artifacts": { "type": "string", "description": "Comma-separated NAME=PATH output artifacts; use CSV double quotes around entries containing commas." } }, "required": [ "runDir" ], "additionalProperties": false }, "output": { "type": "object", "required": [ "outcome", "runDir", "reportPath", "stdoutPath", "stderrPath" ], "properties": { "outcome": { "type": "string" }, "runDir": { "type": "string" }, "reportPath": { "type": "string" }, "stdoutPath": { "type": "string" }, "stderrPath": { "type": "string" } }, "additionalProperties": false } }, "init": { "description": "Initialize pgroll state in the target database; no migration file is required.", "input": { "type": "object", "properties": { "project": { "type": "string", "default": ".", "minLength": 1, "description": "Working directory containing the source checkout; defaults to the current directory. Default: \".\"." }, "runDir": { "type": "string", "minLength": 1, "description": "Fresh directory for this invocation’s execution report and task logs; must not already exist." }, "executable": { "type": "string", "minLength": 1, "description": "Native CLI executable name or absolute path; defaults to this operation’s tool." }, "timeoutMs": { "type": "integer", "minimum": 1, "default": 900000, "description": "Maximum task duration in milliseconds; defaults to 900000. Default: 900000." }, "artifacts": { "type": "string", "description": "Comma-separated NAME=PATH output artifacts; use CSV double quotes around entries containing commas." }, "postgresUrl": { "type": "string", "minLength": 1, "description": "PostgreSQL connection URL; prefer inherited PGROLL_PG_URL for credentials because explicit arguments appear in execution plans." }, "schema": { "type": "string", "minLength": 1, "description": "PostgreSQL schema to migrate; native default public." }, "stateSchema": { "type": "string", "minLength": 1, "description": "Schema containing pgroll internal state; native default pgroll." }, "lockTimeout": { "type": "integer", "minimum": 0, "description": "PostgreSQL DDL lock timeout in milliseconds; native default 500." }, "role": { "type": "string", "minLength": 1, "description": "Optional PostgreSQL role used while executing migrations." }, "useVersionSchema": { "type": "boolean", "description": "Create version schemas for migrations; native default true. Explicit false is passed through." }, "verbose": { "type": "boolean", "description": "Enable native verbose logging." }, "arguments": { "type": "string", "description": "Additional literal CLI tokens as comma-separated text; double-quote CSV entries containing commas and double embedded quotes. No shell expansion occurs." } }, "required": [ "runDir" ], "additionalProperties": false }, "output": { "type": "object", "required": [ "outcome", "runDir", "reportPath", "stdoutPath", "stderrPath" ], "properties": { "outcome": { "type": "string" }, "runDir": { "type": "string" }, "reportPath": { "type": "string" }, "stdoutPath": { "type": "string" }, "stderrPath": { "type": "string" } }, "additionalProperties": false } }, "validate": { "description": "Validate a migration file against the target database before application.", "input": { "type": "object", "properties": { "project": { "type": "string", "default": ".", "minLength": 1, "description": "Working directory containing the source checkout; defaults to the current directory. Default: \".\"." }, "runDir": { "type": "string", "minLength": 1, "description": "Fresh directory for this invocation’s execution report and task logs; must not already exist." }, "executable": { "type": "string", "minLength": 1, "description": "Native CLI executable name or absolute path; defaults to this operation’s tool." }, "timeoutMs": { "type": "integer", "minimum": 1, "default": 900000, "description": "Maximum task duration in milliseconds; defaults to 900000. Default: 900000." }, "artifacts": { "type": "string", "description": "Comma-separated NAME=PATH output artifacts; use CSV double quotes around entries containing commas." }, "postgresUrl": { "type": "string", "minLength": 1, "description": "PostgreSQL connection URL; prefer inherited PGROLL_PG_URL for credentials because explicit arguments appear in execution plans." }, "schema": { "type": "string", "minLength": 1, "description": "PostgreSQL schema to migrate; native default public." }, "stateSchema": { "type": "string", "minLength": 1, "description": "Schema containing pgroll internal state; native default pgroll." }, "lockTimeout": { "type": "integer", "minimum": 0, "description": "PostgreSQL DDL lock timeout in milliseconds; native default 500." }, "role": { "type": "string", "minLength": 1, "description": "Optional PostgreSQL role used while executing migrations." }, "useVersionSchema": { "type": "boolean", "description": "Create version schemas for migrations; native default true. Explicit false is passed through." }, "verbose": { "type": "boolean", "description": "Enable native verbose logging." }, "file": { "type": "string", "minLength": 1, "description": "Existing YAML or JSON migration file to validate against the target database." }, "arguments": { "type": "string", "description": "Additional literal CLI tokens as comma-separated text; double-quote CSV entries containing commas and double embedded quotes. No shell expansion occurs." } }, "required": [ "runDir", "file" ], "additionalProperties": false }, "output": { "type": "object", "required": [ "outcome", "runDir", "reportPath", "stdoutPath", "stderrPath" ], "properties": { "outcome": { "type": "string" }, "runDir": { "type": "string" }, "reportPath": { "type": "string" }, "stdoutPath": { "type": "string" }, "stderrPath": { "type": "string" } }, "additionalProperties": false } }, "start": { "description": "Start a migration, backfill data, and optionally complete it.", "input": { "type": "object", "properties": { "project": { "type": "string", "default": ".", "minLength": 1, "description": "Working directory containing the source checkout; defaults to the current directory. Default: \".\"." }, "runDir": { "type": "string", "minLength": 1, "description": "Fresh directory for this invocation’s execution report and task logs; must not already exist." }, "executable": { "type": "string", "minLength": 1, "description": "Native CLI executable name or absolute path; defaults to this operation’s tool." }, "timeoutMs": { "type": "integer", "minimum": 1, "default": 900000, "description": "Maximum task duration in milliseconds; defaults to 900000. Default: 900000." }, "artifacts": { "type": "string", "description": "Comma-separated NAME=PATH output artifacts; use CSV double quotes around entries containing commas." }, "postgresUrl": { "type": "string", "minLength": 1, "description": "PostgreSQL connection URL; prefer inherited PGROLL_PG_URL for credentials because explicit arguments appear in execution plans." }, "schema": { "type": "string", "minLength": 1, "description": "PostgreSQL schema to migrate; native default public." }, "stateSchema": { "type": "string", "minLength": 1, "description": "Schema containing pgroll internal state; native default pgroll." }, "lockTimeout": { "type": "integer", "minimum": 0, "description": "PostgreSQL DDL lock timeout in milliseconds; native default 500." }, "role": { "type": "string", "minLength": 1, "description": "Optional PostgreSQL role used while executing migrations." }, "useVersionSchema": { "type": "boolean", "description": "Create version schemas for migrations; native default true. Explicit false is passed through." }, "verbose": { "type": "boolean", "description": "Enable native verbose logging." }, "file": { "type": "string", "minLength": 1, "description": "Existing YAML or JSON migration file to start." }, "backfillBatchDelay": { "type": "string", "minLength": 1, "description": "Delay between backfill batches as a Go duration, for example 1s or 1000ms." }, "backfillBatchSize": { "type": "integer", "minimum": 1, "description": "Positive number of rows per backfill batch; native default 1000." }, "complete": { "type": "boolean", "description": "Complete the migration immediately after applying it; native default false." }, "skipValidation": { "type": "boolean", "description": "Explicitly bypass native migration validation; native default false." }, "arguments": { "type": "string", "description": "Additional literal CLI tokens as comma-separated text; double-quote CSV entries containing commas and double embedded quotes. No shell expansion occurs." } }, "required": [ "runDir", "file" ], "additionalProperties": false }, "output": { "type": "object", "required": [ "outcome", "runDir", "reportPath", "stdoutPath", "stderrPath" ], "properties": { "outcome": { "type": "string" }, "runDir": { "type": "string" }, "reportPath": { "type": "string" }, "stdoutPath": { "type": "string" }, "stderrPath": { "type": "string" } }, "additionalProperties": false } }, "complete": { "description": "Complete the currently active migration in the database; no migration file is required.", "input": { "type": "object", "properties": { "project": { "type": "string", "default": ".", "minLength": 1, "description": "Working directory containing the source checkout; defaults to the current directory. Default: \".\"." }, "runDir": { "type": "string", "minLength": 1, "description": "Fresh directory for this invocation’s execution report and task logs; must not already exist." }, "executable": { "type": "string", "minLength": 1, "description": "Native CLI executable name or absolute path; defaults to this operation’s tool." }, "timeoutMs": { "type": "integer", "minimum": 1, "default": 900000, "description": "Maximum task duration in milliseconds; defaults to 900000. Default: 900000." }, "artifacts": { "type": "string", "description": "Comma-separated NAME=PATH output artifacts; use CSV double quotes around entries containing commas." }, "postgresUrl": { "type": "string", "minLength": 1, "description": "PostgreSQL connection URL; prefer inherited PGROLL_PG_URL for credentials because explicit arguments appear in execution plans." }, "schema": { "type": "string", "minLength": 1, "description": "PostgreSQL schema to migrate; native default public." }, "stateSchema": { "type": "string", "minLength": 1, "description": "Schema containing pgroll internal state; native default pgroll." }, "lockTimeout": { "type": "integer", "minimum": 0, "description": "PostgreSQL DDL lock timeout in milliseconds; native default 500." }, "role": { "type": "string", "minLength": 1, "description": "Optional PostgreSQL role used while executing migrations." }, "useVersionSchema": { "type": "boolean", "description": "Create version schemas for migrations; native default true. Explicit false is passed through." }, "verbose": { "type": "boolean", "description": "Enable native verbose logging." }, "arguments": { "type": "string", "description": "Additional literal CLI tokens as comma-separated text; double-quote CSV entries containing commas and double embedded quotes. No shell expansion occurs." } }, "required": [ "runDir" ], "additionalProperties": false }, "output": { "type": "object", "required": [ "outcome", "runDir", "reportPath", "stdoutPath", "stderrPath" ], "properties": { "outcome": { "type": "string" }, "runDir": { "type": "string" }, "reportPath": { "type": "string" }, "stdoutPath": { "type": "string" }, "stderrPath": { "type": "string" } }, "additionalProperties": false } }, "rollback": { "description": "Roll back the currently active migration; completed migrations retain native rollback limitations.", "input": { "type": "object", "properties": { "project": { "type": "string", "default": ".", "minLength": 1, "description": "Working directory containing the source checkout; defaults to the current directory. Default: \".\"." }, "runDir": { "type": "string", "minLength": 1, "description": "Fresh directory for this invocation’s execution report and task logs; must not already exist." }, "executable": { "type": "string", "minLength": 1, "description": "Native CLI executable name or absolute path; defaults to this operation’s tool." }, "timeoutMs": { "type": "integer", "minimum": 1, "default": 900000, "description": "Maximum task duration in milliseconds; defaults to 900000. Default: 900000." }, "artifacts": { "type": "string", "description": "Comma-separated NAME=PATH output artifacts; use CSV double quotes around entries containing commas." }, "postgresUrl": { "type": "string", "minLength": 1, "description": "PostgreSQL connection URL; prefer inherited PGROLL_PG_URL for credentials because explicit arguments appear in execution plans." }, "schema": { "type": "string", "minLength": 1, "description": "PostgreSQL schema to migrate; native default public." }, "stateSchema": { "type": "string", "minLength": 1, "description": "Schema containing pgroll internal state; native default pgroll." }, "lockTimeout": { "type": "integer", "minimum": 0, "description": "PostgreSQL DDL lock timeout in milliseconds; native default 500." }, "role": { "type": "string", "minLength": 1, "description": "Optional PostgreSQL role used while executing migrations." }, "useVersionSchema": { "type": "boolean", "description": "Create version schemas for migrations; native default true. Explicit false is passed through." }, "verbose": { "type": "boolean", "description": "Enable native verbose logging." }, "arguments": { "type": "string", "description": "Additional literal CLI tokens as comma-separated text; double-quote CSV entries containing commas and double embedded quotes. No shell expansion occurs." } }, "required": [ "runDir" ], "additionalProperties": false }, "output": { "type": "object", "required": [ "outcome", "runDir", "reportPath", "stdoutPath", "stderrPath" ], "properties": { "outcome": { "type": "string" }, "runDir": { "type": "string" }, "reportPath": { "type": "string" }, "stdoutPath": { "type": "string" }, "stderrPath": { "type": "string" } }, "additionalProperties": false } }, "migrate": { "description": "Apply outstanding migrations from a directory and propagate native failures.", "input": { "type": "object", "properties": { "project": { "type": "string", "default": ".", "minLength": 1, "description": "Working directory containing the source checkout; defaults to the current directory. Default: \".\"." }, "runDir": { "type": "string", "minLength": 1, "description": "Fresh directory for this invocation’s execution report and task logs; must not already exist." }, "executable": { "type": "string", "minLength": 1, "description": "Native CLI executable name or absolute path; defaults to this operation’s tool." }, "timeoutMs": { "type": "integer", "minimum": 1, "default": 900000, "description": "Maximum task duration in milliseconds; defaults to 900000. Default: 900000." }, "artifacts": { "type": "string", "description": "Comma-separated NAME=PATH output artifacts; use CSV double quotes around entries containing commas." }, "postgresUrl": { "type": "string", "minLength": 1, "description": "PostgreSQL connection URL; prefer inherited PGROLL_PG_URL for credentials because explicit arguments appear in execution plans." }, "schema": { "type": "string", "minLength": 1, "description": "PostgreSQL schema to migrate; native default public." }, "stateSchema": { "type": "string", "minLength": 1, "description": "Schema containing pgroll internal state; native default pgroll." }, "lockTimeout": { "type": "integer", "minimum": 0, "description": "PostgreSQL DDL lock timeout in milliseconds; native default 500." }, "role": { "type": "string", "minLength": 1, "description": "Optional PostgreSQL role used while executing migrations." }, "useVersionSchema": { "type": "boolean", "description": "Create version schemas for migrations; native default true. Explicit false is passed through." }, "verbose": { "type": "boolean", "description": "Enable native verbose logging." }, "directory": { "type": "string", "minLength": 1, "description": "Existing directory containing ordered migration files." }, "backfillBatchDelay": { "type": "string", "minLength": 1, "description": "Delay between backfill batches as a Go duration, for example 1s or 1000ms." }, "backfillBatchSize": { "type": "integer", "minimum": 1, "description": "Positive number of rows per backfill batch; native default 1000." }, "complete": { "type": "boolean", "description": "Complete the final migration instead of leaving it active." }, "expectOne": { "type": "boolean", "description": "Abort when more than one outstanding migration would be applied." }, "arguments": { "type": "string", "description": "Additional literal CLI tokens as comma-separated text; double-quote CSV entries containing commas and double embedded quotes. No shell expansion occurs." } }, "required": [ "runDir", "directory" ], "additionalProperties": false }, "output": { "type": "object", "required": [ "outcome", "runDir", "reportPath", "stdoutPath", "stderrPath" ], "properties": { "outcome": { "type": "string" }, "runDir": { "type": "string" }, "reportPath": { "type": "string" }, "stdoutPath": { "type": "string" }, "stderrPath": { "type": "string" } }, "additionalProperties": false } }, "status": { "description": "Report active migration and schema state in the target database.", "input": { "type": "object", "properties": { "project": { "type": "string", "default": ".", "minLength": 1, "description": "Working directory containing the source checkout; defaults to the current directory. Default: \".\"." }, "runDir": { "type": "string", "minLength": 1, "description": "Fresh directory for this invocation’s execution report and task logs; must not already exist." }, "executable": { "type": "string", "minLength": 1, "description": "Native CLI executable name or absolute path; defaults to this operation’s tool." }, "timeoutMs": { "type": "integer", "minimum": 1, "default": 900000, "description": "Maximum task duration in milliseconds; defaults to 900000. Default: 900000." }, "artifacts": { "type": "string", "description": "Comma-separated NAME=PATH output artifacts; use CSV double quotes around entries containing commas." }, "postgresUrl": { "type": "string", "minLength": 1, "description": "PostgreSQL connection URL; prefer inherited PGROLL_PG_URL for credentials because explicit arguments appear in execution plans." }, "schema": { "type": "string", "minLength": 1, "description": "PostgreSQL schema to migrate; native default public." }, "stateSchema": { "type": "string", "minLength": 1, "description": "Schema containing pgroll internal state; native default pgroll." }, "lockTimeout": { "type": "integer", "minimum": 0, "description": "PostgreSQL DDL lock timeout in milliseconds; native default 500." }, "role": { "type": "string", "minLength": 1, "description": "Optional PostgreSQL role used while executing migrations." }, "useVersionSchema": { "type": "boolean", "description": "Create version schemas for migrations; native default true. Explicit false is passed through." }, "verbose": { "type": "boolean", "description": "Enable native verbose logging." }, "arguments": { "type": "string", "description": "Additional literal CLI tokens as comma-separated text; double-quote CSV entries containing commas and double embedded quotes. No shell expansion occurs." } }, "required": [ "runDir" ], "additionalProperties": false }, "output": { "type": "object", "required": [ "outcome", "runDir", "reportPath", "stdoutPath", "stderrPath" ], "properties": { "outcome": { "type": "string" }, "runDir": { "type": "string" }, "reportPath": { "type": "string" }, "stdoutPath": { "type": "string" }, "stderrPath": { "type": "string" } }, "additionalProperties": false } }, "analyze": { "description": "Analyze the target database SQL schema using the native hidden diagnostic command.", "input": { "type": "object", "properties": { "project": { "type": "string", "default": ".", "minLength": 1, "description": "Working directory containing the source checkout; defaults to the current directory. Default: \".\"." }, "runDir": { "type": "string", "minLength": 1, "description": "Fresh directory for this invocation’s execution report and task logs; must not already exist." }, "executable": { "type": "string", "minLength": 1, "description": "Native CLI executable name or absolute path; defaults to this operation’s tool." }, "timeoutMs": { "type": "integer", "minimum": 1, "default": 900000, "description": "Maximum task duration in milliseconds; defaults to 900000. Default: 900000." }, "artifacts": { "type": "string", "description": "Comma-separated NAME=PATH output artifacts; use CSV double quotes around entries containing commas." }, "postgresUrl": { "type": "string", "minLength": 1, "description": "PostgreSQL connection URL; prefer inherited PGROLL_PG_URL for credentials because explicit arguments appear in execution plans." }, "schema": { "type": "string", "minLength": 1, "description": "PostgreSQL schema to migrate; native default public." }, "stateSchema": { "type": "string", "minLength": 1, "description": "Schema containing pgroll internal state; native default pgroll." }, "lockTimeout": { "type": "integer", "minimum": 0, "description": "PostgreSQL DDL lock timeout in milliseconds; native default 500." }, "role": { "type": "string", "minLength": 1, "description": "Optional PostgreSQL role used while executing migrations." }, "useVersionSchema": { "type": "boolean", "description": "Create version schemas for migrations; native default true. Explicit false is passed through." }, "verbose": { "type": "boolean", "description": "Enable native verbose logging." }, "arguments": { "type": "string", "description": "Additional literal CLI tokens as comma-separated text; double-quote CSV entries containing commas and double embedded quotes. No shell expansion occurs." } }, "required": [ "runDir" ], "additionalProperties": false }, "output": { "type": "object", "required": [ "outcome", "runDir", "reportPath", "stdoutPath", "stderrPath" ], "properties": { "outcome": { "type": "string" }, "runDir": { "type": "string" }, "reportPath": { "type": "string" }, "stdoutPath": { "type": "string" }, "stderrPath": { "type": "string" } }, "additionalProperties": false } }, "baseline": { "description": "Reset migration history to a baseline and write its placeholder file without a confirmation prompt.", "input": { "type": "object", "properties": { "project": { "type": "string", "default": ".", "minLength": 1, "description": "Working directory containing the source checkout; defaults to the current directory. Default: \".\"." }, "runDir": { "type": "string", "minLength": 1, "description": "Fresh directory for this invocation’s execution report and task logs; must not already exist." }, "executable": { "type": "string", "minLength": 1, "description": "Native CLI executable name or absolute path; defaults to this operation’s tool." }, "timeoutMs": { "type": "integer", "minimum": 1, "default": 900000, "description": "Maximum task duration in milliseconds; defaults to 900000. Default: 900000." }, "artifacts": { "type": "string", "description": "Comma-separated NAME=PATH output artifacts; use CSV double quotes around entries containing commas." }, "postgresUrl": { "type": "string", "minLength": 1, "description": "PostgreSQL connection URL; prefer inherited PGROLL_PG_URL for credentials because explicit arguments appear in execution plans." }, "schema": { "type": "string", "minLength": 1, "description": "PostgreSQL schema to migrate; native default public." }, "stateSchema": { "type": "string", "minLength": 1, "description": "Schema containing pgroll internal state; native default pgroll." }, "lockTimeout": { "type": "integer", "minimum": 0, "description": "PostgreSQL DDL lock timeout in milliseconds; native default 500." }, "role": { "type": "string", "minLength": 1, "description": "Optional PostgreSQL role used while executing migrations." }, "useVersionSchema": { "type": "boolean", "description": "Create version schemas for migrations; native default true. Explicit false is passed through." }, "verbose": { "type": "boolean", "description": "Enable native verbose logging." }, "baselineVersion": { "type": "string", "minLength": 1, "description": "Name of the baseline migration; this resets migration history." }, "directory": { "type": "string", "minLength": 1, "description": "Directory for the generated baseline file; created by pgroll if absent." }, "json": { "type": "boolean", "description": "Write migration files in JSON instead of YAML." }, "arguments": { "type": "string", "description": "Additional literal CLI tokens as comma-separated text; double-quote CSV entries containing commas and double embedded quotes. No shell expansion occurs." } }, "required": [ "runDir", "baselineVersion", "directory" ], "additionalProperties": false }, "output": { "type": "object", "required": [ "outcome", "runDir", "reportPath", "stdoutPath", "stderrPath" ], "properties": { "outcome": { "type": "string" }, "runDir": { "type": "string" }, "reportPath": { "type": "string" }, "stdoutPath": { "type": "string" }, "stderrPath": { "type": "string" } }, "additionalProperties": false } }, "pull": { "description": "Pull missing migration history from the database into local files.", "input": { "type": "object", "properties": { "project": { "type": "string", "default": ".", "minLength": 1, "description": "Working directory containing the source checkout; defaults to the current directory. Default: \".\"." }, "runDir": { "type": "string", "minLength": 1, "description": "Fresh directory for this invocation’s execution report and task logs; must not already exist." }, "executable": { "type": "string", "minLength": 1, "description": "Native CLI executable name or absolute path; defaults to this operation’s tool." }, "timeoutMs": { "type": "integer", "minimum": 1, "default": 900000, "description": "Maximum task duration in milliseconds; defaults to 900000. Default: 900000." }, "artifacts": { "type": "string", "description": "Comma-separated NAME=PATH output artifacts; use CSV double quotes around entries containing commas." }, "postgresUrl": { "type": "string", "minLength": 1, "description": "PostgreSQL connection URL; prefer inherited PGROLL_PG_URL for credentials because explicit arguments appear in execution plans." }, "schema": { "type": "string", "minLength": 1, "description": "PostgreSQL schema to migrate; native default public." }, "stateSchema": { "type": "string", "minLength": 1, "description": "Schema containing pgroll internal state; native default pgroll." }, "lockTimeout": { "type": "integer", "minimum": 0, "description": "PostgreSQL DDL lock timeout in milliseconds; native default 500." }, "role": { "type": "string", "minLength": 1, "description": "Optional PostgreSQL role used while executing migrations." }, "useVersionSchema": { "type": "boolean", "description": "Create version schemas for migrations; native default true. Explicit false is passed through." }, "verbose": { "type": "boolean", "description": "Enable native verbose logging." }, "directory": { "type": "string", "minLength": 1, "description": "Destination directory for migration history; created by pgroll if absent." }, "json": { "type": "boolean", "description": "Write migration files in JSON instead of YAML." }, "arguments": { "type": "string", "description": "Additional literal CLI tokens as comma-separated text; double-quote CSV entries containing commas and double embedded quotes. No shell expansion occurs." } }, "required": [ "runDir", "directory" ], "additionalProperties": false }, "output": { "type": "object", "required": [ "outcome", "runDir", "reportPath", "stdoutPath", "stderrPath" ], "properties": { "outcome": { "type": "string" }, "runDir": { "type": "string" }, "reportPath": { "type": "string" }, "stdoutPath": { "type": "string" }, "stderrPath": { "type": "string" } }, "additionalProperties": false } }, "convert": { "description": "Convert SQL statements from a file to a pgroll migration using native conversion rules.", "input": { "type": "object", "properties": { "project": { "type": "string", "default": ".", "minLength": 1, "description": "Working directory containing the source checkout; defaults to the current directory. Default: \".\"." }, "runDir": { "type": "string", "minLength": 1, "description": "Fresh directory for this invocation’s execution report and task logs; must not already exist." }, "executable": { "type": "string", "minLength": 1, "description": "Native CLI executable name or absolute path; defaults to this operation’s tool." }, "timeoutMs": { "type": "integer", "minimum": 1, "default": 900000, "description": "Maximum task duration in milliseconds; defaults to 900000. Default: 900000." }, "artifacts": { "type": "string", "description": "Comma-separated NAME=PATH output artifacts; use CSV double quotes around entries containing commas." }, "postgresUrl": { "type": "string", "minLength": 1, "description": "PostgreSQL connection URL; prefer inherited PGROLL_PG_URL for credentials because explicit arguments appear in execution plans." }, "schema": { "type": "string", "minLength": 1, "description": "PostgreSQL schema to migrate; native default public." }, "stateSchema": { "type": "string", "minLength": 1, "description": "Schema containing pgroll internal state; native default pgroll." }, "lockTimeout": { "type": "integer", "minimum": 0, "description": "PostgreSQL DDL lock timeout in milliseconds; native default 500." }, "role": { "type": "string", "minLength": 1, "description": "Optional PostgreSQL role used while executing migrations." }, "useVersionSchema": { "type": "boolean", "description": "Create version schemas for migrations; native default true. Explicit false is passed through." }, "verbose": { "type": "boolean", "description": "Enable native verbose logging." }, "file": { "type": "string", "minLength": 1, "description": "Existing SQL input file to convert to a pgroll migration." }, "json": { "type": "boolean", "description": "Write migration files in JSON instead of YAML." }, "arguments": { "type": "string", "description": "Additional literal CLI tokens as comma-separated text; double-quote CSV entries containing commas and double embedded quotes. No shell expansion occurs." } }, "required": [ "runDir", "file" ], "additionalProperties": false }, "output": { "type": "object", "required": [ "outcome", "runDir", "reportPath", "stdoutPath", "stderrPath" ], "properties": { "outcome": { "type": "string" }, "runDir": { "type": "string" }, "reportPath": { "type": "string" }, "stdoutPath": { "type": "string" }, "stderrPath": { "type": "string" } }, "additionalProperties": false } }, "update": { "description": "Rewrite outdated migration files in place; review changes before committing them.", "input": { "type": "object", "properties": { "project": { "type": "string", "default": ".", "minLength": 1, "description": "Working directory containing the source checkout; defaults to the current directory. Default: \".\"." }, "runDir": { "type": "string", "minLength": 1, "description": "Fresh directory for this invocation’s execution report and task logs; must not already exist." }, "executable": { "type": "string", "minLength": 1, "description": "Native CLI executable name or absolute path; defaults to this operation’s tool." }, "timeoutMs": { "type": "integer", "minimum": 1, "default": 900000, "description": "Maximum task duration in milliseconds; defaults to 900000. Default: 900000." }, "artifacts": { "type": "string", "description": "Comma-separated NAME=PATH output artifacts; use CSV double quotes around entries containing commas." }, "postgresUrl": { "type": "string", "minLength": 1, "description": "PostgreSQL connection URL; prefer inherited PGROLL_PG_URL for credentials because explicit arguments appear in execution plans." }, "schema": { "type": "string", "minLength": 1, "description": "PostgreSQL schema to migrate; native default public." }, "stateSchema": { "type": "string", "minLength": 1, "description": "Schema containing pgroll internal state; native default pgroll." }, "lockTimeout": { "type": "integer", "minimum": 0, "description": "PostgreSQL DDL lock timeout in milliseconds; native default 500." }, "role": { "type": "string", "minLength": 1, "description": "Optional PostgreSQL role used while executing migrations." }, "useVersionSchema": { "type": "boolean", "description": "Create version schemas for migrations; native default true. Explicit false is passed through." }, "verbose": { "type": "boolean", "description": "Enable native verbose logging." }, "directory": { "type": "string", "minLength": 1, "description": "Existing directory of migration files to rewrite to the current format." }, "json": { "type": "boolean", "description": "Write migration files in JSON instead of YAML." }, "arguments": { "type": "string", "description": "Additional literal CLI tokens as comma-separated text; double-quote CSV entries containing commas and double embedded quotes. No shell expansion occurs." } }, "required": [ "runDir", "directory" ], "additionalProperties": false }, "output": { "type": "object", "required": [ "outcome", "runDir", "reportPath", "stdoutPath", "stderrPath" ], "properties": { "outcome": { "type": "string" }, "runDir": { "type": "string" }, "reportPath": { "type": "string" }, "stdoutPath": { "type": "string" }, "stderrPath": { "type": "string" } }, "additionalProperties": false } }, "create": { "description": "Create an empty named migration file noninteractively in the working directory.", "input": { "type": "object", "properties": { "project": { "type": "string", "default": ".", "minLength": 1, "description": "Working directory containing the source checkout; defaults to the current directory. Default: \".\"." }, "runDir": { "type": "string", "minLength": 1, "description": "Fresh directory for this invocation’s execution report and task logs; must not already exist." }, "executable": { "type": "string", "minLength": 1, "description": "Native CLI executable name or absolute path; defaults to this operation’s tool." }, "timeoutMs": { "type": "integer", "minimum": 1, "default": 900000, "description": "Maximum task duration in milliseconds; defaults to 900000. Default: 900000." }, "artifacts": { "type": "string", "description": "Comma-separated NAME=PATH output artifacts; use CSV double quotes around entries containing commas." }, "postgresUrl": { "type": "string", "minLength": 1, "description": "PostgreSQL connection URL; prefer inherited PGROLL_PG_URL for credentials because explicit arguments appear in execution plans." }, "schema": { "type": "string", "minLength": 1, "description": "PostgreSQL schema to migrate; native default public." }, "stateSchema": { "type": "string", "minLength": 1, "description": "Schema containing pgroll internal state; native default pgroll." }, "lockTimeout": { "type": "integer", "minimum": 0, "description": "PostgreSQL DDL lock timeout in milliseconds; native default 500." }, "role": { "type": "string", "minLength": 1, "description": "Optional PostgreSQL role used while executing migrations." }, "useVersionSchema": { "type": "boolean", "description": "Create version schemas for migrations; native default true. Explicit false is passed through." }, "verbose": { "type": "boolean", "description": "Enable native verbose logging." }, "name": { "type": "string", "minLength": 1, "description": "Migration filename stem, including a relative path if desired; pgroll adds .yaml or .json." }, "json": { "type": "boolean", "description": "Write migration files in JSON instead of YAML." }, "arguments": { "type": "string", "description": "Additional literal CLI tokens as comma-separated text; double-quote CSV entries containing commas and double embedded quotes. No shell expansion occurs." } }, "required": [ "runDir", "name" ], "additionalProperties": false }, "output": { "type": "object", "required": [ "outcome", "runDir", "reportPath", "stdoutPath", "stderrPath" ], "properties": { "outcome": { "type": "string" }, "runDir": { "type": "string" }, "reportPath": { "type": "string" }, "stdoutPath": { "type": "string" }, "stderrPath": { "type": "string" } }, "additionalProperties": false } }, "latest": { "description": "Access native latest subcommands through the CSV arguments string.", "input": { "type": "object", "properties": { "project": { "type": "string", "default": ".", "minLength": 1, "description": "Working directory containing the source checkout; defaults to the current directory. Default: \".\"." }, "runDir": { "type": "string", "minLength": 1, "description": "Fresh directory for this invocation’s execution report and task logs; must not already exist." }, "executable": { "type": "string", "minLength": 1, "description": "Native CLI executable name or absolute path; defaults to this operation’s tool." }, "timeoutMs": { "type": "integer", "minimum": 1, "default": 900000, "description": "Maximum task duration in milliseconds; defaults to 900000. Default: 900000." }, "artifacts": { "type": "string", "description": "Comma-separated NAME=PATH output artifacts; use CSV double quotes around entries containing commas." }, "postgresUrl": { "type": "string", "minLength": 1, "description": "PostgreSQL connection URL; prefer inherited PGROLL_PG_URL for credentials because explicit arguments appear in execution plans." }, "schema": { "type": "string", "minLength": 1, "description": "PostgreSQL schema to migrate; native default public." }, "stateSchema": { "type": "string", "minLength": 1, "description": "Schema containing pgroll internal state; native default pgroll." }, "lockTimeout": { "type": "integer", "minimum": 0, "description": "PostgreSQL DDL lock timeout in milliseconds; native default 500." }, "role": { "type": "string", "minLength": 1, "description": "Optional PostgreSQL role used while executing migrations." }, "useVersionSchema": { "type": "boolean", "description": "Create version schemas for migrations; native default true. Explicit false is passed through." }, "verbose": { "type": "boolean", "description": "Enable native verbose logging." }, "arguments": { "type": "string", "description": "Additional literal CLI tokens as comma-separated text; double-quote CSV entries containing commas and double embedded quotes. No shell expansion occurs." } }, "required": [ "runDir" ], "additionalProperties": false }, "output": { "type": "object", "required": [ "outcome", "runDir", "reportPath", "stdoutPath", "stderrPath" ], "properties": { "outcome": { "type": "string" }, "runDir": { "type": "string" }, "reportPath": { "type": "string" }, "stdoutPath": { "type": "string" }, "stderrPath": { "type": "string" } }, "additionalProperties": false } }, "latest_migration": { "description": "Print the latest migration from the target database or local migration directory.", "input": { "type": "object", "properties": { "project": { "type": "string", "default": ".", "minLength": 1, "description": "Working directory containing the source checkout; defaults to the current directory. Default: \".\"." }, "runDir": { "type": "string", "minLength": 1, "description": "Fresh directory for this invocation’s execution report and task logs; must not already exist." }, "executable": { "type": "string", "minLength": 1, "description": "Native CLI executable name or absolute path; defaults to this operation’s tool." }, "timeoutMs": { "type": "integer", "minimum": 1, "default": 900000, "description": "Maximum task duration in milliseconds; defaults to 900000. Default: 900000." }, "artifacts": { "type": "string", "description": "Comma-separated NAME=PATH output artifacts; use CSV double quotes around entries containing commas." }, "postgresUrl": { "type": "string", "minLength": 1, "description": "PostgreSQL connection URL; prefer inherited PGROLL_PG_URL for credentials because explicit arguments appear in execution plans." }, "schema": { "type": "string", "minLength": 1, "description": "PostgreSQL schema to migrate; native default public." }, "stateSchema": { "type": "string", "minLength": 1, "description": "Schema containing pgroll internal state; native default pgroll." }, "lockTimeout": { "type": "integer", "minimum": 0, "description": "PostgreSQL DDL lock timeout in milliseconds; native default 500." }, "role": { "type": "string", "minLength": 1, "description": "Optional PostgreSQL role used while executing migrations." }, "useVersionSchema": { "type": "boolean", "description": "Create version schemas for migrations; native default true. Explicit false is passed through." }, "verbose": { "type": "boolean", "description": "Enable native verbose logging." }, "local": { "type": "string", "minLength": 1, "description": "Existing local migration directory; omit to discover the latest version from the target database." }, "arguments": { "type": "string", "description": "Additional literal CLI tokens as comma-separated text; double-quote CSV entries containing commas and double embedded quotes. No shell expansion occurs." } }, "required": [ "runDir" ], "additionalProperties": false }, "output": { "type": "object", "required": [ "outcome", "runDir", "reportPath", "stdoutPath", "stderrPath" ], "properties": { "outcome": { "type": "string" }, "runDir": { "type": "string" }, "reportPath": { "type": "string" }, "stdoutPath": { "type": "string" }, "stderrPath": { "type": "string" } }, "additionalProperties": false } }, "latest_schema": { "description": "Print the latest schema from the target database or local migration directory.", "input": { "type": "object", "properties": { "project": { "type": "string", "default": ".", "minLength": 1, "description": "Working directory containing the source checkout; defaults to the current directory. Default: \".\"." }, "runDir": { "type": "string", "minLength": 1, "description": "Fresh directory for this invocation’s execution report and task logs; must not already exist." }, "executable": { "type": "string", "minLength": 1, "description": "Native CLI executable name or absolute path; defaults to this operation’s tool." }, "timeoutMs": { "type": "integer", "minimum": 1, "default": 900000, "description": "Maximum task duration in milliseconds; defaults to 900000. Default: 900000." }, "artifacts": { "type": "string", "description": "Comma-separated NAME=PATH output artifacts; use CSV double quotes around entries containing commas." }, "postgresUrl": { "type": "string", "minLength": 1, "description": "PostgreSQL connection URL; prefer inherited PGROLL_PG_URL for credentials because explicit arguments appear in execution plans." }, "schema": { "type": "string", "minLength": 1, "description": "PostgreSQL schema to migrate; native default public." }, "stateSchema": { "type": "string", "minLength": 1, "description": "Schema containing pgroll internal state; native default pgroll." }, "lockTimeout": { "type": "integer", "minimum": 0, "description": "PostgreSQL DDL lock timeout in milliseconds; native default 500." }, "role": { "type": "string", "minLength": 1, "description": "Optional PostgreSQL role used while executing migrations." }, "useVersionSchema": { "type": "boolean", "description": "Create version schemas for migrations; native default true. Explicit false is passed through." }, "verbose": { "type": "boolean", "description": "Enable native verbose logging." }, "local": { "type": "string", "minLength": 1, "description": "Existing local migration directory; omit to discover the latest version from the target database." }, "arguments": { "type": "string", "description": "Additional literal CLI tokens as comma-separated text; double-quote CSV entries containing commas and double embedded quotes. No shell expansion occurs." } }, "required": [ "runDir" ], "additionalProperties": false }, "output": { "type": "object", "required": [ "outcome", "runDir", "reportPath", "stdoutPath", "stderrPath" ], "properties": { "outcome": { "type": "string" }, "runDir": { "type": "string" }, "reportPath": { "type": "string" }, "stdoutPath": { "type": "string" }, "stderrPath": { "type": "string" } }, "additionalProperties": false } }, "latest_url": { "description": "Print the latest connection URL with version schema search_path from the target database or local migration directory.", "input": { "type": "object", "properties": { "project": { "type": "string", "default": ".", "minLength": 1, "description": "Working directory containing the source checkout; defaults to the current directory. Default: \".\"." }, "runDir": { "type": "string", "minLength": 1, "description": "Fresh directory for this invocation’s execution report and task logs; must not already exist." }, "executable": { "type": "string", "minLength": 1, "description": "Native CLI executable name or absolute path; defaults to this operation’s tool." }, "timeoutMs": { "type": "integer", "minimum": 1, "default": 900000, "description": "Maximum task duration in milliseconds; defaults to 900000. Default: 900000." }, "artifacts": { "type": "string", "description": "Comma-separated NAME=PATH output artifacts; use CSV double quotes around entries containing commas." }, "postgresUrl": { "type": "string", "minLength": 1, "description": "PostgreSQL connection URL; prefer inherited PGROLL_PG_URL for credentials because explicit arguments appear in execution plans." }, "schema": { "type": "string", "minLength": 1, "description": "PostgreSQL schema to migrate; native default public." }, "stateSchema": { "type": "string", "minLength": 1, "description": "Schema containing pgroll internal state; native default pgroll." }, "lockTimeout": { "type": "integer", "minimum": 0, "description": "PostgreSQL DDL lock timeout in milliseconds; native default 500." }, "role": { "type": "string", "minLength": 1, "description": "Optional PostgreSQL role used while executing migrations." }, "useVersionSchema": { "type": "boolean", "description": "Create version schemas for migrations; native default true. Explicit false is passed through." }, "verbose": { "type": "boolean", "description": "Enable native verbose logging." }, "local": { "type": "string", "minLength": 1, "description": "Existing local migration directory; omit to discover the latest version from the target database." }, "connectionString": { "type": "string", "minLength": 1, "description": "Optional connection URL to rewrite; omit to use PGROLL_PG_URL or postgresUrl. Output may contain credentials." }, "arguments": { "type": "string", "description": "Additional literal CLI tokens as comma-separated text; double-quote CSV entries containing commas and double embedded quotes. No shell expansion occurs." } }, "required": [ "runDir" ], "additionalProperties": false }, "output": { "type": "object", "required": [ "outcome", "runDir", "reportPath", "stdoutPath", "stderrPath" ], "properties": { "outcome": { "type": "string" }, "runDir": { "type": "string" }, "reportPath": { "type": "string" }, "stdoutPath": { "type": "string" }, "stderrPath": { "type": "string" } }, "additionalProperties": false } }, "completion": { "description": "Generate shell completion scripts through literal native CSV arguments.", "input": { "type": "object", "properties": { "project": { "type": "string", "default": ".", "minLength": 1, "description": "Working directory containing the source checkout; defaults to the current directory. Default: \".\"." }, "runDir": { "type": "string", "minLength": 1, "description": "Fresh directory for this invocation’s execution report and task logs; must not already exist." }, "executable": { "type": "string", "minLength": 1, "description": "Native CLI executable name or absolute path; defaults to this operation’s tool." }, "timeoutMs": { "type": "integer", "minimum": 1, "default": 900000, "description": "Maximum task duration in milliseconds; defaults to 900000. Default: 900000." }, "artifacts": { "type": "string", "description": "Comma-separated NAME=PATH output artifacts; use CSV double quotes around entries containing commas." }, "arguments": { "type": "string", "description": "Additional literal CLI tokens as comma-separated text; double-quote CSV entries containing commas and double embedded quotes. No shell expansion occurs." } }, "required": [ "runDir" ], "additionalProperties": false }, "output": { "type": "object", "required": [ "outcome", "runDir", "reportPath", "stdoutPath", "stderrPath" ], "properties": { "outcome": { "type": "string" }, "runDir": { "type": "string" }, "reportPath": { "type": "string" }, "stdoutPath": { "type": "string" }, "stderrPath": { "type": "string" } }, "additionalProperties": false } } } }