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

…6621)
googleapis · Sep 7, 2022 · e88ca66 · e88ca66
1 parent 2fa0bd4
commit e88ca66
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
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))