feat(spanner/spannersql): add backticks when name contains a hypen (#6621)

harshachinta · web-flow · commit e88ca66ca950 · 2022-09-07T11:23:03.000+05:30
diff --git a/spanner/spannertest/db_test.go b/spanner/spannertest/db_test.go
@@ -714,3 +714,17 @@ func TestForeignKeyAddAndAlterConstraint(t *testing.T) {
 		}
 	}
 }
+
+func TestAddBackQuoteForHypen(t *testing.T) {
+	ddl, err := spansql.ParseDDL("filename", "ALTER DATABASE `test-db` SET OPTIONS (optimizer_version=4, version_retention_period = '7d', enable_key_visualizer=true)")
+	if err != nil {
+		t.Fatalf("%s: Bad DDL", err)
+	}
+
+	got := ddl.List[0].SQL()
+	want := "ALTER DATABASE `test-db` SET OPTIONS (optimizer_version=4, version_retention_period='7d', enable_key_visualizer=true)"
+
+	if !reflect.DeepEqual(got, want) {
+		t.Errorf("Generated SQL statement incorrect.\n got %v\nwant %v", got, want)
+	}
+}
diff --git a/spanner/spansql/sql.go b/spanner/spansql/sql.go
@@ -701,7 +701,8 @@ func (id ID) addSQL(sb *strings.Builder) {
 
 	// TODO: If there are non-letters/numbers/underscores then this also needs quoting.
 
-	if IsKeyword(string(id)) {
+	// Naming Convention: Must be enclosed in backticks (`) if it's a reserved keyword or contains a hyphen.
+	if IsKeyword(string(id)) || strings.Contains(string(id), "-") {
 		// TODO: Escaping may be needed here.
 		sb.WriteString("`")
 		sb.WriteString(string(id))

Original file line number	Diff line number	Diff line change
`@@ -714,3 +714,17 @@ func TestForeignKeyAddAndAlterConstraint(t *testing.T) {`
`714`	`714`	`}`
`715`	`715`	`}`
`716`	`716`	`}`
	`717`	`+`
	`718`	`+func TestAddBackQuoteForHypen(t *testing.T) {`
	`719`	+ ddl, err := spansql.ParseDDL("filename", "ALTER DATABASE `test-db` SET OPTIONS (optimizer_version=4, version_retention_period = '7d', enable_key_visualizer=true)")
	`720`	`+ if err != nil {`
	`721`	`+ t.Fatalf("%s: Bad DDL", err)`
	`722`	`+ }`
	`723`	`+`
	`724`	`+ got := ddl.List[0].SQL()`
	`725`	+ want := "ALTER DATABASE `test-db` SET OPTIONS (optimizer_version=4, version_retention_period='7d', enable_key_visualizer=true)"
	`726`	`+`
	`727`	`+ if !reflect.DeepEqual(got, want) {`
	`728`	`+ t.Errorf("Generated SQL statement incorrect.\n got %v\nwant %v", got, want)`
	`729`	`+ }`
	`730`	`+}`