Support full-text search DDLs

ast/ast.go

@@ -32,6 +32,7 @@
 package ast
 
 import (
+	"fmt"
 	"github.com/cloudspannerecosystem/memefish/token"
 )
 
@@ -74,6 +75,9 @@ func (Revoke) isStatement()             {}
 func (CreateChangeStream) isStatement() {}
 func (AlterChangeStream) isStatement()  {}
 func (DropChangeStream) isStatement()   {}
+func (CreateSearchIndex) isStatement()  {}
+func (DropSearchIndex) isStatement()    {}
+func (AlterSearchIndex) isStatement()   {}
 
 // QueryExpr represents set operator operands.
 type QueryExpr interface {
@@ -245,6 +249,9 @@ func (Revoke) isDDL()             {}
 func (CreateChangeStream) isDDL() {}
 func (AlterChangeStream) isDDL()  {}
 func (DropChangeStream) isDDL()   {}
+func (CreateSearchIndex) isDDL()  {}
+func (DropSearchIndex) isDDL()    {}
+func (AlterSearchIndex) isDDL()   {}
 
 // Constraint represents table constraint of CONSTARINT clause.
 type Constraint interface {
@@ -934,7 +941,7 @@ type SelectorExpr struct {
 
 // IndexExpr is array item access expression node.
 //
-//	{{.Expr | sql}}[{{if .Ordinal}}ORDINAL{{else}}OFFSET{{end}}({{.Index | sql}})]
+//	{{.Expr | sql}}[{{if .Ordinal}}ORDINAL{{else}}OFFSET{{end}}({{.Name | sql}})]
 type IndexExpr struct {
 	// pos = Expr.pos
 	// end = Rbrack + 1
@@ -1445,6 +1452,59 @@ type CastNumValue struct {
 //
 // ================================================================================
 
+// GenericOptions is generic OPTIONS clause node without key and value checking.
+//
+//	OPTIONS ({{.Records | sqlJoin ","}})
+type GenericOptions struct {
+	// pos = Options
+	// end = Rparen + 1
+
+	Options token.Pos // position of "OPTIONS" keyword
+	Rparen  token.Pos // position of ")"
+
+	Records []*GenericOption // len(Records) > 0
+}
+
+// Find finds name in Records, and return its value as Expr.
+// The second return value indicates that the name was found in Records.
+func (o *GenericOptions) Find(name string) (expr Expr, found bool) {
+	for _, r := range o.Records {
+		if r.Name.Name != name {
+			continue
+		}
+		return r.Value, true
+	}
+	return nil, false
+}
+
+// FindBool finds name in Records, and return its value as *bool.
+// If the value is neither bool nor null, it returns error.
+func (o *GenericOptions) FindBool(name string) (*bool, error) {
+	v, ok := o.Find(name)
+	if !ok {
+		return nil, nil
+	}
+	switch v := v.(type) {
+	case *BoolLiteral:
+		return &v.Value, nil
+	case *NullLiteral:
+		return nil, nil
+	default:
+		return nil, fmt.Errorf("expect bool or null, but have unknown type %T", v)
+	}
+}
+
+// GenericOption is generic option for CREATE statements.
+//
+//	{{.Name | sql}} = {{.Value | sql}}
+type GenericOption struct {
+	// pos = Name.pos
+	// end = Value.end
+
+	Name  *Ident
+	Value Expr
+}
+
 // CreateDatabase is CREATE DATABASE statement node.
 //
 //	CREATE DATABASE {{.Name | sql}}
@@ -1506,10 +1566,11 @@ type CreateSequence struct {
 //	{{.Type | sql}} {{if .NotNull}}NOT NULL{{end}}
 //	{{.DefaultExpr | sqlOpt}}
 //	{{.GeneratedExpr | sqlOpt}}
+//	{{if not(.Hidden.Invalid())}}HIDDEN{{end}}
 //	{{.Options | sqlOpt}}
 type ColumnDef struct {
 	// pos = Name.pos
-	// end = Options.end || GeneratedExpr.end || DefaultExpr.end || Null + 4 || Type.end
+	// end = Options.end || Hidden + 6 || GeneratedExpr.end || DefaultExpr.end || Null + 4 || Type.end
 
 	Null token.Pos // position of "NULL"
 
@@ -1518,6 +1579,7 @@ type ColumnDef struct {
 	NotNull       bool
 	DefaultExpr   *ColumnDefaultExpr   // optional
 	GeneratedExpr *GeneratedColumnExpr // optional
+	Hidden        token.Pos            // InvalidPos if not hidden
 	Options       *ColumnDefOptions    // optional
 }
 
@@ -1536,13 +1598,14 @@ type ColumnDefaultExpr struct {
 
 // GeneratedColumnExpr is generated column expression.
 //
-//	AS ({{.Expr | sql}}) STORED
+//	AS ({{.Expr | sql}}) {{if .IsStored}}STORED{{end}}
 type GeneratedColumnExpr struct {
 	// pos = As
-	// end = Stored
+	// end = Stored + 6 || Rparen + 1
 
 	As     token.Pos // position of "AS" keyword
-	Stored token.Pos // position of "STORED" keyword
+	Stored token.Pos // position of "STORED" keyword, InvalidPos if not stored
+	Rparen token.Pos // position of ")"
 
 	Expr Expr
 }
@@ -2336,6 +2399,76 @@ type ArraySchemaType struct {
 	Item SchemaType // ScalarSchemaType or SizedSchemaType
 }
 
+// ================================================================================
+//
+// Search Index DDL
+//
+// ================================================================================
+
+// CreateSearchIndex represents CREATE SEARCH INDEX statement
+//
+//	CREATE SEARCH INDEX {{.Name | sql}}
+//	ON {{.TableName | sql}}
+//	({{.TokenListPart | sqlJoin ", "}})
+//	{{.Storing | sqlOpt}}
+//	{{if not(.PartitionColumns | isnil)}}PARTITION BY {{.PartitionColumns  | sqlJoin ", "}}{{end}}
+//	{{.OrderBy | sqlOpt}}
+//	{{.Where | sqlOpt}}
+//	{{.Interleave | sqlOpt}}
+//	{{.Options | sqlOpt}}
+type CreateSearchIndex struct {
+	// pos = Create
+	// end = (Options ?? Interleave ?? Where ?? OrderBy ?? PartitionColumns[$] ?? Storing).end || Rparen + 1
+
+	Create token.Pos
+
+	Name             *Ident
+	TableName        *Ident
+	TokenListPart    []*Ident
+	Rparen           token.Pos           // position of ")" after TokenListPart
+	Storing          *Storing            // optional
+	PartitionColumns []*Ident            // optional
+	OrderBy          *OrderBy            // optional
+	Where            *Where              // optional
+	Interleave       *InterleaveIn       // optional
+	Options          *SearchIndexOptions // optional
+}
+
+// SearchIndexOptions represents OPTIONS for CREATE SEARCH INDEX statement.
+type SearchIndexOptions GenericOptions
+
+func (o *SearchIndexOptions) SortOrderSharding() (*bool, error) {
+	return (*GenericOptions)(o).FindBool("sort_order_sharding")
+}
+
+func (o *SearchIndexOptions) DisableAutomaticUIDColumn() (*bool, error) {
+	return (*GenericOptions)(o).FindBool("disable_automatic_uid_column")
+}
+
+// DropSearchIndex represents DROP SEARCH INDEX statement.
+//
+//	DROP SEARCH INDEX {{.IfExists | strOpt "IF EXISTS "}}{{Name | sql}}
+type DropSearchIndex struct {
+	// pos = Drop
+	// end = Name.end
+
+	Drop     token.Pos
+	IfExists bool
+	Name     *Ident
+}
+
+// AlterSearchIndex represents ALTER SEARCH INDEX statement.
+//
+//	ALTER SEARCH INDEX {{.Name | sql}} {{.IndexAlteration | sql}}
+type AlterSearchIndex struct {
+	// pos = Alter
+	// end = IndexAlteration.end
+
+	Alter           token.Pos
+	Name            *Ident
+	IndexAlteration IndexAlteration
+}
+
 // ================================================================================
 //
 // DML

ast/ast_test.go

@@ -1,6 +1,7 @@
 package ast
 
 import (
+	"github.com/google/go-cmp/cmp"
 	"testing"
 )
 
@@ -140,6 +141,9 @@ func TestDDL(t *testing.T) {
 	DDL(&DropRole{}).isDDL()
 	DDL(&Grant{}).isDDL()
 	DDL(&Revoke{}).isDDL()
+	DDL(&CreateSearchIndex{}).isDDL()
+	DDL(&DropSearchIndex{}).isDDL()
+	DDL(&AlterSearchIndex{}).isDDL()
 }
 
 func TestConstraint(t *testing.T) {
@@ -192,3 +196,84 @@ func TestInsertInput(t *testing.T) {
 	InsertInput(&ValuesInput{}).isInsertInput()
 	InsertInput(&SubQueryInput{}).isInsertInput()
 }
+
+func ptr[T any](v T) *T {
+	return &v
+}
+
+func TestGenericOptionsGetBool(t *testing.T) {
+	tcases := []struct {
+		desc    string
+		input   *GenericOptions
+		name    string
+		want    *bool
+		wantErr string
+	}{
+		{
+			desc: "true",
+			input: &GenericOptions{
+				Records: []*GenericOption{
+					{Name: &Ident{Name: "sort_order_sharding"}, Value: &BoolLiteral{Value: true}},
+				},
+			},
+			name: "sort_order_sharding",
+			want: ptr(true),
+		},
+		{
+			desc: "false",
+			input: &GenericOptions{
+				Records: []*GenericOption{
+					{Name: &Ident{Name: "sort_order_sharding"}, Value: &BoolLiteral{Value: false}},
+				},
+			},
+			name: "sort_order_sharding",
+			want: ptr(false),
+		},
+		{
+			desc: "explicit null",
+			input: &GenericOptions{
+				Records: []*GenericOption{
+					{Name: &Ident{Name: "sort_order_sharding"}, Value: &NullLiteral{}},
+				},
+			},
+			name: "sort_order_sharding",
+			want: nil,
+		},
+		{
+			desc: "implicit null",
+			input: &GenericOptions{
+				Records: []*GenericOption{
+					{Name: &Ident{Name: "disable_automatic_uid_column"}, Value: &BoolLiteral{Value: true}},
+				},
+			},
+			name: "sort_order_sharding",
+			want: nil,
+		},
+		{
+			desc: "invalid value",
+			input: &GenericOptions{
+				Records: []*GenericOption{
+					{Name: &Ident{Name: "sort_order_sharding"}, Value: &StringLiteral{Value: "foo"}},
+				},
+			},
+			name:    "sort_order_sharding",
+			wantErr: "expect bool or null, but have unknown type *ast.StringLiteral",
+		},
+	}
+
+	for _, tcase := range tcases {
+		t.Run(tcase.desc, func(t *testing.T) {
+			got, err := tcase.input.FindBool(tcase.name)
+			if tcase.wantErr == "" && err != nil {
+				t.Errorf("should not fail, but: %v", err)
+			}
+			if tcase.wantErr != "" && err.Error() != tcase.wantErr {
+				t.Errorf("should fail, want: %v, got: %v", tcase.wantErr, err)
+			}
+			if diff := cmp.Diff(tcase.want, got); diff != "" {
+				t.Errorf("differ: %v", diff)
+			}
+		})
+	}
+
+}

ast/const.go

@@ -109,6 +109,7 @@ const (
 	TimestampTypeName ScalarTypeName = "TIMESTAMP"
 	NumericTypeName   ScalarTypeName = "NUMERIC"
 	JSONTypeName      ScalarTypeName = "JSON"
+	TokenListTypeName ScalarTypeName = "TOKENLIST"
 )
 
 type OnDeleteAction string