Migrondi.json

To be able to use this tool you need to supply a JSON configuration file named migrondi.json this file can be on the root of your project or in a dedicated directory such as migrations.

{
  "connection": "Data Source=./migrondi.db",
  "migrations": "./migrations",
  "tableName": "__migrondi_migrations",
  "driver": "sqlite"
}

• connection

  This is a IDbConnection compatible connection string (you can find examples in the follwing links)

  • SqlServer

  • SQLite

  • MySQL

  • PostgreSQL

• migrations

  this is an absolute or relative path to where the migrations will be stored Note: please include the trailing slash to prevent writing on the directory above of the one you pointed to. (if you use the init command, this is created for you)

• tableName

  this is the name of the table that will be used to store the migrations, this table will be created for you if it does not exist.

• driver

  any of the following "mssql" "sqlite" "mysql" "postgres"

Environment Variables and CLI options

The following environment variables can be used to configure migrondi:

• MIGRONDI_CONNECTION: The connection string to the database
• MIGRONDI_MIGRATIONS: The directory where the migration files are stored
• MIGRONDI_TABLE_NAME: The name of the table that will store the migrations
• MIGRONDI_DRIVER: The driver to use for the database connection

You can pass the options via the CLI:

• --connection: The connection string to the database
• --migrations: The directory where the migration files are stored
• --table-name: The name of the table that will store the migrations
• --driver: The driver to use for the database connection

For example:

migrondi --driver sqlite --connection "Data Source=./migrondi.db" up --dry

*NOTE*: The configuration flags MUST be passed before the command, otherwise they will be interpreted as arguments for the command and will fail.

The priority of the configuration is as follows:

migrondi.json < Environment variables < CLI options