cli-definition.json

{
  "name": "pgroll",
  "commands": [
    {
      "name": "analyze",
      "short": "Analyze the SQL schema of the target database",
      "use": "analyze",
      "example": "",
      "flags": [],
      "subcommands": [],
      "args": []
    },
    {
      "name": "complete",
      "short": "Complete an ongoing migration with the operations present in the given file",
      "use": "complete <file>",
      "example": "",
      "flags": [],
      "subcommands": [],
      "args": []
    },
    {
      "name": "convert",
      "short": "Convert SQL statements to a pgroll migration",
      "use": "convert <path to file with migrations>",
      "example": "",
      "flags": [
        {
          "name": "name",
          "shorthand": "n",
          "description": "Name of the migration",
          "default": "{current_timestamp}"
        }
      ],
      "subcommands": [],
      "args": [
        "migration-file"
      ]
    },
    {
      "name": "init",
      "short": "Initialize pgroll in the target database",
      "use": "init <file>",
      "example": "",
      "flags": [],
      "subcommands": [],
      "args": []
    },
    {
      "name": "latest",
      "short": "Print the name of the latest schema version, either in the target database or a local directory",
      "use": "latest",
      "example": "latest --local ./migrations",
      "flags": [
        {
          "name": "local",
          "shorthand": "l",
          "description": "retrieve the latest version from a local migration directory",
          "default": ""
        },
        {
          "name": "with-schema",
          "shorthand": "s",
          "description": "prefix the version with the schema name",
          "default": "false"
        }
      ],
      "subcommands": [],
      "args": []
    },
    {
      "name": "migrate",
      "short": "Apply outstanding migrations from a directory to a database",
      "use": "migrate <directory>",
      "example": "migrate ./migrations",
      "flags": [
        {
          "name": "backfill-batch-delay",
          "description": "Duration of delay between batch backfills (eg. 1s, 1000ms)",
          "default": "0s"
        },
        {
          "name": "backfill-batch-size",
          "description": "Number of rows backfilled in each batch",
          "default": "1000"
        },
        {
          "name": "complete",
          "shorthand": "c",
          "description": "complete the final migration rather than leaving it active",
          "default": "false"
        }
      ],
      "subcommands": [],
      "args": [
        "directory"
      ]
    },
    {
      "name": "pull",
      "short": "Pull migration history from the target database and write it to disk",
      "use": "pull <target directory>",
      "example": "",
      "flags": [
        {
          "name": "with-prefixes",
          "shorthand": "p",
          "description": "prefix each migration filename with its position in the schema history",
          "default": "false"
        }
      ],
      "subcommands": [],
      "args": [
        "directory"
      ]
    },
    {
      "name": "rollback",
      "short": "Roll back an ongoing migration",
      "use": "rollback <file>",
      "example": "",
      "flags": [],
      "subcommands": [],
      "args": []
    },
    {
      "name": "start",
      "short": "Start a migration for the operations present in the given file",
      "use": "start <file>",
      "example": "",
      "flags": [
        {
          "name": "backfill-batch-delay",
          "description": "Duration of delay between batch backfills (eg. 1s, 1000ms)",
          "default": "0s"
        },
        {
          "name": "backfill-batch-size",
          "description": "Number of rows backfilled in each batch",
          "default": "1000"
        },
        {
          "name": "complete",
          "shorthand": "c",
          "description": "Mark the migration as complete",
          "default": "false"
        },
        {
          "name": "skip-validation",
          "shorthand": "s",
          "description": "skip migration validation",
          "default": "false"
        }
      ],
      "subcommands": [],
      "args": [
        "file"
      ]
    },
    {
      "name": "status",
      "short": "Show pgroll status",
      "use": "status",
      "example": "",
      "flags": [],
      "subcommands": [],
      "args": []
    }
  ],
  "flags": [
    {
      "name": "lock-timeout",
      "description": "Postgres lock timeout in milliseconds for pgroll DDL operations",
      "default": "500"
    },
    {
      "name": "pgroll-schema",
      "description": "Postgres schema to use for pgroll internal state",
      "default": "pgroll"
    },
    {
      "name": "postgres-url",
      "description": "Postgres URL",
      "default": "postgres://postgres:postgres@localhost?sslmode=disable"
    },
    {
      "name": "role",
      "description": "Optional postgres role to set when executing migrations",
      "default": ""
    },
    {
      "name": "schema",
      "description": "Postgres schema to use for the migration",
      "default": "public"
    }
  ]
}