Implement inline PRIMARY KEY (#248)

* Implement column inline PRIMARY KEY * Update testdata
cloudspannerecosystem · Jan 1, 2025 · 480c4e8 · 480c4e8
1 parent 9ed6971
commit 480c4e8
Show file tree

Hide file tree

Showing 53 changed files with 291 additions and 118 deletions.
diff --git a/ast/ast.go b/ast/ast.go
@@ -2350,7 +2350,7 @@ type DropProtoBundle struct {
 //	  {{.TableConstraints | sqlJoin ","}}{{if and .TableConstraints .Synonym}},{{end}}
 //	  {{.Synonym | sqlJoin ","}}
 //	)
-//	PRIMARY KEY ({{.PrimaryKeys | sqlJoin ","}})
+//	{{if .PrimaryKeys}}PRIMARY KEY ({{.PrimaryKeys | sqlJoin ","}}){{end}}
 //	{{.Cluster | sqlOpt}}
 //	{{.CreateRowDeletionPolicy | sqlOpt}}
 //
@@ -2368,7 +2368,7 @@ type CreateTable struct {
 	Name              *Path
 	Columns           []*ColumnDef
 	TableConstraints  []*TableConstraint
-	PrimaryKeys       []*IndexKey
+	PrimaryKeys       []*IndexKey // when omitted, len(PrimaryKeys) = 0
 	Synonyms          []*Synonym
 	Cluster           *Cluster                 // optional
 	RowDeletionPolicy *CreateRowDeletionPolicy // optional
@@ -2438,22 +2438,26 @@ type BitReversedPositive struct {
 	BitReversedPositive token.Pos // position of "BIT_REVERSED_POSITIVE" keyword
 }
 
-// ColumnDef is column definition in CREATE TABLE.
+// ColumnDef is column definition in CREATE TABLE and ALTER TABLE ADD COLUMN.
+// Note: Some fields are not valid in ADD COLUMN.
 //
 //	{{.Name | sql}}
 //	{{.Type | sql}} {{if .NotNull}}NOT NULL{{end}}
 //	{{.DefaultSemantics | sqlOpt}}
 //	{{if .Hidden.Invalid | not)}}HIDDEN{{end}}
+//	{{if .PrimaryKey}}PRIMARY KEY{{end}}
 //	{{.Options | sqlOpt}}
 type ColumnDef struct {
 	// pos = Name.pos
-	// end = Options.end || Hidden + 6 || DefaultSemantics.end || Null + 4 || Type.end
+	// end = Options.end || Key + 3 || Hidden + 6 || DefaultSemantics.end || Null + 4 || Type.end
 
 	Null token.Pos // position of "NULL"
+	Key  token.Pos // position of "KEY" of PRIMARY KEY
 
-	Name    *Ident
-	Type    SchemaType
-	NotNull bool
+	Name       *Ident
+	Type       SchemaType
+	NotNull    bool
+	PrimaryKey bool
 
 	DefaultSemantics ColumnDefaultSemantics // optional
 

diff --git a/ast/pos.go b/ast/pos.go
diff --git a/ast/sql.go b/ast/sql.go
@@ -789,7 +789,8 @@ func (c *CreateTable) SQL() string {
 		indent + sqlJoin(c.Columns, ",\n"+indent) + strOpt(len(c.Columns) > 0 && (len(c.TableConstraints) > 0 || len(c.Synonyms) > 0), ",\n") +
 		strOpt(len(c.TableConstraints) > 0, indent) + sqlJoin(c.TableConstraints, ",\n"+indent) + strOpt(len(c.TableConstraints) > 0 && len(c.Synonyms) > 0, ",\n") +
 		strOpt(len(c.Synonyms) > 0, indent) + sqlJoin(c.Synonyms, ",\n") +
-		"\n) PRIMARY KEY (" + sqlJoin(c.PrimaryKeys, ", ") + ")" +
+		"\n)" +
+		strOpt(len(c.PrimaryKeys) > 0, " PRIMARY KEY ("+sqlJoin(c.PrimaryKeys, ", ")+")") +
 		sqlOpt("", c.Cluster, "") +
 		sqlOpt("", c.RowDeletionPolicy, "")
 }
@@ -836,6 +837,7 @@ func (c *ColumnDef) SQL() string {
 		strOpt(c.NotNull, " NOT NULL") +
 		sqlOpt(" ", c.DefaultSemantics, "") +
 		strOpt(!c.Hidden.Invalid(), " HIDDEN") +
+		strOpt(c.PrimaryKey, " PRIMARY KEY") +
 		sqlOpt(" ", c.Options, "")
 }
 

diff --git a/parser.go b/parser.go
@@ -3072,22 +3072,26 @@ func (p *Parser) parseCreateTable(pos token.Pos) *ast.CreateTable {
 	}
 	p.expect(")")
 
-	p.expectKeywordLike("PRIMARY")
-	p.expectKeywordLike("KEY")
-
-	p.expect("(")
+	// PRIMARY KEY clause is now optional
 	var keys []*ast.IndexKey
-	for p.Token.Kind != token.TokenEOF {
-		if p.Token.Kind == ")" {
-			break
-		}
-		keys = append(keys, p.parseIndexKey())
-		if p.Token.Kind != "," {
-			break
-		}
+	rparen := token.InvalidPos
+	if p.Token.IsKeywordLike("PRIMARY") {
 		p.nextToken()
+		p.expectKeywordLike("KEY")
+
+		p.expect("(")
+		for p.Token.Kind != token.TokenEOF {
+			if p.Token.Kind == ")" {
+				break
+			}
+			keys = append(keys, p.parseIndexKey())
+			if p.Token.Kind != "," {
+				break
+			}
+			p.nextToken()
+		}
+		rparen = p.expect(")").Pos
 	}
-	rparen := p.expect(")").Pos
 
 	cluster := p.tryParseCluster()
 	rdp := p.tryParseCreateRowDeletionPolicy()
@@ -3223,13 +3227,21 @@ func (p *Parser) parseColumnDef() *ast.ColumnDef {
 		hiddenPos = p.expectKeywordLike("HIDDEN").Pos
 	}
 
+	key := token.InvalidPos
+	if p.Token.IsKeywordLike("PRIMARY") {
+		p.nextToken()
+		key = p.expectKeywordLike("KEY").Pos
+	}
+
 	options := p.tryParseOptions()
 
 	return &ast.ColumnDef{
 		Null:             null,
+		Key:              key,
 		Name:             name,
 		Type:             t,
 		NotNull:          notNull,
+		PrimaryKey:       !key.Invalid(),
 		DefaultSemantics: defaultSemantics,
 		Hidden:           hiddenPos,
 		Options:          options,

diff --git a/testdata/input/ddl/create_table_with_identity_columns.sql b/testdata/input/ddl/create_table_with_identity_columns.sql
@@ -1,9 +1,10 @@
 create table foo (
     id int64 generated by default as identity (
-        bit_reversed_positive start counter with 1000 skip range 1, 12345),
+        bit_reversed_positive start counter with 1000 skip range 1, 12345)
+        primary key,
     startCount int64 generated by default as identity (
         bit_reversed_positive start counter with 1000),
     skipRange int64 generated by default as identity (
         bit_reversed_positive skip range 1000, 2000),
     simple int64 generated by default as identity ( bit_reversed_positive),
-) primary key (id)
+)
diff --git a/testdata/result/ddl/!bad_alter_table_add_column.sql.txt b/testdata/result/ddl/!bad_alter_table_add_column.sql.txt
@@ -21,6 +21,7 @@ syntax error: testdata/input/ddl/!bad_alter_table_add_column.sql:1:44: expected
     Add:    16,
     Column: &ast.ColumnDef{
       Null: -1,
+      Key:  -1,
       Name: &ast.Ident{
         NamePos: 27,
         NameEnd: 30,

diff --git a/testdata/result/ddl/alter_table_add_column.sql.txt b/testdata/result/ddl/alter_table_add_column.sql.txt
@@ -15,6 +15,7 @@ alter table foo add column baz string(max) not null
     Add:    16,
     Column: &ast.ColumnDef{
       Null: 47,
+      Key:  -1,
       Name: &ast.Ident{
         NamePos: 27,
         NameEnd: 30,

diff --git a/testdata/result/ddl/alter_table_add_column_identity.sql.txt b/testdata/result/ddl/alter_table_add_column_identity.sql.txt
@@ -15,6 +15,7 @@ alter table foo add column baz int64 not null generated by default as identity (
     Add:    16,
     Column: &ast.ColumnDef{
       Null: 41,
+      Key:  -1,
       Name: &ast.Ident{
         NamePos: 27,
         NameEnd: 30,

diff --git a/testdata/result/ddl/alter_table_add_column_if_not_exists.sql.txt b/testdata/result/ddl/alter_table_add_column_if_not_exists.sql.txt
@@ -17,6 +17,7 @@ alter table foo add column if not exists baz string(max) not null
     IfNotExists: true,
     Column:      &ast.ColumnDef{
       Null: 61,
+      Key:  -1,
       Name: &ast.Ident{
         NamePos: 41,
         NameEnd: 44,

diff --git a/testdata/result/ddl/alter_table_add_column_with_if_expression.sql.txt b/testdata/result/ddl/alter_table_add_column_with_if_expression.sql.txt
@@ -15,6 +15,7 @@ ALTER TABLE foo ADD COLUMN expired_at TIMESTAMP AS (IF (status != "OPEN" AND sta
     Add:    16,
     Column: &ast.ColumnDef{
       Null: -1,
+      Key:  -1,
       Name: &ast.Ident{
         NamePos: 27,
         NameEnd: 37,

diff --git a/testdata/result/ddl/create_table.sql.txt b/testdata/result/ddl/create_table.sql.txt
@@ -29,6 +29,7 @@ create table foo (
   Columns: []*ast.ColumnDef{
     &ast.ColumnDef{
       Null: -1,
+      Key:  -1,
       Name: &ast.Ident{
         NamePos: 21,
         NameEnd: 24,
@@ -42,6 +43,7 @@ create table foo (
     },
     &ast.ColumnDef{
       Null: 50,
+      Key:  -1,
       Name: &ast.Ident{
         NamePos: 34,
         NameEnd: 37,
@@ -56,6 +58,7 @@ create table foo (
     },
     &ast.ColumnDef{
       Null: 78,
+      Key:  -1,
       Name: &ast.Ident{
         NamePos: 58,
         NameEnd: 61,
@@ -93,6 +96,7 @@ create table foo (
     },
     &ast.ColumnDef{
       Null: 145,
+      Key:  -1,
       Name: &ast.Ident{
         NamePos: 125,
         NameEnd: 128,
@@ -147,6 +151,7 @@ create table foo (
     },
     &ast.ColumnDef{
       Null: -1,
+      Key:  -1,
       Name: &ast.Ident{
         NamePos: 482,
         NameEnd: 486,
@@ -160,6 +165,7 @@ create table foo (
     },
     &ast.ColumnDef{
       Null: 515,
+      Key:  -1,
       Name: &ast.Ident{
         NamePos: 495,
         NameEnd: 500,

diff --git a/testdata/result/ddl/create_table_cluster.sql.txt b/testdata/result/ddl/create_table_cluster.sql.txt
@@ -20,6 +20,7 @@ create table foo (
   Columns: []*ast.ColumnDef{
     &ast.ColumnDef{
       Null: -1,
+      Key:  -1,
       Name: &ast.Ident{
         NamePos: 21,
         NameEnd: 24,
@@ -33,6 +34,7 @@ create table foo (
     },
     &ast.ColumnDef{
       Null: -1,
+      Key:  -1,
       Name: &ast.Ident{
         NamePos: 34,
         NameEnd: 37,
@@ -64,5 +66,5 @@ create table foo (
 CREATE TABLE foo (
   foo INT64,
   bar INT64
-) PRIMARY KEY (),
+),
   INTERLEAVE IN PARENT foobar
diff --git a/testdata/result/ddl/create_table_cluster_and_row_deletion_policy.sql.txt b/testdata/result/ddl/create_table_cluster_and_row_deletion_policy.sql.txt
@@ -22,6 +22,7 @@ create table foo (
   Columns: []*ast.ColumnDef{
     &ast.ColumnDef{
       Null: -1,
+      Key:  -1,
       Name: &ast.Ident{
         NamePos: 21,
         NameEnd: 24,
@@ -35,6 +36,7 @@ create table foo (
     },
     &ast.ColumnDef{
       Null: -1,
+      Key:  -1,
       Name: &ast.Ident{
         NamePos: 34,
         NameEnd: 37,
@@ -48,6 +50,7 @@ create table foo (
     },
     &ast.ColumnDef{
       Null: -1,
+      Key:  -1,
       Name: &ast.Ident{
         NamePos: 47,
         NameEnd: 50,
@@ -98,5 +101,5 @@ CREATE TABLE foo (
   foo INT64,
   bar INT64,
   baz TIMESTAMP
-) PRIMARY KEY (),
+),
   INTERLEAVE IN PARENT foobar, ROW DELETION POLICY ( OLDER_THAN ( baz, INTERVAL 30 DAY ))
diff --git a/testdata/result/ddl/create_table_cluster_on_delete_no_action.sql.txt b/testdata/result/ddl/create_table_cluster_on_delete_no_action.sql.txt
@@ -19,6 +19,7 @@ create table foo (
   Columns: []*ast.ColumnDef{
     &ast.ColumnDef{
       Null: -1,
+      Key:  -1,
       Name: &ast.Ident{
         NamePos: 21,
         NameEnd: 24,

diff --git a/testdata/result/ddl/create_table_cluster_set_on_delete.sql.txt b/testdata/result/ddl/create_table_cluster_set_on_delete.sql.txt
@@ -19,6 +19,7 @@ create table foo (
   Columns: []*ast.ColumnDef{
     &ast.ColumnDef{
       Null: -1,
+      Key:  -1,
       Name: &ast.Ident{
         NamePos: 21,
         NameEnd: 24,

diff --git a/testdata/result/ddl/create_table_for_format_test.sql.txt b/testdata/result/ddl/create_table_for_format_test.sql.txt
@@ -29,6 +29,7 @@ create table if not exists foo (
   Columns: []*ast.ColumnDef{
     &ast.ColumnDef{
       Null: -1,
+      Key:  -1,
       Name: &ast.Ident{
         NamePos: 37,
         NameEnd: 40,
@@ -42,6 +43,7 @@ create table if not exists foo (
     },
     &ast.ColumnDef{
       Null: 68,
+      Key:  -1,
       Name: &ast.Ident{
         NamePos: 52,
         NameEnd: 55,
@@ -56,6 +58,7 @@ create table if not exists foo (
     },
     &ast.ColumnDef{
       Null: 98,
+      Key:  -1,
       Name: &ast.Ident{
         NamePos: 78,
         NameEnd: 81,
@@ -93,6 +96,7 @@ create table if not exists foo (
     },
     &ast.ColumnDef{
       Null: 167,
+      Key:  -1,
       Name: &ast.Ident{
         NamePos: 147,
         NameEnd: 150,
@@ -147,6 +151,7 @@ create table if not exists foo (
     },
     &ast.ColumnDef{
       Null: 408,
+      Key:  -1,
       Name: &ast.Ident{
         NamePos: 388,
         NameEnd: 393,