Package cloud.google.com/go/spanner/spansql (v1.75.0)

const (
	True  = BoolLiteral(true)
	False = BoolLiteral(false)
)

const MaxLen = math.MaxInt64

const Null = NullLiteral(0)

const Star = StarExpr(0)

func IsKeyword(id string) bool

type AddColumn struct {
	IfNotExists bool
	Def         ColumnDef
}

func (ac AddColumn) SQL() string

type AddConstraint struct{ Constraint TableConstraint }

func (ac AddConstraint) SQL() string

type AddRowDeletionPolicy struct{ RowDeletionPolicy RowDeletionPolicy }

func (ardp AddRowDeletionPolicy) SQL() string

type AddStoredColumn struct{ Name ID }

func (asc AddStoredColumn) SQL() string

type AddSynonym struct{ Name ID }

func (as AddSynonym) SQL() string

type AggregateHaving struct {
	Condition AggregateHavingCondition
	Expr      Expr
}

type AggregateHavingCondition int

const (
	HavingMax AggregateHavingCondition = iota
	HavingMin
)

type AlterChangeStream struct {
	Name       ID
	Alteration ChangeStreamAlteration

	Position Position
}

func (acs *AlterChangeStream) Pos() Position

func (acs AlterChangeStream) SQL() string

func (acs *AlterChangeStream) String() string

type AlterChangeStreamOptions struct{ Options ChangeStreamOptions }

func (ao AlterChangeStreamOptions) SQL() string

type AlterColumn struct {
	Name       ID
	Alteration ColumnAlteration
}

func (ac AlterColumn) SQL() string

type AlterDatabase struct {
	Name       ID
	Alteration DatabaseAlteration

	Position Position // position of the "ALTER" token
}

func (ad *AlterDatabase) Pos() Position

func (ad AlterDatabase) SQL() string

func (ad *AlterDatabase) String() string

type AlterIndex struct {
	Name       ID
	Alteration IndexAlteration

	Position Position // position of the "ALTER" token
}

func (as *AlterIndex) Pos() Position

func (ai AlterIndex) SQL() string

func (as *AlterIndex) String() string

type AlterProtoBundle struct {
	AddTypes, UpdateTypes, DeleteTypes []string
	Position                           Position
}

func (ap *AlterProtoBundle) Pos() Position

func (ap AlterProtoBundle) SQL() string

func (ap *AlterProtoBundle) String() string

type AlterSequence struct {
	Name       ID
	Alteration SequenceAlteration

	Position Position
}

func (as *AlterSequence) Pos() Position

func (as AlterSequence) SQL() string

func (as *AlterSequence) String() string

type AlterStatistics struct {
	Name       ID
	Alteration StatisticsAlteration

	Position Position // position of the "ALTER" token
}

func (as *AlterStatistics) Pos() Position

func (as AlterStatistics) SQL() string

func (as *AlterStatistics) String() string

type AlterTable struct {
	Name       ID
	Alteration TableAlteration

	Position Position // position of the "ALTER" token
}

func (at *AlterTable) Pos() Position

func (at AlterTable) SQL() string

func (at *AlterTable) String() string

type AlterWatch struct {
	WatchAllTables bool
	Watch          []WatchDef
}

func (scsw AlterWatch) SQL() string

type ArithOp struct {
	Op       ArithOperator
	LHS, RHS Expr // only RHS is set for Neg, Plus, BitNot
}

func (ao ArithOp) SQL() string

type ArithOperator int

const (
	Neg    ArithOperator = iota // unary -
	Plus                        // unary +
	BitNot                      // unary ~
	Mul                         // *
	Div                         // /
	Concat                      // ||
	Add                         // +
	Sub                         // -
	BitShl                      // < bitshr="">>
	BitAnd                      // &
	BitXor                      // ^
	BitOr                       // |
)

type Array []Expr

func (a Array) SQL() string

type AtTimeZoneExpr struct {
	Expr Expr
	Type Type
	Zone string
}

func (aze AtTimeZoneExpr) SQL() string

type BoolExpr interface {
	Expr
	// contains filtered or unexported methods
}

type BoolLiteral bool

func (b BoolLiteral) SQL() string

type BytesLiteral string

func (bl BytesLiteral) SQL() string

type Case struct {
	Expr        Expr
	WhenClauses []WhenClause
	ElseResult  Expr
}

func (c Case) SQL() string

type ChangeStreamAlteration interface {
	SQL() string
	// contains filtered or unexported methods
}

type ChangeStreamOptions struct {
	RetentionPeriod  *string
	ValueCaptureType *string
}

func (cso ChangeStreamOptions) SQL() string

type Check struct {
	Expr BoolExpr

	Position Position // position of the "CHECK" token
}

func (c Check) Pos() Position

func (c Check) SQL() string

type Coalesce struct {
	ExprList []Expr
}

func (c Coalesce) SQL() string

type ColumnAlteration interface {
	SQL() string
	// contains filtered or unexported methods
}

type ColumnDef struct {
	Name    ID
	Type    Type
	NotNull bool

	Default   Expr // set if this column has a default value
	Generated Expr // set of this is a generated column

	Options ColumnOptions

	Position Position // position of the column name
}

func (cd ColumnDef) Pos() Position

func (cd ColumnDef) SQL() string

type ColumnOptions struct {
	// AllowCommitTimestamp represents a column OPTIONS.
	// `true` if query is `OPTIONS (allow_commit_timestamp = true)`
	// `false` if query is `OPTIONS (allow_commit_timestamp = null)`
	// `nil` if there are no OPTIONS
	AllowCommitTimestamp *bool
}

func (co ColumnOptions) SQL() string

type Comment struct {
	Marker   string // Opening marker; one of "#", "--", "/*".
	Isolated bool   // Whether this comment is on its own line.
	// Start and End are the position of the opening and terminating marker.
	Start, End Position
	Text       []string
}

func (c *Comment) Pos() Position

func (c *Comment) String() string

type ComparisonOp struct {
	Op       ComparisonOperator
	LHS, RHS Expr

	// RHS2 is the third operand for BETWEEN.
	// "

func (co ComparisonOp) SQL() string

type ComparisonOperator int

const (
	Lt ComparisonOperator = iota
	Le
	Gt
	Ge
	Eq
	Ne // both "!=" and "<>"
	Like
	NotLike
	Between
	NotBetween
)

type Constraint interface {
	SQL() string
	Node
	// contains filtered or unexported methods
}

type CreateChangeStream struct {
	Name           ID
	Watch          []WatchDef
	WatchAllTables bool
	Options        ChangeStreamOptions

	Position Position
}

func (cs *CreateChangeStream) Pos() Position

func (cs CreateChangeStream) SQL() string

func (cs *CreateChangeStream) String() string

type CreateIndex struct {
	Name    ID
	Table   ID
	Columns []KeyPart

	Unique       bool
	NullFiltered bool
	IfNotExists  bool

	Storing    []ID
	Interleave ID

	Position Position // position of the "CREATE" token
}

func (ci *CreateIndex) Pos() Position

func (ci CreateIndex) SQL() string

func (ci *CreateIndex) String() string

type CreateProtoBundle struct {
	Types    []string
	Position Position
}

func (cp *CreateProtoBundle) Pos() Position

func (cp CreateProtoBundle) SQL() string

func (cp *CreateProtoBundle) String() string

type CreateRole struct {
	Name ID

	Position Position // position of the "CREATE" token
}

func (cr *CreateRole) Pos() Position

func (cr CreateRole) SQL() string

func (cr *CreateRole) String() string

type CreateSequence struct {
	Name        ID
	IfNotExists bool
	Options     SequenceOptions

	Position Position
}

func (cs *CreateSequence) Pos() Position

func (cs CreateSequence) SQL() string

func (cs *CreateSequence) String() string

type CreateTable struct {
	Name              ID
	IfNotExists       bool
	Columns           []ColumnDef
	Constraints       []TableConstraint
	PrimaryKey        []KeyPart
	Interleave        *Interleave
	RowDeletionPolicy *RowDeletionPolicy
	Synonym           ID // may be empty

	Position Position // position of the "CREATE" token
}

func (ct *CreateTable) Pos() Position

func (ct CreateTable) SQL() string

func (ct *CreateTable) String() string

type CreateView struct {
	Name         ID
	OrReplace    bool
	SecurityType SecurityType
	Query        Query

	Position Position // position of the "CREATE" token
}

func (cv *CreateView) Pos() Position

func (cv CreateView) SQL() string

func (cv *CreateView) String() string

type DDL struct {
	List []DDLStmt

	Filename string // if known at parse time

	Comments []*Comment // all comments, sorted by position
}

func ParseDDL(filename, s string) (*DDL, error)

func (d *DDL) InlineComment(n Node) *Comment

func (d *DDL) LeadingComment(n Node) *Comment

type DDLStmt interface {
	SQL() string
	Node
	// contains filtered or unexported methods
}

func ParseDDLStmt(s string) (DDLStmt, error)

type DML struct {
	List []DMLStmt

	Filename string // if known at parse time

	Comments []*Comment // all comments, sorted by position
}

func ParseDML(filename, s string) (*DML, error)

func (d *DML) InlineComment(n Node) *Comment

func (d *DML) LeadingComment(n Node) *Comment

type DMLStmt interface {
	SQL() string
	// contains filtered or unexported methods
}

func ParseDMLStmt(s string) (DMLStmt, error)

type DatabaseAlteration interface {
	SQL() string
	// contains filtered or unexported methods
}

type DatabaseOptions struct {
	OptimizerVersion           *int
	OptimizerStatisticsPackage *string
	VersionRetentionPeriod     *string
	EnableKeyVisualizer        *bool
	DefaultLeader              *string
}

func (do DatabaseOptions) SQL() string

type DateLiteral civil.Date

func (dl DateLiteral) SQL() string

type Delete struct {
	Table ID
	Where BoolExpr
}

func (d *Delete) SQL() string

func (d *Delete) String() string

type DropChangeStream struct {
	Name ID

	Position Position
}

func (dc *DropChangeStream) Pos() Position

func (dc DropChangeStream) SQL() string

func (dc *DropChangeStream) String() string

type DropChangeStreamWatch struct{}

func (dcsw DropChangeStreamWatch) SQL() string

type DropColumn struct{ Name ID }

func (dc DropColumn) SQL() string

type DropConstraint struct{ Name ID }

func (dc DropConstraint) SQL() string

type DropDefault struct{}

func (dp DropDefault) SQL() string

type DropIndex struct {
	Name     ID
	IfExists bool

	Position Position // position of the "DROP" token
}

func (di *DropIndex) Pos() Position

func (di DropIndex) SQL() string

func (di *DropIndex) String() string

type DropProtoBundle struct {
	Position Position
}

func (dp *DropProtoBundle) Pos() Position

func (do DropProtoBundle) SQL() string

func (dp *DropProtoBundle) String() string

type DropRole struct {
	Name ID

	Position Position // position of the "DROP" token
}

func (dr *DropRole) Pos() Position

func (dr DropRole) SQL() string

func (dr *DropRole) String() string

type DropRowDeletionPolicy struct{}

func (drdp DropRowDeletionPolicy) SQL() string

type DropSequence struct {
	Name     ID
	IfExists bool

	Position Position
}

func (ds *DropSequence) Pos() Position

func (do DropSequence) SQL() string

func (ds *DropSequence) String() string

type DropStoredColumn struct{ Name ID }

func (dsc DropStoredColumn) SQL() string

type DropSynonym struct{ Name ID }

func (ds DropSynonym) SQL() string

type DropTable struct {
	Name     ID
	IfExists bool

	Position Position // position of the "DROP" token
}

func (dt *DropTable) Pos() Position

func (dt DropTable) SQL() string

func (dt *DropTable) String() string

type DropView struct {
	Name ID

	Position Position // position of the "DROP" token
}

func (dv *DropView) Pos() Position

func (dv DropView) SQL() string

func (dv *DropView) String() string

type Expr interface {
	SQL() string
	// contains filtered or unexported methods
}

type ExtractExpr struct {
	Part string
	Type Type
	Expr Expr
}

func (ee ExtractExpr) SQL() string

type FloatLiteral float64

func (fl FloatLiteral) SQL() string

type ForeignKey struct {
	Columns    []ID
	RefTable   ID
	RefColumns []ID
	OnDelete   OnDelete

	Position Position // position of the "FOREIGN" token
}

func (fk ForeignKey) Pos() Position

func (fk ForeignKey) SQL() string

type Func struct {
	Name string // not ID
	Args []Expr

	Distinct      bool
	NullsHandling NullsHandling
	Having        *AggregateHaving
}

func (f Func) SQL() string

type GrantRole struct {
	ToRoleNames       []ID
	GrantRoleNames    []ID
	Privileges        []Privilege
	TableNames        []ID
	TvfNames          []ID
	ViewNames         []ID
	ChangeStreamNames []ID

	Position Position // position of the "GRANT" token
}

func (gr *GrantRole) Pos() Position

func (gr GrantRole) SQL() string

func (gr *GrantRole) String() string

type ID string

func (id ID) SQL() string

type If struct {
	Expr       Expr
	TrueResult Expr
	ElseResult Expr
}

func (i If) SQL() string

type IfNull struct {
	Expr       Expr
	NullResult Expr
}

func (in IfNull) SQL() string

type InOp struct {
	LHS    Expr
	Neg    bool
	RHS    []Expr
	Unnest bool
}

func (io InOp) SQL() string

type IndexAlteration interface {
	SQL() string
	// contains filtered or unexported methods
}

type Insert struct {
	Table   ID
	Columns []ID
	Input   ValuesOrSelect
}

func (i *Insert) SQL() string

func (i *Insert) String() string

type IntegerLiteral int64

func (il IntegerLiteral) SQL() string

type Interleave struct {
	Parent   ID
	OnDelete OnDelete
}

type IntervalExpr struct {
	Expr     Expr
	DatePart string
}

func (ie IntervalExpr) SQL() string

type IsExpr interface {
	Expr
	// contains filtered or unexported methods
}

type IsOp struct {
	LHS Expr
	Neg bool
	RHS IsExpr
}

func (io IsOp) SQL() string

type JSONLiteral []byte

func (jl JSONLiteral) SQL() string

type JoinType int

const (
	InnerJoin JoinType = iota
	CrossJoin
	FullJoin
	LeftJoin
	RightJoin
)

type KeyPart struct {
	Column ID
	Desc   bool
}

func (kp KeyPart) SQL() string

type LiteralOrParam interface {
	SQL() string
	// contains filtered or unexported methods
}

type LogicalOp struct {
	Op       LogicalOperator
	LHS, RHS BoolExpr // only RHS is set for Not
}

func (lo LogicalOp) SQL() string

type LogicalOperator int

const (
	And LogicalOperator = iota
	Or
	Not
)

type Node interface {
	Pos() Position
}

type NullIf struct {
	Expr        Expr
	ExprToMatch Expr
}

func (ni NullIf) SQL() string

type NullLiteral int

func (NullLiteral) SQL() string

type NullsHandling int

const (
	NullsHandlingUnspecified NullsHandling = iota
	RespectNulls
	IgnoreNulls
)

type OnDelete int

const (
	NoActionOnDelete OnDelete = iota
	CascadeOnDelete
)

func (od OnDelete) SQL() string

type Order struct {
	Expr Expr
	Desc bool
}

func (o Order) SQL() string

type Param string

func (p Param) SQL() string

type Paren struct {
	Expr Expr
}

func (p Paren) SQL() string

type PathExp []ID

func (pe PathExp) SQL() string

type Position struct {
	Line   int // 1-based line number
	Offset int // 0-based byte offset
}

func (pos Position) IsValid() bool

func (pos Position) String() string

type Privilege struct {
	Type    PrivilegeType
	Columns []ID
}

type PrivilegeType int

const (
	PrivilegeTypeSelect PrivilegeType = iota
	PrivilegeTypeInsert
	PrivilegeTypeUpdate
	PrivilegeTypeDelete
)

func (pt PrivilegeType) SQL() string

type Query struct {
	Select Select
	Order  []Order

	Limit, Offset LiteralOrParam
}

func ParseQuery(s string) (Query, error)

func (q Query) SQL() string

type RenameTable struct {
	TableRenameOps []TableRenameOp

	Position Position // position of the "RENAME" token
}

func (rt *RenameTable) Pos() Position

func (rt RenameTable) SQL() string

func (rt *RenameTable) String() string

type RenameTo struct {
	ToName  ID
	Synonym ID // may be empty
}

func (rt RenameTo) SQL() string

type ReplaceRowDeletionPolicy struct{ RowDeletionPolicy RowDeletionPolicy }

func (rrdp ReplaceRowDeletionPolicy) SQL() string

type RevokeRole struct {
	FromRoleNames     []ID
	RevokeRoleNames   []ID
	Privileges        []Privilege
	TableNames        []ID
	TvfNames          []ID
	ViewNames         []ID
	ChangeStreamNames []ID
	Position          Position // position of the "REVOKE" token
}

func (rr *RevokeRole) Pos() Position

func (rr RevokeRole) SQL() string

func (rr *RevokeRole) String() string

type RowDeletionPolicy struct {
	Column  ID
	NumDays int64
}

func (rdp RowDeletionPolicy) SQL() string

type SecurityType int

const (
	Invoker SecurityType = iota
	Definer
)

func (st SecurityType) SQL() string

type Select struct {
	Distinct bool
	List     []Expr
	From     []SelectFrom
	Where    BoolExpr
	GroupBy  []Expr

	// When the FROM clause has TABLESAMPLE operators,
	// TableSamples will be populated 1:1 with From;
	// FROM clauses without will have a nil value.
	TableSamples []*TableSample

	// If the SELECT list has explicit aliases ("AS alias"),
	// ListAliases will be populated 1:1 with List;
	// aliases that are present will be non-empty.
	ListAliases []ID
}

func (sel Select) SQL() string

type SelectFrom interface {
	SQL() string
	// contains filtered or unexported methods
}

type SelectFromJoin struct {
	Type     JoinType
	LHS, RHS SelectFrom

	// Join condition.
	// At most one of {On,Using} may be set.
	On    BoolExpr
	Using []ID

	// Hints are suggestions for how to evaluate a join.
	// https://cloud.google.com/spanner/docs/query-syntax#join-hints
	Hints map[string]string
}

func (sfj SelectFromJoin) SQL() string

type SelectFromTable struct {
	Table ID
	Alias ID // empty if not aliased
	Hints map[string]string
}

func (sft SelectFromTable) SQL() string

type SelectFromUnnest struct {
	Expr  Expr
	Alias ID // empty if not aliased

}

func (sfu SelectFromUnnest) SQL() string

type SequenceAlteration interface {
	SQL() string
	// contains filtered or unexported methods
}

type SequenceExpr struct {
	Name ID
}

func (se SequenceExpr) SQL() string

type SequenceOptions struct {
	SequenceKind     *string
	SkipRangeMin     *int
	SkipRangeMax     *int
	StartWithCounter *int
}

func (so SequenceOptions) SQL() string

type SetColumnOptions struct{ Options ColumnOptions }

func (sco SetColumnOptions) SQL() string

type SetColumnType struct {
	Type    Type
	NotNull bool
	Default Expr
}

func (sct SetColumnType) SQL() string

type SetDatabaseOptions struct{ Options DatabaseOptions }

func (sdo SetDatabaseOptions) SQL() string

type SetDefault struct {
	Default Expr
}

func (sd SetDefault) SQL() string

type SetOnDelete struct{ Action OnDelete }

func (sod SetOnDelete) SQL() string

type SetSequenceOptions struct{ Options SequenceOptions }

func (sa SetSequenceOptions) SQL() string

type SetStatisticsOptions struct{ Options StatisticsOptions }

func (sso SetStatisticsOptions) SQL() string

type StarExpr int

func (StarExpr) SQL() string

type StatisticsAlteration interface {
	SQL() string
	// contains filtered or unexported methods
}

type StatisticsOptions struct {
	AllowGC *bool
}

func (sa StatisticsOptions) SQL() string

type StringLiteral string

func (sl StringLiteral) SQL() string

type TableAlteration interface {
	SQL() string
	// contains filtered or unexported methods
}

type TableConstraint struct {
	Name       ID // may be empty
	Constraint Constraint

	Position Position // position of the "CONSTRAINT" token, or Constraint.Pos()
}

func (tc TableConstraint) Pos() Position

func (tc TableConstraint) SQL() string

type TableRenameOp struct {
	FromName ID
	ToName   ID
}

type TableSample struct {
	Method   TableSampleMethod
	Size     Expr
	SizeType TableSampleSizeType
}