Skip to content

Commit

Permalink
docs: Update README.md (#17)
Browse files Browse the repository at this point in the history
  • Loading branch information
ginokent authored Jan 16, 2024
2 parents 6be59b5 + 8b1a5f9 commit 3a31b2b
Showing 1 changed file with 25 additions and 7 deletions.
32 changes: 25 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,9 +156,10 @@ Description:

sub commands:
version: show version
generate: command "generate" description
diff: command "diff" description
apply: command "apply" description
generate: generate DDL from source (file or directory) to destination (file or directory).
show: show DDL from DSN like `SHOW CREATE TABLE`.
diff: diff DDL from <before DDL source> to <after DDL source>.
apply: apply DDL from <DDL source> to <DSN to apply>.

options:
--trace (env: DDLCTL_TRACE, default: false)
Expand All @@ -177,7 +178,7 @@ Usage:
ddlctl generate [options] --dialect <DDL dialect> --src <source> --dst <destination>

Description:
command "ddlctl generate" description
generate DDL from source (file or directory) to destination (file or directory).

options:
--lang (env: DDLCTL_LANGUAGE, default: go)
Expand All @@ -198,15 +199,32 @@ options:
show usage
```

### `ddlctl show`

```console
$ ddlctl show --help
Usage:
ddlctl show --dialect <DDL dialect> <DSN>

Description:
show DDL from DSN like `SHOW CREATE TABLE`.

options:
--dialect (env: DDLCTL_DIALECT, default: )
SQL dialect to generate DDL
--help (default: false)
show usage
```

### `ddlctl diff`

```console
$ ddlctl diff --help
Usage:
ddlctl diff [options] --dialect <DDL dialect> <DDL source before> <DDL source after>
ddlctl diff [options] --dialect <DDL dialect> <before DDL source> <after DDL source>

Description:
command "ddlctl diff" description
diff DDL from <before DDL source> to <after DDL source>.

options:
--lang (env: DDLCTL_LANGUAGE, default: go)
Expand All @@ -231,7 +249,7 @@ Usage:
ddlctl apply [options] --dialect <DDL dialect> <DSN to apply> <DDL source>

Description:
command "ddlctl apply" description
apply DDL from <DDL source> to <DSN to apply>.

options:
--lang (env: DDLCTL_LANGUAGE, default: go)
Expand Down

0 comments on commit 3a31b2b

Please sign in to comment.