stork-db-migrate - Stork database migration tool¶
stork-db-migrate [options] command
stork-db-migrate tool is an option to assist with database schema migrations.
Usually, there is no need to use this tool, as the Stork server always runs the migration scripts on startup.
However, it may be useful for debugging and manual migrations.
stork-db-migrate takes the following commands:
downRevert last migration (or use -t to migrate to a specific version)
initCreate schema versioning table in the database
resetRevert all migrations
set_versionSet database version without running migrations
upRun all available migrations (or use -t to migrate to a specific version)
versionPrint current migration version
- the name of the database to connect to. (default: stork) [$STORK_DATABASE_NAME]
- the user name to be used for database connections. (default: stork) [$STORK_DATABASE_USER_NAME]
- the name of the host where the database is available. (default: localhost) [$STORK_DATABASE_HOST]
- the port on which the database is available. (default: 5432) [$STORK_DATABASE_PORT]
- enable tracing SQL queries: run (only runtime, without migrations), all (migrations and run-time)).
allis the default and covers both migrations and
run-time.enabletracing SQL queries. [$STORK_DATABASE_TRACE]
- show help message
Note that there is no argument for the database password, as the command-line arguments can sometimes be seen by other users. It can be passed using the STORK_DATABASE_PASSWORD variable.
Mailing Lists and Support¶
There are public mailing lists available for the Stork project. stork-users (stork-users at lists.isc.org) is intended for Stork users. stork-dev (stork-dev at lists.isc.org) is intended for Stork developers, prospective contributors, and other advanced users. The lists are available at https://lists.isc.org. The community provides best-effort support on both of those lists.
Once stork becomes more mature, ISC will provide professional support for Stork services.
stork-db-migrate tool was first coded in October 2019 by Marcin Siodelski.