fix: Support Spanner ROW DELETION POLICY

hakadoriya · Jun 6, 2024 · e2ee48b · e2ee48b
1 parent 834c015
commit e2ee48b
Show file tree

Hide file tree

Showing 7 changed files with 225 additions and 9 deletions.
diff --git a/pkg/ddl/spanner/ddl_table.go b/pkg/ddl/spanner/ddl_table.go
@@ -299,7 +299,7 @@ func (o *Option) String() string {
 }
 
 func (o *Option) StringForDiff() string {
-	if o.Value == nil {
+	if o == nil || o.Value == nil {
 		return ""
 	}
 	return o.Name + " " + o.Value.StringForDiff()

diff --git a/pkg/ddl/spanner/ddl_table_alter.go b/pkg/ddl/spanner/ddl_table_alter.go
@@ -80,6 +80,12 @@ func (s *AlterTableStmt) String() string {
 		} else {
 			str += " INITIALLY IMMEDIATE"
 		}
+	case *AddRowDeletionPolicy:
+		str += "ADD " + a.RowDeletionPolicy.String()
+	case *ReplaceRowDeletionPolicy:
+		str += "REPLACE " + a.RowDeletionPolicy.String()
+	case *DropRowDeletionPolicy:
+		str += "DROP ROW DELETION POLICY"
 	}
 
 	return str + ";\n"
@@ -217,3 +223,28 @@ type AlterConstraint struct {
 func (*AlterConstraint) isAlterTableAction() {}
 
 func (s *AlterConstraint) GoString() string { return internal.GoString(*s) }
+
+// AddRowDeletionPolicy represents ALTER TABLE table_name ADD ROW DELETION POLICY.
+type AddRowDeletionPolicy struct {
+	RowDeletionPolicy *Option
+}
+
+func (*AddRowDeletionPolicy) isAlterTableAction() {}
+
+func (s *AddRowDeletionPolicy) GoString() string { return internal.GoString(*s) }
+
+// ReplaceRowDeletionPolicy represents ALTER TABLE table_name REPLACE ROW DELETION POLICY.
+type ReplaceRowDeletionPolicy struct {
+	RowDeletionPolicy *Option
+}
+
+func (*ReplaceRowDeletionPolicy) isAlterTableAction() {}
+
+func (s *ReplaceRowDeletionPolicy) GoString() string { return internal.GoString(*s) }
+
+// DropRowDeletionPolicy represents ALTER TABLE table_name DROP ROW DELETION POLICY.
+type DropRowDeletionPolicy struct{}
+
+func (*DropRowDeletionPolicy) isAlterTableAction() {}
+
+func (s *DropRowDeletionPolicy) GoString() string { return internal.GoString(*s) }
diff --git a/pkg/ddl/spanner/ddl_table_alter_test.go b/pkg/ddl/spanner/ddl_table_alter_test.go
@@ -24,6 +24,9 @@ func Test_isAlterTableAction(t *testing.T) {
 	(&AddConstraint{}).isAlterTableAction()
 	(&DropConstraint{}).isAlterTableAction()
 	(&AlterConstraint{}).isAlterTableAction()
+	(&AddRowDeletionPolicy{}).isAlterTableAction()
+	(&ReplaceRowDeletionPolicy{}).isAlterTableAction()
+	(&DropRowDeletionPolicy{}).isAlterTableAction()
 }
 
 func TestAlterTableStmt_String(t *testing.T) {
@@ -266,6 +269,79 @@ func TestAlterTableStmt_String(t *testing.T) {
 		}
 		t.Logf("✅: %s: stmt: %#v", t.Name(), stmt)
 	})
+
+	t.Run("success,AddRowDeletionPolicy", func(t *testing.T) {
+		t.Parallel()
+
+		stmt := &AlterTableStmt{
+			Name: &ObjectName{Name: &Ident{Name: "groups", QuotationMark: `"`, Raw: `"groups"`}},
+			Action: &AddRowDeletionPolicy{RowDeletionPolicy: &Option{Name: "ROW DELETION POLICY", Value: &Expr{Idents: []*Ident{
+				NewRawIdent("("),
+				NewRawIdent("OLDER_THAN"),
+				NewRawIdent("("),
+				NewRawIdent("CreatedAt"),
+				NewRawIdent(","),
+				NewRawIdent("INTERVAL"),
+				NewRawIdent("30"),
+				NewRawIdent("DAY"),
+				NewRawIdent(")"),
+				NewRawIdent(")"),
+			}}}},
+		}
+
+		expected := `ALTER TABLE "groups" ADD ROW DELETION POLICY (OLDER_THAN(CreatedAt, INTERVAL 30 DAY));` + "\n"
+		actual := stmt.String()
+
+		if !assert.Equal(t, expected, actual) {
+			assert.Equal(t, fmt.Sprintf("%#v", expected), fmt.Sprintf("%#v", actual))
+		}
+		t.Logf("✅: %s: stmt: %#v", t.Name(), stmt)
+	})
+
+	t.Run("success,ReplaceRowDeletionPolicy", func(t *testing.T) {
+		t.Parallel()
+
+		stmt := &AlterTableStmt{
+			Name: &ObjectName{Name: &Ident{Name: "groups", QuotationMark: `"`, Raw: `"groups"`}},
+			Action: &ReplaceRowDeletionPolicy{RowDeletionPolicy: &Option{Name: "ROW DELETION POLICY", Value: &Expr{Idents: []*Ident{
+				NewRawIdent("("),
+				NewRawIdent("OLDER_THAN"),
+				NewRawIdent("("),
+				NewRawIdent("CreatedAt"),
+				NewRawIdent(","),
+				NewRawIdent("INTERVAL"),
+				NewRawIdent("30"),
+				NewRawIdent("DAY"),
+				NewRawIdent(")"),
+				NewRawIdent(")"),
+			}}}},
+		}
+
+		expected := `ALTER TABLE "groups" REPLACE ROW DELETION POLICY (OLDER_THAN(CreatedAt, INTERVAL 30 DAY));` + "\n"
+		actual := stmt.String()
+
+		if !assert.Equal(t, expected, actual) {
+			assert.Equal(t, fmt.Sprintf("%#v", expected), fmt.Sprintf("%#v", actual))
+		}
+		t.Logf("✅: %s: stmt: %#v", t.Name(), stmt)
+	})
+
+	t.Run("success,DropRowDeletionPolicy", func(t *testing.T) {
+		t.Parallel()
+
+		stmt := &AlterTableStmt{
+			Name:   &ObjectName{Name: &Ident{Name: "groups", QuotationMark: `"`, Raw: `"groups"`}},
+			Action: &DropRowDeletionPolicy{},
+		}
+
+		expected := `ALTER TABLE "groups" DROP ROW DELETION POLICY;` + "\n"
+		actual := stmt.String()
+
+		if !assert.Equal(t, expected, actual) {
+			assert.Equal(t, fmt.Sprintf("%#v", expected), fmt.Sprintf("%#v", actual))
+		}
+		t.Logf("✅: %s: stmt: %#v", t.Name(), stmt)
+	})
 }
 
 func TestAlterTableStmt_GetNameForDiff(t *testing.T) {

diff --git a/pkg/ddl/spanner/ddl_table_create.go b/pkg/ddl/spanner/ddl_table_create.go
@@ -11,13 +11,14 @@ import (
 var _ Stmt = (*CreateTableStmt)(nil)
 
 type CreateTableStmt struct {
-	Comment     string
-	Indent      string
-	IfNotExists bool
-	Name        *ObjectName
-	Columns     []*Column
-	Constraints Constraints
-	Options     Options
+	Comment           string
+	Indent            string
+	IfNotExists       bool
+	Name              *ObjectName
+	Columns           []*Column
+	Constraints       Constraints
+	Options           Options
+	RowDeletionPolicy *Option
 }
 
 func (s *CreateTableStmt) GetNameForDiff() string {
@@ -74,6 +75,9 @@ func (s *CreateTableStmt) String() string {
 			}
 		}
 	}
+	if s.RowDeletionPolicy != nil {
+		str += ",\n" + s.RowDeletionPolicy.String()
+	}
 
 	str += ";\n"
 	return str

diff --git a/pkg/ddl/spanner/diff_create_table.go b/pkg/ddl/spanner/diff_create_table.go
@@ -138,6 +138,36 @@ func DiffCreateTable(before, after *CreateTableStmt, opts ...DiffCreateTableOpti
 		})
 	}
 
+	if before.RowDeletionPolicy.StringForDiff() != after.RowDeletionPolicy.StringForDiff() {
+		switch {
+		case before.RowDeletionPolicy == nil:
+			// ALTER TABLE table_name ADD ROW DELETION POLICY
+			result.Stmts = append(result.Stmts, &AlterTableStmt{
+				Comment: simplediff.Diff("", after.RowDeletionPolicy.String()).String(),
+				Name:    after.Name,
+				Action: &AddRowDeletionPolicy{
+					RowDeletionPolicy: after.RowDeletionPolicy,
+				},
+			})
+		case after.RowDeletionPolicy == nil:
+			// ALTER TABLE table_name DROP ROW DELETION POLICY
+			result.Stmts = append(result.Stmts, &AlterTableStmt{
+				Comment: simplediff.Diff(before.RowDeletionPolicy.String(), "").String(),
+				Name:    after.Name,
+				Action:  &DropRowDeletionPolicy{},
+			})
+		default:
+			// ALTER TABLE table_name REPLACE ROW DELETION POLICY
+			result.Stmts = append(result.Stmts, &AlterTableStmt{
+				Comment: simplediff.Diff(before.RowDeletionPolicy.String(), after.RowDeletionPolicy.String()).String(),
+				Name:    after.Name,
+				Action: &ReplaceRowDeletionPolicy{
+					RowDeletionPolicy: after.RowDeletionPolicy,
+				},
+			})
+		}
+	}
+
 	if len(result.Stmts) == 0 {
 		return nil, apperr.Errorf("before: %s, after: %s: %w", before.GetNameForDiff(), after.GetNameForDiff(), ddl.ErrNoDifference)
 	}

diff --git a/pkg/ddl/spanner/diff_create_table_test.go b/pkg/ddl/spanner/diff_create_table_test.go
@@ -338,6 +338,81 @@ CREATE TABLE "users" (
 		assert.Equal(t, expected, actual.String())
 	})
 
+	t.Run("success,ALTER_ADD_ROW_DELETION_POLICY", func(t *testing.T) {
+		t.Parallel()
+
+		before := `CREATE TABLE "users" (id STRING(36) NOT NULL, group_id STRING(36) NOT NULL REFERENCES "groups" ("id"), "name" STRING(255) NOT NULL, "age" INT64 DEFAULT 0 NOT NULL CHECK ("age" >= 0), description STRING, CreatedAt TIMESTAMP) PRIMARY KEY ("id");`
+		beforeDDL, err := NewParser(NewLexer(before)).Parse()
+		require.NoError(t, err)
+
+		after := `CREATE TABLE "users" (id STRING(36) NOT NULL, group_id STRING(36) NOT NULL REFERENCES "groups" ("id"), "name" STRING(255) NOT NULL, "age" INT64 DEFAULT 0 NOT NULL CHECK ("age" >= 0), description STRING, CreatedAt TIMESTAMP) PRIMARY KEY ("id"), ROW DELETION POLICY (OLDER_THAN(CreatedAt, INTERVAL 7 DAY));`
+		afterDDL, err := NewParser(NewLexer(after)).Parse()
+		require.NoError(t, err)
+
+		actual, err := DiffCreateTable(
+			beforeDDL.Stmts[0].(*CreateTableStmt),
+			afterDDL.Stmts[0].(*CreateTableStmt),
+			DiffCreateTableUseAlterTableAddConstraintNotValid(false),
+		)
+		assert.NoError(t, err)
+		expected := `-- -
+-- +ROW DELETION POLICY (OLDER_THAN(CreatedAt, INTERVAL 7 DAY))
+ALTER TABLE "users" ADD ROW DELETION POLICY (OLDER_THAN(CreatedAt, INTERVAL 7 DAY));
+`
+
+		assert.Equal(t, expected, actual.String())
+	})
+
+	t.Run("success,ALTER_REPLACE_ROW_DELETION_POLICY", func(t *testing.T) {
+		t.Parallel()
+
+		before := `CREATE TABLE "users" (id STRING(36) NOT NULL, group_id STRING(36) NOT NULL REFERENCES "groups" ("id"), "name" STRING(255) NOT NULL, "age" INT64 DEFAULT 0 NOT NULL CHECK ("age" >= 0), description STRING, CreatedAt TIMESTAMP) PRIMARY KEY ("id"), ROW DELETION POLICY (OLDER_THAN(CreatedAt, INTERVAL 30 DAY));`
+		beforeDDL, err := NewParser(NewLexer(before)).Parse()
+		require.NoError(t, err)
+
+		after := `CREATE TABLE "users" (id STRING(36) NOT NULL, group_id STRING(36) NOT NULL REFERENCES "groups" ("id"), "name" STRING(255) NOT NULL, "age" INT64 DEFAULT 0 NOT NULL CHECK ("age" >= 0), description STRING, CreatedAt TIMESTAMP) PRIMARY KEY ("id"), ROW DELETION POLICY (OLDER_THAN(CreatedAt, INTERVAL 7 DAY));`
+		afterDDL, err := NewParser(NewLexer(after)).Parse()
+		require.NoError(t, err)
+
+		actual, err := DiffCreateTable(
+			beforeDDL.Stmts[0].(*CreateTableStmt),
+			afterDDL.Stmts[0].(*CreateTableStmt),
+			DiffCreateTableUseAlterTableAddConstraintNotValid(false),
+		)
+		assert.NoError(t, err)
+		expected := `-- -ROW DELETION POLICY (OLDER_THAN(CreatedAt, INTERVAL 30 DAY))
+-- +ROW DELETION POLICY (OLDER_THAN(CreatedAt, INTERVAL 7 DAY))
+ALTER TABLE "users" REPLACE ROW DELETION POLICY (OLDER_THAN(CreatedAt, INTERVAL 7 DAY));
+`
+
+		assert.Equal(t, expected, actual.String())
+	})
+
+	t.Run("success,ALTER_REPLACE_DROP_DELETION_POLICY", func(t *testing.T) {
+		t.Parallel()
+
+		before := `CREATE TABLE "users" (id STRING(36) NOT NULL, group_id STRING(36) NOT NULL REFERENCES "groups" ("id"), "name" STRING(255) NOT NULL, "age" INT64 DEFAULT 0 NOT NULL CHECK ("age" >= 0), description STRING, CreatedAt TIMESTAMP) PRIMARY KEY ("id"), ROW DELETION POLICY (OLDER_THAN(CreatedAt, INTERVAL 30 DAY));`
+		beforeDDL, err := NewParser(NewLexer(before)).Parse()
+		require.NoError(t, err)
+
+		after := `CREATE TABLE "users" (id STRING(36) NOT NULL, group_id STRING(36) NOT NULL REFERENCES "groups" ("id"), "name" STRING(255) NOT NULL, "age" INT64 DEFAULT 0 NOT NULL CHECK ("age" >= 0), description STRING, CreatedAt TIMESTAMP) PRIMARY KEY ("id");`
+		afterDDL, err := NewParser(NewLexer(after)).Parse()
+		require.NoError(t, err)
+
+		actual, err := DiffCreateTable(
+			beforeDDL.Stmts[0].(*CreateTableStmt),
+			afterDDL.Stmts[0].(*CreateTableStmt),
+			DiffCreateTableUseAlterTableAddConstraintNotValid(false),
+		)
+		assert.NoError(t, err)
+		expected := `-- -ROW DELETION POLICY (OLDER_THAN(CreatedAt, INTERVAL 30 DAY))
+-- +
+ALTER TABLE "users" DROP ROW DELETION POLICY;
+`
+
+		assert.Equal(t, expected, actual.String())
+	})
+
 	t.Run("success,DROP_ADD_FOREIGN_KEY", func(t *testing.T) {
 		t.Parallel()
 

diff --git a/pkg/ddl/spanner/parser.go b/pkg/ddl/spanner/parser.go
@@ -313,7 +313,7 @@ LabelTableOptions:
 			//
 			opt.Value = opt.Value.Append(rowDeletionPolicyContent...)
 
-			createTableStmt.Options = append(createTableStmt.Options, opt)
+			createTableStmt.RowDeletionPolicy = opt
 		case TOKEN_COMMA:
 			// do nothing
 		case TOKEN_SEMICOLON, TOKEN_EOF: