spansql

package
v1.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 6, 2019 License: Apache-2.0 Imports: 7 Imported by: 81

Documentation

Overview

Package spansql contains types and a parser for the Cloud Spanner SQL dialect.

To parse, use one of the Parse functions (ParseDDL, ParseDDLStmt, ParseQuery, etc.).

Sources: 

https://cloud.google.com/spanner/docs/lexical
https://cloud.google.com/spanner/docs/query-syntax
https://cloud.google.com/spanner/docs/data-definition-language

Index

Constants

View Source 
const (
	True  = BoolLiteral(true)
	False = BoolLiteral(false)
)
View Source 
const MaxLen = math.MaxInt64

MaxLen is a sentinel for Type's Len field, representing the MAX value.

View Source 
const Null = NullLiteral(0)
View Source 
const Star = StarExpr(0)

Star represents a "*" in an expression.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddColumn 

type AddColumn struct{ Def ColumnDef }

func (AddColumn) SQL 

func (ac AddColumn) SQL() string

type AlterTable 

type AlterTable struct {
	Name       string
	Alteration TableAlteration
}

AlterTable represents an ALTER TABLE statement. https://cloud.google.com/spanner/docs/data-definition-language#alter_table

func (AlterTable) SQL 

func (at AlterTable) SQL() string

type BoolExpr 

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

type BoolLiteral 

type BoolLiteral bool

func (BoolLiteral) SQL 

func (b BoolLiteral) SQL() string

type BytesLiteral 

type BytesLiteral string

BytesLiteral represents a bytes literal. https://cloud.google.com/spanner/docs/lexical#string-and-bytes-literals

func (BytesLiteral) SQL 

func (bl BytesLiteral) SQL() string

type ColumnDef 

type ColumnDef struct {
	Name    string
	Type    Type
	NotNull bool
}

ColumnDef represents a column definition as part of a CREATE TABLE or ALTER TABLE statement.

func (ColumnDef) SQL 

func (cd ColumnDef) SQL() string

type ComparisonOp 

type ComparisonOp struct {
	LHS, RHS Expr
	Op       ComparisonOperator

	// RHS2 is the third operand for BETWEEN.
	// "<LHS> BETWEEN <RHS> AND <RHS2>".
	RHS2 Expr
}

func (ComparisonOp) SQL 

func (co ComparisonOp) SQL() string

type ComparisonOperator 

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

type CreateIndex 

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

	Unique       bool
	NullFiltered bool

	Storing    []string
	Interleave string
}

CreateIndex represents a CREATE INDEX statement. https://cloud.google.com/spanner/docs/data-definition-language#create-index

func (CreateIndex) SQL 

func (ci CreateIndex) SQL() string

type CreateTable 

type CreateTable struct {
	Name       string
	Columns    []ColumnDef
	PrimaryKey []KeyPart
	Interleave *Interleave
}

CreateTable represents a CREATE TABLE statement. https://cloud.google.com/spanner/docs/data-definition-language#create_table

func (CreateTable) SQL 

func (ct CreateTable) SQL() string

type DDL 

type DDL struct {
	List []DDLStmt
}

DDL represents a Data Definition Language (DDL) file.

func ParseDDL 

func ParseDDL(s string) (DDL, error)

ParseDDL parses a DDL file.

type DDLStmt 

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

DDLStmt is satisfied by a type that can appear in a DDL.

func ParseDDLStmt 

func ParseDDLStmt(s string) (DDLStmt, error)

ParseDDLStmt parses a single DDL statement.

type DropColumn 

type DropColumn struct{ Name string }

func (DropColumn) SQL 

func (dc DropColumn) SQL() string

type DropIndex 

type DropIndex struct{ Name string }

DropIndex represents a DROP INDEX statement. https://cloud.google.com/spanner/docs/data-definition-language#drop-index

func (DropIndex) SQL 

func (di DropIndex) SQL() string

type DropTable 

type DropTable struct{ Name string }

DropTable represents a DROP TABLE statement. https://cloud.google.com/spanner/docs/data-definition-language#drop_table

func (DropTable) SQL 

func (dt DropTable) SQL() string

type Expr 

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

type FloatLiteral 

type FloatLiteral float64

FloatLiteral represents a floating point literal. https://cloud.google.com/spanner/docs/lexical#floating-point-literals

func (FloatLiteral) SQL 

func (fl FloatLiteral) SQL() string

type Func 

type Func struct {
	Name string
	Args []Expr
}

Func represents a function call.

func (Func) SQL 

func (f Func) SQL() string

type ID 

type ID string

ID represents an identifier.

func (ID) SQL 

func (id ID) SQL() string

type IntegerLiteral 

type IntegerLiteral int64

IntegerLiteral represents an integer literal. https://cloud.google.com/spanner/docs/lexical#integer-literals

func (IntegerLiteral) SQL 

func (il IntegerLiteral) SQL() string

type Interleave 

type Interleave struct {
	Parent   string
	OnDelete OnDelete
}

Interleave represents an interleave clause of a CREATE TABLE statement.

type IsExpr 

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

type IsOp 

type IsOp struct {
	LHS Expr
	Neg bool
	RHS IsExpr
}

func (IsOp) SQL 

func (io IsOp) SQL() string

type KeyPart 

type KeyPart struct {
	Column string
	Desc   bool
}

KeyPart represents a column specification as part of a primary key or index definition.

func (KeyPart) SQL 

func (kp KeyPart) SQL() string

type Limit 

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

type LogicalOp 

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

func (LogicalOp) SQL 

func (lo LogicalOp) SQL() string

type LogicalOperator 

type LogicalOperator int
const (
	And LogicalOperator = iota
	Or
	Not
)

type NullLiteral 

type NullLiteral int

func (NullLiteral) SQL 

func (n NullLiteral) SQL() string

type OnDelete 

type OnDelete int
const (
	NoActionOnDelete OnDelete = iota
	CascadeOnDelete
)

func (OnDelete) SQL 

func (od OnDelete) SQL() string

type Order 

type Order struct {
	Expr Expr
	Desc bool
}

func (Order) SQL 

func (o Order) SQL() string

type Param 

type Param string

Param represents a query parameter.

func (Param) SQL 

func (p Param) SQL() string

type Paren 

type Paren struct {
	Expr Expr
}

Paren represents a parenthesised expression.

func (Paren) SQL 

func (p Paren) SQL() string

type Query 

type Query struct {
	Select Select
	Order  []Order
	Limit  Limit
}

Query represents a query statement. https://cloud.google.com/spanner/docs/query-syntax#sql-syntax

func ParseQuery 

func ParseQuery(s string) (Query, error)

ParseQuery parses a query string.

func (Query) SQL 

func (q Query) SQL() string

type Select 

type Select struct {
	List  []Expr
	From  []SelectFrom
	Where BoolExpr
}

Select represents a SELECT statement. https://cloud.google.com/spanner/docs/query-syntax#select-list

func (Select) SQL 

func (sel Select) SQL() string

type SelectFrom 

type SelectFrom struct {
	// This only supports a FROM clause directly from a table.
	Table       string
	TableSample *TableSample
}

type SetOnDelete 

type SetOnDelete struct{ Action OnDelete }

func (SetOnDelete) SQL 

func (sod SetOnDelete) SQL() string

type StarExpr 

type StarExpr int

func (StarExpr) SQL 

func (StarExpr) SQL() string

type StringLiteral 

type StringLiteral string

StringLiteral represents a string literal. https://cloud.google.com/spanner/docs/lexical#string-and-bytes-literals

func (StringLiteral) SQL 

func (sl StringLiteral) SQL() string

type TableAlteration 

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

TableAlteration is satisfied by AddColumn, DropColumn and SetOnDelete.

type TableSample 

type TableSample struct {
	Method   TableSampleMethod
	Size     Expr
	SizeType TableSampleSizeType
}

type TableSampleMethod 

type TableSampleMethod int
const (
	Bernoulli TableSampleMethod = iota
	Reservoir
)

type TableSampleSizeType 

type TableSampleSizeType int
const (
	PercentTableSample TableSampleSizeType = iota
	RowsTableSample
)

type Type 

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

Type represents a column type.

func (Type) SQL 

func (t Type) SQL() string

type TypeBase 

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

func (TypeBase) SQL 

func (tb TypeBase) SQL() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.