Package cloud.google.com/go/spanner/spansql (v1.16.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{ Def ColumnDef }

func (ac AddColumn) SQL() string

type AddConstraint struct{ Constraint TableConstraint }

func (ac AddConstraint) SQL() string

type AlterColumn struct {
	Name       ID
	Alteration ColumnAlteration
}

func (ac AlterColumn) SQL() 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 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 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 Check struct {
	Expr BoolExpr

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

func (c Check) Pos() Position

func (c Check) SQL() string

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

type ColumnDef struct {
	Name    ID
	Type    Type
	NotNull bool

	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 CreateIndex struct {
	Name    ID
	Table   ID
	Columns []KeyPart

	Unique       bool
	NullFiltered 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 CreateTable struct {
	Name        ID
	Columns     []ColumnDef
	Constraints []TableConstraint
	PrimaryKey  []KeyPart
	Interleave  *Interleave

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

func (ct *CreateTable) Pos() Position

func (ct CreateTable) SQL() string

func (ct *CreateTable) 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 (ddl *DDL) InlineComment(n Node) *Comment

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

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

func ParseDDLStmt(s string) (DDLStmt, error)

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

func ParseDMLStmt(s string) (DMLStmt, error)

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 DropColumn struct{ Name ID }

func (dc DropColumn) SQL() string

type DropConstraint struct{ Name ID }

func (dc DropConstraint) SQL() string

type DropIndex struct {
	Name ID

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

func (di *DropIndex) Pos() Position

func (di DropIndex) SQL() string

func (di *DropIndex) String() string

type DropTable struct {
	Name ID

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

func (dt *DropTable) Pos() Position

func (dt DropTable) SQL() string

func (dt *DropTable) String() string

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

type FloatLiteral float64

func (fl FloatLiteral) SQL() string

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

	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
}

func (f Func) SQL() string

type ID string

func (id ID) SQL() string

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

func (io InOp) SQL() string

type IntegerLiteral int64

func (il IntegerLiteral) SQL() string

type Interleave struct {
	Parent   ID
	OnDelete OnDelete
}

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

type IsOp struct {
	LHS Expr
	Neg bool
	RHS IsExpr
}

func (io IsOp) 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 NullLiteral int

func (NullLiteral) SQL() string

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 Query struct {
	Select Select
	Order  []Order

	Limit, Offset LiteralOrParam
}

func ParseQuery(s string) (Query, error)

func (q Query) 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
}

func (sft SelectFromTable) SQL() string

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

}

func (sfu SelectFromUnnest) SQL() string

type SetColumnOptions struct{ Options ColumnOptions }

func (sco SetColumnOptions) SQL() string

type SetColumnType struct {
	Type    Type
	NotNull bool
}

func (sct SetColumnType) SQL() string

type SetOnDelete struct{ Action OnDelete }

func (sod SetOnDelete) SQL() string

type StarExpr int

func (StarExpr) 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 TableSample struct {
	Method   TableSampleMethod
	Size     Expr
	SizeType TableSampleSizeType
}

type TableSampleMethod int

const (
	Bernoulli TableSampleMethod = iota
	Reservoir
)

type TableSampleSizeType int

const (
	PercentTableSample TableSampleSizeType = iota
	RowsTableSample
)

type TimestampLiteral time.Time

func (tl TimestampLiteral) SQL() string

type Type struct {
	Array bool
	Base  TypeBase // Bool, Int64, Float64, Numeric, String, Bytes, Date, Timestamp
	Len   int64    // if Base is String or Bytes; may be MaxLen
}

func (t Type) SQL() string

type TypeBase int

const (
	Bool TypeBase = iota
	Int64
	Float64
	Numeric
	String
	Bytes
	Date
	Timestamp
)

func (tb TypeBase) SQL() string

type Update struct {
	Table ID
	Items []UpdateItem
	Where BoolExpr
}

func (u *Update) SQL() string

func (u *Update) String() string

type UpdateItem struct {
	Column ID
	Value  Expr // or nil for DEFAULT
}