OS Manuals

/usr/local/bin/dbmate

Compat package to place binaries in location expected by upstream Docker image

From dbmate-compat 2.38.1-r0 (os), captured 2026-11-10 by running dbmate --help (exit 0). permalink

Also provided by 1 other package version
NAME:
   dbmate - A lightweight, framework-independent database migration tool.

USAGE:
   dbmate [global options] command [command options]

VERSION:
   2.38.1

COMMANDS:
   new, n          Generate a new migration file
   up              Create database (if necessary) and migrate to the latest version
   create          Create database
   drop            Drop database (if it exists)
   migrate         Migrate to the latest version
   rollback, down  Rollback the most recent migration
   status          List applied and pending migrations
   dump            Write the database schema to disk.
                   Supports passing extra arguments to the underlying dump tool for pg/mysql
                   example: dbmate dump -- --extra-flag
   load            Load schema file to the database
   wait            Wait for the database to become available
   help, h         Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --url value, -u value                                                  specify the database URL
   --driver value                                                         specify the driver to use (instead of deriving from the database URL scheme) [$DBMATE_DRIVER]
   --env value, -e value                                                  specify an environment variable containing the database URL (default: "DATABASE_URL")
   --env-file value [ --env-file value ]                                  specify a file to load environment variables from (default: ".env")
   --migrations-dir value, -d value [ --migrations-dir value, -d value ]  specify the directory containing migration files (default: "./db/migrations") [$DBMATE_MIGRATIONS_DIR]
   --migrations-table value                                               specify the database table to record migrations in (default: "schema_migrations") [$DBMATE_MIGRATIONS_TABLE]
   --schema-file value, -s value                                          specify the schema file location (default: "./db/schema.sql") [$DBMATE_SCHEMA_FILE]
   --no-dump-schema                                                       don't update the schema file on migrate/rollback (default: false) [$DBMATE_NO_DUMP_SCHEMA]
   --wait                                                                 wait for the db to become available before executing the subsequent command (default: false) [$DBMATE_WAIT]
   --wait-timeout value                                                   timeout for --wait flag (default: 1m0s) [$DBMATE_WAIT_TIMEOUT]
   --wait-interval value                                                  time to wait between connection attempts for --wait flag (default: 1s) [$DBMATE_WAIT_INTERVAL]
   --migration-lock                                                       hold a database lock while migrating so that concurrent dbmate instances wait for each other (postgres only) (default: false) [$DBMATE_MIGRATION_LOCK]
   --migration-lock-timeout value                                         maximum time to wait for the migration lock, 0 to wait indefinitely (default: 5m0s) [$DBMATE_MIGRATION_LOCK_TIMEOUT]
   --migration-application-name                                           record migration version in application_name during execution (postgres only) (default: false) [$DBMATE_MIGRATION_APPLICATION_NAME]
   --help, -h                                                             show help
   --version, -v                                                          print the version
Options (16)
OptionDescriptionSource
--url, -u valuespecify the database URLhelp
--driver valuespecify the driver to use (instead of deriving from the database URL scheme) [$DBMATE_DRIVER]help
--env, -e valuespecify an environment variable containing the database URL (default: "DATABASE_URL")help
--env-file valuespecify a file to load environment variables from (default: ".env")help
--migrations-dir, -d, -d valuespecify the directory containing migration files (default: "./db/migrations") [$DBMATE_MIGRATIONS_DIR]help
--migrations-table valuespecify the database table to record migrations in (default: "schema_migrations") [$DBMATE_MIGRATIONS_TABLE]help
--schema-file, -s valuespecify the schema file location (default: "./db/schema.sql") [$DBMATE_SCHEMA_FILE]help
--no-dump-schemadon't update the schema file on migrate/rollback (default: false) [$DBMATE_NO_DUMP_SCHEMA]help
--waitwait for the db to become available before executing the subsequent command (default: false) [$DBMATE_WAIT]help
--wait-timeout valuetimeout for --wait flag (default: 1m0s) [$DBMATE_WAIT_TIMEOUT]help
--wait-interval valuetime to wait between connection attempts for --wait flag (default: 1s) [$DBMATE_WAIT_INTERVAL]help
--migration-lockhold a database lock while migrating so that concurrent dbmate instances wait for each other (postgres only) (default: false) [$DBMATE_MIGRATION_LOCK]help
--migration-lock-timeout valuemaximum time to wait for the migration lock, 0 to wait indefinitely (default: 5m0s) [$DBMATE_MIGRATION_LOCK_TIMEOUT]help
--migration-application-namerecord migration version in application_name during execution (postgres only) (default: false) [$DBMATE_MIGRATION_APPLICATION_NAME]help
--help, -hshow helphelp
--version, -vprint the versionhelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.