docs: Update README.md (#57)

hakadoriya · Apr 29, 2024 · 44aa564 · 44aa564
2 parents 3c56a41 + e86c564
commit 44aa564
Show file tree

Hide file tree

Showing 6 changed files with 371 additions and 341 deletions.
diff --git a/CREDITS b/CREDITS
diff --git a/README.md b/README.md
@@ -16,7 +16,7 @@
 
 ## Demo
 
-![ddlctl_demo](https://github.com/kunitsucom/ddlctl/assets/29125616/c7a59aaf-4c13-4c8e-998b-cd42a1f956d5)
+![ddlctl_demo](https://github.com/kunitsucom/ddlctl/assets/29125616/cdb603ad-bb44-4e18-8af0-ac5bce46e319)
 
 ## Overview
 
@@ -71,9 +71,9 @@ package sample
 
 // User is a user model struct.
 //
-//pgddl:table public.users
+//pgddl:table      public.users
 //pgddl:constraint UNIQUE ("username")
-//pgddl:index "index_users_username" ON public.users ("username")
+//pgddl:index      "index_users_username" ON public.users ("username")
 type User struct {
     UserID   string `db:"user_id"  pgddl:"TEXT NOT NULL" pk:"true"`
     Username string `db:"username" pgddl:"TEXT NOT NULL"`
@@ -91,51 +91,22 @@ type Group struct {
 }
 ```
 
-Write it to an appropriate file:  
-
-```sh
-cat <<"EOF" > /tmp/sample.go
-package sample
-
-// User is a user model struct.
-//
-//pgddl:table public.users
-//pgddl:constraint UNIQUE ("username")
-//pgddl:index "index_users_username" ON public.users ("username")
-type User struct {
-    UserID   string `db:"user_id"  pgddl:"TEXT NOT NULL" pk:"true"`
-    Username string `db:"username" pgddl:"TEXT NOT NULL"`
-    Age      int    `db:"age"      pgddl:"INT  NOT NULL"`
-}
-
-// Group is a group model struct.
-//
-//pgddl:table CREATE TABLE IF NOT EXISTS public.groups
-//pgddl:index CREATE UNIQUE INDEX "index_groups_group_name" ON public.groups ("group_name")
-type Group struct {
-    GroupID     string `db:"group_id"    pgddl:"TEXT NOT NULL" pk:"true"`
-    GroupName   string `db:"group_name"  pgddl:"TEXT NOT NULL"`
-    Description string `db:"description" pgddl:"TEXT NOT NULL"`
-}
-EOF
-```
-
 ### 2. Generate DDL
 
 Please execute the ddlctl command as follows:  
 
 ```console
-$ ddlctl generate --dialect postgres --go-column-tag db --go-ddl-tag pgddl --go-pk-tag pk --src /tmp/sample.go --dst /tmp/sample.sql
-INFO: 2023/11/16 16:10:39 ddlctl.go:44: source: /tmp/sample.go
-INFO: 2023/11/16 16:10:39 ddlctl.go:73: destination: /tmp/sample.sql
+$ ddlctl generate --dialect postgres --go-column-tag db --go-ddl-tag pgddl --go-pk-tag pk sample.go sample.sql
+INFO: 2023/11/16 16:10:39 ddlctl.go:44: source: sample.go
+INFO: 2023/11/16 16:10:39 ddlctl.go:73: destination: sample.sql
 ```
 
 ### 3. Check generated DDL file
 
 Please check the contents of the outputted DDL:  
 
 ```sh
-cat /tmp/sample.sql
+cat sample.sql
 ```
 
 content:  
@@ -144,10 +115,10 @@ content:
 -- Code generated by ddlctl. DO NOT EDIT.
 --
 
--- source: tmp/sample.go:5
+-- source: docs/sample.go:5
 -- User is a user model struct.
 --
--- pgddl:table public.users
+-- pgddl:table      public.users
 -- pgddl:constraint UNIQUE ("username")
 CREATE TABLE public.users (
     "user_id"  TEXT NOT NULL,
@@ -157,11 +128,11 @@ CREATE TABLE public.users (
     UNIQUE ("username")
 );
 
--- source: tmp/sample.go:7
--- pgddl:index "index_users_username" ON public.users ("username")
+-- source: docs/sample.go:7
+-- pgddl:index      "index_users_username" ON public.users ("username")
 CREATE INDEX "index_users_username" ON public.users ("username");
 
--- source: tmp/sample.go:16
+-- source: docs/sample.go:16
 -- Group is a group model struct.
 --
 -- pgddl:table CREATE TABLE IF NOT EXISTS public.groups
@@ -172,7 +143,7 @@ CREATE TABLE IF NOT EXISTS public.groups (
     PRIMARY KEY ("group_id")
 );
 
--- source: tmp/sample.go:17
+-- source: docs/sample.go:17
 -- pgddl:index CREATE UNIQUE INDEX "index_groups_group_name" ON public.groups ("group_name")
 CREATE UNIQUE INDEX "index_groups_group_name" ON public.groups ("group_name");
 ```
@@ -182,7 +153,7 @@ CREATE UNIQUE INDEX "index_groups_group_name" ON public.groups ("group_name");
 ### 1. Prepare your DDL
 
 ```sh
-cat /tmp/sample.sql
+cat sample.sql
 ```
 
 content:  
@@ -191,10 +162,10 @@ content:
 -- Code generated by ddlctl. DO NOT EDIT.
 --
 
--- source: tmp/sample.go:5
+-- source: docs/sample.go:5
 -- User is a user model struct.
 --
--- pgddl:table public.users
+-- pgddl:table      public.users
 -- pgddl:constraint UNIQUE ("username")
 CREATE TABLE public.users (
     "user_id"  TEXT NOT NULL,
@@ -204,11 +175,11 @@ CREATE TABLE public.users (
     UNIQUE ("username")
 );
 
--- source: tmp/sample.go:7
--- pgddl:index "index_users_username" ON public.users ("username")
+-- source: docs/sample.go:7
+-- pgddl:index      "index_users_username" ON public.users ("username")
 CREATE INDEX "index_users_username" ON public.users ("username");
 
--- source: tmp/sample.go:16
+-- source: docs/sample.go:16
 -- Group is a group model struct.
 --
 -- pgddl:table CREATE TABLE IF NOT EXISTS public.groups
@@ -219,7 +190,7 @@ CREATE TABLE IF NOT EXISTS public.groups (
     PRIMARY KEY ("group_id")
 );
 
--- source: tmp/sample.go:17
+-- source: docs/sample.go:17
 -- pgddl:index CREATE UNIQUE INDEX "index_groups_group_name" ON public.groups ("group_name")
 CREATE UNIQUE INDEX "index_groups_group_name" ON public.groups ("group_name");
 ```
@@ -229,7 +200,7 @@ CREATE UNIQUE INDEX "index_groups_group_name" ON public.groups ("group_name");
 Please check the differences between the local DDL file and the destination database:
 
 ```console
-$ ddlctl diff --dialect postgres "postgres://postgres:password@localhost/testdb?sslmode=disable" /tmp/sample.sql
+$ ddlctl diff --dialect postgres "postgres://postgres:password@localhost/testdb?sslmode=disable" sample.sql
 CREATE TABLE public.users (
     "user_id" TEXT NOT NULL,
     "username" TEXT NOT NULL,
@@ -250,7 +221,7 @@ CREATE UNIQUE INDEX "index_groups_group_name" ON public.groups ("group_name");
 ### 3. Apply DDL
 
 ```console
-$ ddlctl apply --dialect postgres "postgres://postgres:password@localhost/testdb?sslmode=disable" /tmp/sample.sql --auto-approve
+$ ddlctl apply --dialect postgres "postgres://postgres:password@localhost/testdb?sslmode=disable" sample.sql --auto-approve
 
 ddlctl will exec the following DDL queries:
 
@@ -303,7 +274,7 @@ done
 apply:
 
 ```console
-$ ddlctl apply --dialect postgres "postgres://postgres:password@localhost/testdb?sslmode=disable" /tmp/sample.sql --auto-approve
+$ ddlctl apply --dialect postgres "postgres://postgres:password@localhost/testdb?sslmode=disable" sample.sql --auto-approve
 
 ddlctl will exec the following DDL queries:
 
@@ -331,14 +302,18 @@ done
 ### pre-built binary
 
 ```bash
-LATEST_VERSION=$(curl -ILSs https://github.com/kunitsucom/ddlctl/releases/latest | tr -d '\r' | awk -F'/tag/' '/location/ { print $2 }') && echo "${LATEST_VERSION}"
-OS=$(uname | tr '[:upper:]' '[:lower:]') && echo "${OS}"
-ARCH=$(uname -m) && echo "${ARCH}"
+LATEST_VERSION=$(curl -ISs https://github.com/kunitsucom/ddlctl/releases/latest | tr -d '\r' | awk -F/ '/location:/{print $NF}')
+OS=$(uname | tr '[:upper:]' '[:lower:]')
+ARCH=$(uname -m)
+URL="https://github.com/kunitsucom/ddlctl/releases/download/${LATEST_VERSION}/ddlctl_${LATEST_VERSION}_${OS}_${ARCH}.zip"
+
+# Check URL
+echo "${URL}"
 
-# download
-curl -fLROSs "https://github.com/kunitsucom/ddlctl/releases/download/${LATEST_VERSION}/ddlctl_${LATEST_VERSION}_${OS}_${ARCH}.zip"
+# Download
+curl -fLROSs "${URL}"
 
-# unzip
+# Unzip
 unzip -j ddlctl_${LATEST_VERSION}_darwin_arm64.zip '*/ddlctl'
 ```
 
@@ -381,7 +356,7 @@ options:
 ```console
 $ ddlctl generate --help
 Usage:
-    ddlctl generate [options] --dialect <DDL dialect> --src <source> --dst <destination>
+    ddlctl generate [options] --dialect <DDL dialect> <source> <destination>
 
 Description:
     generate DDL from source (file or directory) to destination (file or directory).
@@ -397,10 +372,6 @@ options:
         DDL annotation key for Go struct tag
     --go-pk-tag (env: DDLCTL_PK_TAG_GO, default: pk)
         primary key annotation key for Go struct tag
-    --src (env: DDLCTL_SOURCE, default: /dev/stdin)
-        source file or directory
-    --dst (env: DDLCTL_DESTINATION, default: /dev/stdout)
-        destination file or directory
     --help (default: false)
         show usage
 ```

diff --git a/docs/.gitignore b/docs/.gitignore
@@ -1,2 +1,3 @@
 *.cast
 *.gif
+sample.sql
diff --git a/docs/diff.sql b/docs/diff.sql
@@ -0,0 +1,35 @@
+-- Code generated by ddlctl. DO NOT EDIT.
+--
+
+-- source: docs/sample.go:5
+-- User is a user model struct.
+--
+-- pgddl:table      public.users
+-- pgddl:constraint UNIQUE ("username")
+CREATE TABLE public.users (
+    "user_id"     TEXT NOT NULL,
+    "username"    TEXT NOT NULL,
+    "age"         INT  NOT NULL,
+    "description" TEXT NOT NULL,
+    PRIMARY KEY ("user_id"),
+    UNIQUE ("username")
+);
+
+-- source: docs/sample.go:7
+-- pgddl:index      "index_users_username" ON public.users ("username")
+CREATE INDEX "index_users_username" ON public.users ("username");
+
+-- source: docs/sample.go:16
+-- Group is a group model struct.
+--
+-- pgddl:table CREATE TABLE IF NOT EXISTS public.groups
+CREATE TABLE IF NOT EXISTS public.groups (
+    "group_id"    TEXT NOT NULL,
+    "group_name"  TEXT NOT NULL,
+    "description" TEXT NOT NULL,
+    PRIMARY KEY ("group_id")
+);
+
+-- source: docs/sample.go:17
+-- pgddl:index CREATE UNIQUE INDEX "index_groups_group_name" ON public.groups ("group_name")
+CREATE UNIQUE INDEX "index_groups_group_name" ON public.groups ("group_name");
diff --git a/docs/ghostplay.sh b/docs/ghostplay.sh
@@ -22,7 +22,7 @@ ghostplay_custom_prompt
 
 
 # Prepare your annotated model source code
-bat /tmp/sample.go
+bat sample.go
 
 #ghostplay silent
 sleep 2
@@ -35,7 +35,7 @@ ghostplay_custom_prompt
 
 
 # Generate DDL
-ddlctl generate --dialect postgres --go-column-tag db --go-ddl-tag pgddl --go-pk-tag pk --src /tmp/sample.go --dst /tmp/sample.sql
+ddlctl generate --dialect postgres --go-column-tag db --go-ddl-tag pgddl --go-pk-tag pk sample.go sample.sql
 
 #ghostplay silent
 sleep 2
@@ -48,7 +48,7 @@ ghostplay_custom_prompt
 
 
 # Check generated DDL file
-bat /tmp/sample.sql
+bat sample.sql
 
 #ghostplay silent
 sleep 2
@@ -71,7 +71,7 @@ ghostplay_custom_prompt
 
 
 # Apply DDL
-ddlctl apply --dialect postgres "${DATABASE_DSN}" /tmp/sample.sql --auto-approve
+ddlctl apply --dialect postgres "${DATABASE_DSN}" sample.sql --auto-approve
 
 #ghostplay silent
 sleep 2
@@ -84,7 +84,7 @@ ghostplay_custom_prompt
 
 
 # Edit DDL and check diff
-diff -uw /tmp/sample.sql /tmp/diff.sql | bat --language diff
+diff -uw sample.sql diff.sql | bat --language diff
 
 #ghostplay silent
 sleep 2
@@ -97,7 +97,7 @@ ghostplay_custom_prompt
 
 
 # Diff current database schema and DDL file
-ddlctl diff --dialect postgres "${DATABASE_DSN}" /tmp/diff.sql | bat --language sql
+ddlctl diff --dialect postgres "${DATABASE_DSN}" diff.sql | bat --language sql
 
 #ghostplay silent
 sleep 2
@@ -110,7 +110,7 @@ ghostplay_custom_prompt
 
 
 # Apply DDL
-ddlctl apply --dialect postgres "${DATABASE_DSN}" /tmp/diff.sql --auto-approve
+ddlctl apply --dialect postgres "${DATABASE_DSN}" diff.sql --auto-approve
 
 #ghostplay silent
 sleep 4

diff --git a/docs/sample.go b/docs/sample.go
@@ -0,0 +1,22 @@
+package sample
+
+// User is a user model struct.
+//
+//pgddl:table      public.users
+//pgddl:constraint UNIQUE ("username")
+//pgddl:index      "index_users_username" ON public.users ("username")
+type User struct {
+	UserID   string `db:"user_id"  pgddl:"TEXT NOT NULL" pk:"true"`
+	Username string `db:"username" pgddl:"TEXT NOT NULL"`
+	Age      int    `db:"age"      pgddl:"INT  NOT NULL"`
+}
+
+// Group is a group model struct.
+//
+//pgddl:table CREATE TABLE IF NOT EXISTS public.groups
+//pgddl:index CREATE UNIQUE INDEX "index_groups_group_name" ON public.groups ("group_name")
+type Group struct {
+	GroupID     string `db:"group_id"    pgddl:"TEXT NOT NULL" pk:"true"`
+	GroupName   string `db:"group_name"  pgddl:"TEXT NOT NULL"`
+	Description string `db:"description" pgddl:"TEXT NOT NULL"`
+}