From 07e072186c8ecef95602ffa3e4f89907658fe755 Mon Sep 17 00:00:00 2001 From: Jaxel Rojas Date: Tue, 18 May 2021 09:31:06 -0400 Subject: [PATCH] docs: update help definition --- README.md | 35 ++++++++++++++++++----------------- 1 file changed, 18 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 1a1801d..c279446 100644 --- a/README.md +++ b/README.md @@ -76,32 +76,33 @@ mig --folder="c:\\path\\to\\migrations" --database=MyLocalDatabase Use `mig --help` to show the complete set of options: ``` cmd -Usage: mig [OPTIONS]+ - Runs all *.sql files in the folder --folder=. - The databse connection can be specified using a full connection string - with --connection, or Minimig can generate an integrated auth connection - string using the --database and optional --server arguments. +Usage: Minimig [OPTIONS]+ + Runs all *.sql files in the directory --dir=. + The databse connection can be specified using a full connection string with --connection, + or Minimig can generate an integrated auth connection string using the --database and + optional --server arguments. -h, --help Shows this help message. - -c, --connection=VALUE A SQL Server connection string. For integrated - auth, you can use --database and --server - instead. - -d, --database=VALUE Generates an integrated auth connection string + -c, --connection=VALUE A connection string (can be Postgresql or + SqlServer or MySql). For integrated auth, you + can use --database and --server instead. + -d, --database=VALUE Generates an integrated auth connection string for the specified database. - -s, --server=VALUE Generates an integrated auth connection string + -s, --server=VALUE Generates an integrated auth connection string with the specified server (default: localhost). - -f, --folder=VALUE The folder containing your .sql migration files + -f, --folder=VALUE The folder containing your .sql migration files (defaults to current working directory). --timeout=VALUE Command timeout duration in seconds (default: 30) --preview Run outstanding migrations, but roll them back. - --global Run all outstanding migrations in a single + -p, --provider=VALUE Use a specific database provider options: + sqlserver (default), postgres, mysql + --global Run all outstanding migrations in a single transaction, if possible. - --table=VALUE Name of the table used to track migrations + --table=VALUE Name of the table used to track migrations (default: Migrations) - --schema=VALUE Name of the schema used to track migrations - (default: dbo) - -p, --provider=VALUE Use a specific database provider options: - sqlserver (default), postgres, mysql + --schema=VALUE Name of the schema to be used to track + migrations (default: dbo for sqlserver, public + for postgres, mysql for mysql) --force Will rerun modified migrations. --version Print version number. --count Print the number of outstanding migrations.