Public interface for lib's users.
Public interface for lib's users.
(explain args)
Show raw SQL or human-readable description for a migration by number.
Available options:
:migrations-dir - Path to directory containing migration files. (required)
:number - Integer number of the migration to explain. (required)
:direction - Direction of the migration to explain, can be forward
(default) or backward
. (optional)
:format - Format of explanation, can be sql
(default) or human
. (optional)
Show raw SQL or human-readable description for a migration by number. Available options: :migrations-dir - Path to directory containing migration files. (required) :number - Integer number of the migration to explain. (required) :direction - Direction of the migration to explain, can be `forward` (default) or `backward`. (optional) :format - Format of explanation, can be `sql` (default) or `human`. (optional)
(help args)
Help information for all commands of automigrate tool.
Available options: :cmd - Command name to display help information for a specific command. (optional)
Help information for all commands of automigrate tool. Available options: :cmd - Command name to display help information for a specific command. (optional)
(list args)
Show the list of existing migrations with status.
Available options: :jdbc-url - JDBC url for the database connection. (required) :migrations-dir - Path to directory containing migration files. (required) :migrations-table - Custom name for the migrations table in the database. (optional)
Show the list of existing migrations with status. Available options: :jdbc-url - JDBC url for the database connection. (required) :migrations-dir - Path to directory containing migration files. (required) :migrations-table - Custom name for the migrations table in the database. (optional)
(make args)
Create a new migration based on changes to the models.
Available options:
:models-file - Path to the file with model definitions. (required)
:migrations-dir - Path to directory containing migration files. (required)
:name - Custom name for a migration. (optional)
:type - Type of a new migration, empty by default for auto-migration.
Also available :empty-sql
- for creating an empty raw SQL migration. (optional)
Create a new migration based on changes to the models. Available options: :models-file - Path to the file with model definitions. (required) :migrations-dir - Path to directory containing migration files. (required) :name - Custom name for a migration. (optional) :type - Type of a new migration, empty by default for auto-migration. Also available `:empty-sql` - for creating an empty raw SQL migration. (optional)
(migrate args)
Run existing migrations and change the database schema.
Available options: :jdbc-url - JDBC url for the database connection. (required) :migrations-dir - Path to directory containing migration files. (required) :migrations-table - Custom name for the migrations table in the database. (optional) :number - Integer number of the target migration. (optional)
Run existing migrations and change the database schema. Available options: :jdbc-url - JDBC url for the database connection. (required) :migrations-dir - Path to directory containing migration files. (required) :migrations-table - Custom name for the migrations table in the database. (optional) :number - Integer number of the target migration. (optional)
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close