cli-definition.json

{
  "name": "pgroll",
  "commands": [
    {
      "name": "analyze",
      "short": "Analyze the SQL schema of the target database",
      "use": "analyze",
      "hidden": true,
      "example": "",
      "flags": [],
      "subcommands": [],
      "args": []
    },
    {
      "name": "baseline",
      "short": "Create a baseline migration for an existing database schema",
      "use": "baseline <version> <target directory>",
      "example": "",
      "flags": [
        {
          "name": "json",
          "shorthand": "j",
          "description": "output in JSON format instead of YAML",
          "default": "false"
        },
        {
          "name": "yes",
          "shorthand": "y",
          "description": "skip confirmation prompt",
          "default": "false"
        }
      ],
      "subcommands": [],
      "args": [
        "version",
        "directory"
      ]
    },
    {
      "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": "json",
          "shorthand": "j",
          "description": "Output migration file in JSON format instead of YAML",
          "default": "false"
        }
      ],
      "subcommands": [],
      "args": [
        "migration-file"
      ]
    },
    {
      "name": "create",
      "short": "Create a new migration interactively",
      "use": "create",
      "example": "",
      "flags": [
        {
          "name": "empty",
          "shorthand": "e",
          "description": "Create empty migration file",
          "default": "false"
        },
        {
          "name": "json",
          "shorthand": "j",
          "description": "Output migration file in JSON format instead of YAML",
          "default": "false"
        },
        {
          "name": "name",
          "shorthand": "n",
          "description": "Migration name",
          "default": ""
        }
      ],
      "subcommands": [],
      "args": []
    },
    {
      "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 or migration",
      "use": "latest",
      "example": "",
      "flags": [],
      "subcommands": [
        {
          "name": "migration",
          "short": "Print the latest migration name",
          "use": "migration",
          "example": "latest migration --local ./migrations",
          "flags": [
            {
              "name": "local",
              "shorthand": "l",
              "description": "retrieve the latest migration from a local migration directory",
              "default": ""
            }
          ],
          "subcommands": [],
          "args": []
        },
        {
          "name": "schema",
          "short": "Print the latest version schema name",
          "use": "schema",
          "example": "latest schema --local ./migrations",
          "flags": [
            {
              "name": "local",
              "shorthand": "l",
              "description": "retrieve the latest version from a local migration directory",
              "default": ""
            }
          ],
          "subcommands": [],
          "args": []
        },
        {
          "name": "url",
          "short": "Print a database connection URL for the latest schema version",
          "use": "url",
          "example": "pgroll latest url <connection-string> --local ./migrations",
          "flags": [
            {
              "name": "local",
              "shorthand": "l",
              "description": "retrieve the latest schema version from a local migration directory",
              "default": ""
            }
          ],
          "subcommands": [],
          "args": [
            "connection-string"
          ]
        }
      ],
      "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"
        },
        {
          "name": "expect-one",
          "description": "Abort if there is more than one migration to be applied",
          "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": "json",
          "shorthand": "j",
          "description": "output each migration in JSON format instead of YAML",
          "default": "false"
        }
      ],
      "subcommands": [],
      "args": [
        "directory"
      ]
    },
    {
      "name": "rollback",
      "short": "Roll back an ongoing migration",
      "use": "rollback",
      "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": []
    },
    {
      "name": "update",
      "short": "Update outdated migrations in a directory",
      "use": "update <directory>",
      "example": "update ./migrations",
      "flags": [
        {
          "name": "json",
          "shorthand": "j",
          "description": "Output migration file in JSON format instead of YAML",
          "default": "false"
        }
      ],
      "subcommands": [],
      "args": [
        "directory"
      ]
    },
    {
      "name": "validate",
      "short": "Validate a migration file",
      "use": "validate <file>",
      "example": "validate migrations/03_my_migration.yaml",
      "flags": [],
      "subcommands": [],
      "args": [
        "file"
      ]
    }
  ],
  "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"
    },
    {
      "name": "use-version-schema",
      "description": "Create version schemas for each migration",
      "default": "true"
    },
    {
      "name": "verbose",
      "description": "Enable verbose logging",
      "default": "false"
    }
  ]
}