From 8b1a5f952bae459621741cbcbfe41319322531a0 Mon Sep 17 00:00:00 2001 From: ginokent <29125616+ginokent@users.noreply.github.com> Date: Tue, 16 Jan 2024 16:22:50 +0900 Subject: [PATCH] docs: Update README.md --- README.md | 32 +++++++++++++++++++++++++------- 1 file changed, 25 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 2354195..4c23588 100644 --- a/README.md +++ b/README.md @@ -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 to . + apply: apply DDL from to . options: --trace (env: DDLCTL_TRACE, default: false) @@ -177,7 +178,7 @@ Usage: ddlctl generate [options] --dialect --src --dst Description: - command "ddlctl generate" description + generate DDL from source (file or directory) to destination (file or directory). options: --lang (env: DDLCTL_LANGUAGE, default: go) @@ -198,15 +199,32 @@ options: show usage ``` +### `ddlctl show` + +```console +$ ddlctl show --help +Usage: + ddlctl show --dialect + +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 + ddlctl diff [options] --dialect Description: - command "ddlctl diff" description + diff DDL from to . options: --lang (env: DDLCTL_LANGUAGE, default: go) @@ -231,7 +249,7 @@ Usage: ddlctl apply [options] --dialect Description: - command "ddlctl apply" description + apply DDL from to . options: --lang (env: DDLCTL_LANGUAGE, default: go)