Skip to content

Commit 07e0721

Browse files
committed
docs: update help definition
1 parent c0d3e7f commit 07e0721

File tree

1 file changed

+18
-17
lines changed

1 file changed

+18
-17
lines changed

README.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -76,32 +76,33 @@ mig --folder="c:\\path\\to\\migrations" --database=MyLocalDatabase
7676
Use `mig --help` to show the complete set of options:
7777

7878
``` cmd
79-
Usage: mig [OPTIONS]+
80-
Runs all *.sql files in the folder --folder=<directory>.
81-
The databse connection can be specified using a full connection string
82-
with --connection, or Minimig can generate an integrated auth connection
83-
string using the --database and optional --server arguments.
79+
Usage: Minimig [OPTIONS]+
80+
Runs all *.sql files in the directory --dir=<directory>.
81+
The databse connection can be specified using a full connection string with --connection,
82+
or Minimig can generate an integrated auth connection string using the --database and
83+
optional --server arguments.
8484
8585
-h, --help Shows this help message.
86-
-c, --connection=VALUE A SQL Server connection string. For integrated
87-
auth, you can use --database and --server
88-
instead.
89-
-d, --database=VALUE Generates an integrated auth connection string
86+
-c, --connection=VALUE A connection string (can be Postgresql or
87+
SqlServer or MySql). For integrated auth, you
88+
can use --database and --server instead.
89+
-d, --database=VALUE Generates an integrated auth connection string
9090
for the specified database.
91-
-s, --server=VALUE Generates an integrated auth connection string
91+
-s, --server=VALUE Generates an integrated auth connection string
9292
with the specified server (default: localhost).
93-
-f, --folder=VALUE The folder containing your .sql migration files
93+
-f, --folder=VALUE The folder containing your .sql migration files
9494
(defaults to current working directory).
9595
--timeout=VALUE Command timeout duration in seconds (default: 30)
9696
--preview Run outstanding migrations, but roll them back.
97-
--global Run all outstanding migrations in a single
97+
-p, --provider=VALUE Use a specific database provider options:
98+
sqlserver (default), postgres, mysql
99+
--global Run all outstanding migrations in a single
98100
transaction, if possible.
99-
--table=VALUE Name of the table used to track migrations
101+
--table=VALUE Name of the table used to track migrations
100102
(default: Migrations)
101-
--schema=VALUE Name of the schema used to track migrations
102-
(default: dbo)
103-
-p, --provider=VALUE Use a specific database provider options:
104-
sqlserver (default), postgres, mysql
103+
--schema=VALUE Name of the schema to be used to track
104+
migrations (default: dbo for sqlserver, public
105+
for postgres, mysql for mysql)
105106
--force Will rerun modified migrations.
106107
--version Print version number.
107108
--count Print the number of outstanding migrations.

0 commit comments

Comments
 (0)