feat: add ShowCreateAllTables() functions (#157)

Author: ginokent

.golangci.yml

@@ -10,6 +10,7 @@ linters:
   disable:
     - deadcode # deprecated (since v1.49.0) due to: The owner seems to have abandoned the linter. Replaced by unused.
     - depguard # unnecessary
+    - dupl # too many unnecessary detections
     - exhaustruct # https://github.com/GaijinEntertainment/go-exhaustruct
     - exhaustivestruct # https://github.com/mbilski/exhaustivestruct
     - gci # unnecessary

exp/database/sql/ddl/cockroachdb/ddl_index_create.go

@@ -17,6 +17,7 @@ type CreateIndexStmt struct {
 	IfNotExists bool
 	Name        *ObjectName
 	TableName   *ObjectName
+	Using       []*Ident
 	Columns     []*ColumnIdent
 }
 
@@ -27,8 +28,11 @@ func (s *CreateIndexStmt) GetNameForDiff() string {
 func (s *CreateIndexStmt) String() string {
 	var str string
 	if s.Comment != "" {
-		for _, v := range strings.Split(s.Comment, "\n") {
-			str += CommentPrefix + v + "\n"
+		comments := strings.Split(s.Comment, "\n")
+		for i := range comments {
+			if comments[i] != "" {
+				str += CommentPrefix + comments[i] + "\n"
+			}
 		}
 	}
 	str += "CREATE "
@@ -39,7 +43,12 @@ func (s *CreateIndexStmt) String() string {
 	if s.IfNotExists {
 		str += "IF NOT EXISTS "
 	}
-	str += s.Name.String() + " ON " + s.TableName.String() + " (" + stringz.JoinStringers(", ", s.Columns...) + ");\n"
+	str += s.Name.String() + " ON " + s.TableName.String()
+	if len(s.Using) > 0 {
+		str += " USING "
+		str += stringz.JoinStringers(" ", s.Using...)
+	}
+	str += " (" + stringz.JoinStringers(", ", s.Columns...) + ");\n"
 	return str
 }
 
@@ -49,10 +58,9 @@ func (s *CreateIndexStmt) StringForDiff() string {
 		str += "UNIQUE "
 	}
 	str += "INDEX "
-	if s.IfNotExists {
-		str += "IF NOT EXISTS "
-	}
-	str += s.Name.StringForDiff() + " ON " + s.TableName.StringForDiff() + " ("
+	str += s.Name.StringForDiff() + " ON " + s.TableName.StringForDiff()
+	// TODO: add USING
+	str += " ("
 	for i, c := range s.Columns {
 		if i > 0 {
 			str += ", "

exp/database/sql/ddl/cockroachdb/ddl_index_create_test.go

@@ -31,6 +31,7 @@ func TestCreateIndexStmt_String(t *testing.T) {
 			IfNotExists: true,
 			Name:        &ObjectName{Name: &Ident{Name: "test", QuotationMark: `"`, Raw: `"test"`}},
 			TableName:   &ObjectName{Name: &Ident{Name: "users", QuotationMark: `"`, Raw: `"users"`}},
+			Using:       []*Ident{{Name: "btree", QuotationMark: ``, Raw: `btree`}},
 			Columns: []*ColumnIdent{
 				{
 					Ident: &Ident{Name: "id", QuotationMark: `"`, Raw: `"id"`},
@@ -39,7 +40,7 @@ func TestCreateIndexStmt_String(t *testing.T) {
 			},
 		}
 		expected := `-- test comment content
-CREATE INDEX IF NOT EXISTS "test" ON "users" ("id" ASC);
+CREATE INDEX IF NOT EXISTS "test" ON "users" USING btree ("id" ASC);
 `
 		actual := stmt.String()
 

exp/database/sql/ddl/cockroachdb/ddl_index_drop.go

@@ -23,8 +23,11 @@ func (s *DropIndexStmt) GetNameForDiff() string {
 func (s *DropIndexStmt) String() string {
 	var str string
 	if s.Comment != "" {
-		for _, v := range strings.Split(s.Comment, "\n") {
-			str += CommentPrefix + v + "\n"
+		comments := strings.Split(s.Comment, "\n")
+		for i := range comments {
+			if comments[i] != "" {
+				str += CommentPrefix + comments[i] + "\n"
+			}
 		}
 	}
 	str += "DROP INDEX "

exp/database/sql/ddl/cockroachdb/ddl_table_alter.go

@@ -27,8 +27,11 @@ func (s *AlterTableStmt) GetNameForDiff() string {
 func (s *AlterTableStmt) String() string {
 	var str string
 	if s.Comment != "" {
-		for _, v := range strings.Split(s.Comment, "\n") {
-			str += CommentPrefix + v + "\n"
+		comments := strings.Split(s.Comment, "\n")
+		for i := range comments {
+			if comments[i] != "" {
+				str += CommentPrefix + comments[i] + "\n"
+			}
 		}
 	}
 	str += "ALTER TABLE "

exp/database/sql/ddl/cockroachdb/ddl_table_create.go

@@ -28,8 +28,11 @@ func (s *CreateTableStmt) GetNameForDiff() string {
 func (s *CreateTableStmt) String() string {
 	var str string
 	if s.Comment != "" {
-		for _, v := range strings.Split(s.Comment, "\n") {
-			str += CommentPrefix + v + "\n"
+		comments := strings.Split(s.Comment, "\n")
+		for i := range comments {
+			if comments[i] != "" {
+				str += CommentPrefix + comments[i] + "\n"
+			}
 		}
 	}
 	str += "CREATE TABLE "

exp/database/sql/ddl/cockroachdb/ddl_table_drop.go

@@ -23,8 +23,11 @@ func (s *DropTableStmt) GetNameForDiff() string {
 func (s *DropTableStmt) String() string {
 	var str string
 	if s.Comment != "" {
-		for _, v := range strings.Split(s.Comment, "\n") {
-			str += CommentPrefix + v + "\n"
+		comments := strings.Split(s.Comment, "\n")
+		for i := range comments {
+			if comments[i] != "" {
+				str += CommentPrefix + comments[i] + "\n"
+			}
 		}
 	}
 	str += "DROP TABLE "

exp/database/sql/ddl/cockroachdb/diff.go

@@ -5,6 +5,7 @@ import (
 
 	errorz "github.com/kunitsucom/util.go/errors"
 	"github.com/kunitsucom/util.go/exp/database/sql/ddl"
+	"github.com/kunitsucom/util.go/exp/diff/simplediff"
 )
 
 //nolint:funlen,cyclop,gocognit
@@ -83,7 +84,8 @@ func Diff(before, after *DDL) (*DDL, error) {
 				if beforeStmt.StringForDiff() != afterStmt.StringForDiff() {
 					result.Stmts = append(result.Stmts,
 						&DropIndexStmt{
-							Name: beforeStmt.Name,
+							Comment: simplediff.Diff(beforeStmt.StringForDiff(), afterStmt.StringForDiff()).String(),
+							Name:    beforeStmt.Name,
 						},
 						afterStmt,
 					)

exp/database/sql/ddl/cockroachdb/diff_create_table_test.go

@@ -55,11 +55,9 @@ func TestDiffCreateTable(t *testing.T) {
 
 		expectedStr := `-- -
 -- +"age" INTEGER NOT NULL DEFAULT 0
--- 
 ALTER TABLE "users" ADD COLUMN "age" INTEGER NOT NULL DEFAULT 0;
 -- -
 -- +CONSTRAINT users_age_check CHECK (age >= 0)
--- 
 ALTER TABLE "users" ADD CONSTRAINT users_age_check CHECK ("age" >= 0);
 `
 
@@ -89,15 +87,12 @@ ALTER TABLE "users" ADD CONSTRAINT users_age_check CHECK ("age" >= 0);
 
 		expectedStr := `-- -UNIQUE INDEX users_unique_name (name ASC)
 -- +
--- 
 DROP INDEX users_unique_name;
 -- -CONSTRAINT users_age_check CHECK (age >= 0)
 -- +
--- 
 ALTER TABLE "users" DROP CONSTRAINT users_age_check;
 -- -"age" INTEGER NOT NULL DEFAULT 0
 -- +
--- 
 ALTER TABLE "users" DROP COLUMN "age";
 `
 
@@ -127,15 +122,12 @@ ALTER TABLE "users" DROP COLUMN "age";
 
 		expectedStr := `-- -"name" VARCHAR(255) NOT NULL
 -- +"name" TEXT NOT NULL
--- 
 ALTER TABLE "users" ALTER COLUMN "name" SET DATA TYPE TEXT;
 -- -"age" INT DEFAULT 0
 -- +"age" BIGINT DEFAULT 0
--- 
 ALTER TABLE "users" ALTER COLUMN "age" SET DATA TYPE BIGINT;
 -- -
 -- +UNIQUE INDEX users_unique_name (name ASC)
--- 
 CREATE UNIQUE INDEX users_unique_name ON "users" ("name");
 `
 
@@ -156,7 +148,6 @@ CREATE UNIQUE INDEX users_unique_name ON "users" ("name");
 
 		expectedStr := `-- -"age" INT DEFAULT 0
 -- +"age" INT
--- 
 ALTER TABLE "users" ALTER COLUMN "age" DROP DEFAULT;
 `
 
@@ -182,15 +173,12 @@ ALTER TABLE "users" ALTER COLUMN "age" DROP DEFAULT;
 
 		expectedStr := `-- -"age" INT
 -- +"age" INT DEFAULT 0
--- 
 ALTER TABLE "users" ALTER COLUMN "age" SET DEFAULT 0;
 -- -CONSTRAINT users_age_check CHECK (age >= 0)
 -- +
--- 
 ALTER TABLE "users" DROP CONSTRAINT users_age_check;
 -- -
 -- +CONSTRAINT users_age_check CHECK (age <> 0)
--- 
 ALTER TABLE "users" ADD CONSTRAINT users_age_check CHECK ("age" <> 0);
 `
 
@@ -218,39 +206,30 @@ ALTER TABLE "users" ADD CONSTRAINT users_age_check CHECK ("age" <> 0);
 
 		expectedStr := `-- -public.users
 -- +public.app_users
--- 
 ALTER TABLE "public.users" RENAME TO "public.app_users";
 -- -CONSTRAINT users_pkey PRIMARY KEY (id ASC)
 -- +
--- 
 ALTER TABLE "public.app_users" DROP CONSTRAINT users_pkey;
 -- -CONSTRAINT users_group_id_fkey FOREIGN KEY (group_id ASC) REFERENCES groups (id ASC)
 -- +
--- 
 ALTER TABLE "public.app_users" DROP CONSTRAINT users_group_id_fkey;
 -- -UNIQUE INDEX users_unique_name (name ASC)
 -- +
--- 
 DROP INDEX public.users_unique_name;
 -- -CONSTRAINT users_age_check CHECK (age >= 0)
 -- +
--- 
 ALTER TABLE "public.app_users" DROP CONSTRAINT users_age_check;
 -- -
 -- +CONSTRAINT app_users_pkey PRIMARY KEY (id ASC)
--- 
 ALTER TABLE "public.app_users" ADD CONSTRAINT app_users_pkey PRIMARY KEY ("id");
 -- -
 -- +CONSTRAINT app_users_group_id_fkey FOREIGN KEY (group_id ASC) REFERENCES groups (id ASC)
--- 
 ALTER TABLE "public.app_users" ADD CONSTRAINT app_users_group_id_fkey FOREIGN KEY (group_id) REFERENCES "groups" ("id");
 -- -
 -- +UNIQUE INDEX app_users_unique_name (name ASC)
--- 
 CREATE UNIQUE INDEX public.app_users_unique_name ON "public.app_users" ("name");
 -- -
 -- +CONSTRAINT app_users_age_check CHECK (age >= 0)
--- 
 ALTER TABLE "public.app_users" ADD CONSTRAINT app_users_age_check CHECK ("age" >= 0);
 `
 
@@ -279,7 +258,6 @@ ALTER TABLE "public.app_users" ADD CONSTRAINT app_users_age_check CHECK ("age" >
 
 		expectedStr := `-- -"age" INT DEFAULT 0
 -- +"age" INTEGER NOT NULL DEFAULT 0
--- 
 ALTER TABLE "users" ALTER COLUMN "age" SET NOT NULL;
 `
 
@@ -307,7 +285,6 @@ ALTER TABLE "users" ALTER COLUMN "age" SET NOT NULL;
 
 		expectedStr := `-- -"age" INT NOT NULL DEFAULT 0
 -- +"age" INT DEFAULT 0
--- 
 ALTER TABLE "users" ALTER COLUMN "age" DROP NOT NULL;
 `
 
@@ -335,11 +312,9 @@ ALTER TABLE "users" ALTER COLUMN "age" DROP NOT NULL;
 
 		expectedStr := `-- -CONSTRAINT users_pkey PRIMARY KEY (id ASC)
 -- +
--- 
 ALTER TABLE "users" DROP CONSTRAINT users_pkey;
 -- -
 -- +CONSTRAINT users_pkey PRIMARY KEY (id ASC, name ASC)
--- 
 ALTER TABLE "users" ADD CONSTRAINT users_pkey PRIMARY KEY ("id", name);
 `
 
@@ -367,11 +342,9 @@ ALTER TABLE "users" ADD CONSTRAINT users_pkey PRIMARY KEY ("id", name);
 
 		expectedStr := `-- -CONSTRAINT users_group_id_fkey FOREIGN KEY (group_id ASC) REFERENCES groups (id ASC)
 -- +
--- 
 ALTER TABLE "users" DROP CONSTRAINT users_group_id_fkey;
 -- -
 -- +CONSTRAINT users_group_id_fkey FOREIGN KEY (group_id ASC, name ASC) REFERENCES groups (id ASC, name ASC)
--- 
 ALTER TABLE "users" ADD CONSTRAINT users_group_id_fkey FOREIGN KEY (group_id, name) REFERENCES "groups" ("id", name);
 `
 
@@ -425,7 +398,6 @@ CREATE UNIQUE INDEX users_unique_name ON "users" ("id" ASC, name ASC);
 
 		expectedStr := `-- -"age" INT NOT NULL DEFAULT 0
 -- +"age" INT NOT NULL DEFAULT ((0 + 3) - 1 * 4 / 2)
--- 
 ALTER TABLE "users" ALTER COLUMN "age" SET DEFAULT ((0 + 3) - 1 * 4 / 2);
 `
 
@@ -473,7 +445,6 @@ ALTER TABLE "users" ALTER COLUMN "age" SET DEFAULT ((0 + 3) - 1 * 4 / 2);
 
 		expectedStr := `-- -unique_code TEXT
 -- +unique_code TEXT DEFAULT 'CODE-' || TO_CHAR(NOW(), 'YYYYMMDDHH24MISS') || '-' || LPAD(TO_CHAR(NEXTVAL('seq_complex_default')), 5, '0')
--- 
 ALTER TABLE complex_defaults ALTER COLUMN unique_code SET DEFAULT 'CODE-' || TO_CHAR(NOW(), 'YYYYMMDDHH24MISS') || '-' || LPAD(TO_CHAR(NEXTVAL('seq_complex_default')), 5, '0');
 `
 
@@ -499,7 +470,6 @@ ALTER TABLE complex_defaults ALTER COLUMN unique_code SET DEFAULT 'CODE-' || TO_
 
 		expected := `-- -
 -- +CONSTRAINT users_age_check CHECK (age >= 0)
--- 
 ALTER TABLE "users" ADD CONSTRAINT users_age_check CHECK ("age" >= 0) NOT VALID;
 `
 		actual, err := DiffCreateTable(

exp/database/sql/ddl/cockroachdb/diff_test.go

@@ -303,7 +303,6 @@ func TestDiff(t *testing.T) {
 
 		expected := `-- -
 -- +updated_at TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT timezone('UTC':::STRING, current_timestamp():::TIMESTAMPTZ)
--- 
 ALTER TABLE public.users ADD COLUMN updated_at TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT timezone('UTC':::STRING, current_timestamp():::TIMESTAMPTZ);
 `
 		actual, err := Diff(before, after)
@@ -362,7 +361,10 @@ CREATE INDEX public.users_idx_by_username ON public.users (username ASC);
 		after, err := NewParser(NewLexer(`CREATE UNIQUE INDEX IF NOT EXISTS public.users_idx_by_username ON public.users (username ASC, age ASC);`)).Parse()
 		require.NoError(t, err)
 
-		expected := `DROP INDEX public.users_idx_by_username;
+		expected := `-- -CREATE UNIQUE INDEX public.users_idx_by_username ON public.users (username DESC);
+-- +CREATE UNIQUE INDEX public.users_idx_by_username ON public.users (username ASC, age ASC);
+--  
+DROP INDEX public.users_idx_by_username;
 CREATE UNIQUE INDEX IF NOT EXISTS public.users_idx_by_username ON public.users (username ASC, age ASC);
 `
 		actual, err := Diff(before, after)
@@ -385,7 +387,6 @@ CREATE UNIQUE INDEX IF NOT EXISTS public.users_idx_by_username ON public.users (
 
 		expected := `-- -username VARCHAR(10) NOT NULL
 -- +username VARCHAR(11) NOT NULL
--- 
 ALTER TABLE public.users ALTER COLUMN username SET DATA TYPE VARCHAR(11);
 `
 		actual, err := Diff(before, after)