Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(spanner/spansql): add exclude to change stream options #9729

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
56 changes: 56 additions & 0 deletions spanner/spansql/parser.go
Original file line number Diff line number Diff line change
Expand Up @@ -2498,6 +2498,10 @@ func (p *parser) parseCreateChangeStream() (*CreateChangeStream, *parseError) {
OPTIONS (
retention_period = timespan,
value_capture_type = type
exclude_ttl_deletes = { false | true }
exclude_insert = { false | true }
exclude_update = { false | true }
exclude_delete = { false | true }
)
]
*/
Expand Down Expand Up @@ -2638,6 +2642,10 @@ func (p *parser) parseChangeStreamOptions() (ChangeStreamOptions, *parseError) {
OPTIONS (
retention_period = timespan,
value_capture_type = type
exclude_ttl_deletes = { false | true }
exclude_insert = { false | true }
exclude_update = { false | true }
exclude_delete = { false | true }
) */

if err := p.expect("OPTIONS"); err != nil {
Expand Down Expand Up @@ -2675,6 +2683,54 @@ func (p *parser) parseChangeStreamOptions() (ChangeStreamOptions, *parseError) {
}
*valueCaptureType = tok.string
cso.ValueCaptureType = valueCaptureType
} else if p.eat("exclude_ttl_deletes", "=") {
tok := p.next()
if tok.err != nil {
return ChangeStreamOptions{}, tok.err
}
if tok.caseEqual("TRUE") {
cso.ExcludeTTLDeletes = True
} else if tok.caseEqual("FALSE") {
cso.ExcludeTTLDeletes = False
} else {
return ChangeStreamOptions{}, p.errorf("invalid exclude_ttl_deletes: %v", tok.value)
}
} else if p.eat("exclude_insert", "=") {
tok := p.next()
if tok.err != nil {
return ChangeStreamOptions{}, tok.err
}
if tok.caseEqual("TRUE") {
cso.ExcludeInsert = True
} else if tok.caseEqual("FALSE") {
cso.ExcludeInsert = False
} else {
return ChangeStreamOptions{}, p.errorf("invalid exclude_insert: %v", tok.value)
}
} else if p.eat("exclude_update", "=") {
tok := p.next()
if tok.err != nil {
return ChangeStreamOptions{}, tok.err
}
if tok.caseEqual("TRUE") {
cso.ExcludeUpdate = True
} else if tok.caseEqual("FALSE") {
cso.ExcludeUpdate = False
} else {
return ChangeStreamOptions{}, p.errorf("invalid exclude_update: %v", tok.value)
}
} else if p.eat("exclude_delete", "=") {
tok := p.next()
if tok.err != nil {
return ChangeStreamOptions{}, tok.err
}
if tok.caseEqual("TRUE") {
cso.ExcludeDelete = True
} else if tok.caseEqual("FALSE") {
cso.ExcludeDelete = False
} else {
return ChangeStreamOptions{}, p.errorf("invalid exclude_delete: %v", tok.value)
}
} else {
tok := p.next()
return ChangeStreamOptions{}, p.errorf("unknown change stream option: %v", tok.value)
Expand Down
20 changes: 14 additions & 6 deletions spanner/spansql/parser_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -1581,7 +1581,7 @@ func TestParseDDL(t *testing.T) {
`CREATE CHANGE STREAM csname;
CREATE CHANGE STREAM csname FOR ALL;
CREATE CHANGE STREAM csname FOR tname, tname2(cname);
CREATE CHANGE STREAM csname FOR ALL OPTIONS (retention_period = '36h', value_capture_type = 'NEW_VALUES');`,
CREATE CHANGE STREAM csname FOR ALL OPTIONS (retention_period = '36h', value_capture_type = 'NEW_VALUES', exclude_ttl_deletes=TRUE, exclude_insert=TRUE, exclude_update=TRUE, exclude_delete=TRUE);`,
&DDL{
Filename: "filename",
List: []DDLStmt{
Expand All @@ -1607,8 +1607,12 @@ func TestParseDDL(t *testing.T) {
WatchAllTables: true,
Position: line(4),
Options: ChangeStreamOptions{
RetentionPeriod: func(b string) *string { return &b }("36h"),
ValueCaptureType: func(b string) *string { return &b }("NEW_VALUES"),
RetentionPeriod: func(b string) *string { return &b }("36h"),
ValueCaptureType: func(b string) *string { return &b }("NEW_VALUES"),
ExcludeTTLDeletes: True,
ExcludeInsert: True,
ExcludeUpdate: True,
ExcludeDelete: True,
},
},
},
Expand All @@ -1618,7 +1622,7 @@ func TestParseDDL(t *testing.T) {
`ALTER CHANGE STREAM csname SET FOR ALL;
ALTER CHANGE STREAM csname SET FOR tname, tname2(cname);
ALTER CHANGE STREAM csname DROP FOR ALL;
ALTER CHANGE STREAM csname SET OPTIONS (retention_period = '36h', value_capture_type = 'NEW_VALUES');`,
ALTER CHANGE STREAM csname SET OPTIONS (retention_period = '36h', value_capture_type = 'NEW_VALUES', exclude_ttl_deletes=TRUE, exclude_insert=TRUE, exclude_update=TRUE, exclude_delete=TRUE);`,
&DDL{
Filename: "filename",
List: []DDLStmt{
Expand Down Expand Up @@ -1656,8 +1660,12 @@ func TestParseDDL(t *testing.T) {
Name: "csname",
Alteration: AlterChangeStreamOptions{
Options: ChangeStreamOptions{
RetentionPeriod: func(b string) *string { return &b }("36h"),
ValueCaptureType: func(b string) *string { return &b }("NEW_VALUES"),
RetentionPeriod: func(b string) *string { return &b }("36h"),
ValueCaptureType: func(b string) *string { return &b }("NEW_VALUES"),
ExcludeTTLDeletes: True,
ExcludeInsert: True,
ExcludeUpdate: True,
ExcludeDelete: True,
},
},
Position: line(4),
Expand Down
28 changes: 28 additions & 0 deletions spanner/spansql/sql.go
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,34 @@ func (cso ChangeStreamOptions) SQL() string {
hasOpt = true
str += fmt.Sprintf("value_capture_type='%s'", *cso.ValueCaptureType)
}
if cso.ExcludeTTLDeletes != nil {
if hasOpt {
str += ", "
}
hasOpt = true
str += fmt.Sprintf("exclude_ttl_deletes=%s", cso.ExcludeTTLDeletes.SQL())
}
if cso.ExcludeInsert != nil {
if hasOpt {
str += ", "
}
hasOpt = true
str += fmt.Sprintf("exclude_insert=%s", cso.ExcludeInsert.SQL())
}
if cso.ExcludeUpdate != nil {
if hasOpt {
str += ", "
}
hasOpt = true
str += fmt.Sprintf("exclude_update=%s", cso.ExcludeUpdate.SQL())
}
if cso.ExcludeDelete != nil {
if hasOpt {
str += ", "
}
hasOpt = true
str += fmt.Sprintf("exclude_delete=%s", cso.ExcludeDelete.SQL())
}
str += ")"
return str
}
Expand Down
20 changes: 14 additions & 6 deletions spanner/spansql/sql_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -653,12 +653,16 @@ func TestSQL(t *testing.T) {
Name: "csname",
WatchAllTables: true,
Options: ChangeStreamOptions{
RetentionPeriod: func(s string) *string { return &s }("7d"),
ValueCaptureType: func(s string) *string { return &s }("NEW_VALUES"),
RetentionPeriod: func(s string) *string { return &s }("7d"),
ValueCaptureType: func(s string) *string { return &s }("NEW_VALUES"),
ExcludeTTLDeletes: True,
ExcludeInsert: True,
ExcludeUpdate: True,
ExcludeDelete: True,
},
Position: line(1),
},
"CREATE CHANGE STREAM csname FOR ALL OPTIONS (retention_period='7d', value_capture_type='NEW_VALUES')",
"CREATE CHANGE STREAM csname FOR ALL OPTIONS (retention_period='7d', value_capture_type='NEW_VALUES', exclude_ttl_deletes=TRUE, exclude_insert=TRUE, exclude_update=TRUE, exclude_delete=TRUE)",
reparseDDL,
},
{
Expand Down Expand Up @@ -691,13 +695,17 @@ func TestSQL(t *testing.T) {
Name: "csname",
Alteration: AlterChangeStreamOptions{
Options: ChangeStreamOptions{
RetentionPeriod: func(s string) *string { return &s }("7d"),
ValueCaptureType: func(s string) *string { return &s }("NEW_VALUES"),
RetentionPeriod: func(s string) *string { return &s }("7d"),
ValueCaptureType: func(s string) *string { return &s }("NEW_VALUES"),
ExcludeTTLDeletes: True,
ExcludeInsert: True,
ExcludeUpdate: True,
ExcludeDelete: True,
},
},
Position: line(1),
},
"ALTER CHANGE STREAM csname SET OPTIONS (retention_period='7d', value_capture_type='NEW_VALUES')",
"ALTER CHANGE STREAM csname SET OPTIONS (retention_period='7d', value_capture_type='NEW_VALUES', exclude_ttl_deletes=TRUE, exclude_insert=TRUE, exclude_update=TRUE, exclude_delete=TRUE)",
reparseDDL,
},
{
Expand Down
8 changes: 6 additions & 2 deletions spanner/spansql/types.go
Original file line number Diff line number Diff line change
Expand Up @@ -1276,8 +1276,12 @@ func (wd WatchDef) Pos() Position { return wd.Position }
func (wd *WatchDef) clearOffset() { wd.Position.Offset = 0 }

type ChangeStreamOptions struct {
RetentionPeriod *string
ValueCaptureType *string
RetentionPeriod *string
ValueCaptureType *string
ExcludeTTLDeletes IsExpr
ExcludeInsert IsExpr
ExcludeUpdate IsExpr
ExcludeDelete IsExpr
}

// AlterStatistics represents an ALTER STATISTICS statement.
Expand Down