parser

Documentation

Overview

Package parser implements a parser for SQL statements

Inspired by go/parser

Index

• Constants
• func ParseDate(data string) (*time.Time, error)
• func TypeNameFromToken(tk int) string
• type Decl
  • func NewDecl(t Token) *Decl
  • func (d *Decl) Add(subDecl *Decl)
  • func (d Decl) Has(t int) (*Decl, bool)
  • func (d Decl) Stringy(depth int, printer func(fmt string, varargs ...any))
• type Instruction
  • func ParseInstruction(instruction string) ([]Instruction, error)
  • func (i Instruction) PrettyPrint(printer func(fmt string, varargs ...interface{}))
• type Matcher
• type Token

Constants

const (
	SpaceToken = iota
	SemicolonToken
	CommaToken
	BracketOpeningToken
	BracketClosingToken
	LeftDipleToken
	RightDipleToken
	LessOrEqualToken
	GreaterOrEqualToken
	BacktickToken

	DoubleQuoteToken
	SimpleQuoteToken
	StarToken
	EqualityToken
	DistinctnessToken
	PeriodToken

	CreateToken
	SelectToken
	InsertToken
	UpdateToken
	DeleteToken
	ExplainToken
	TruncateToken
	DropToken
	GrantToken
	DistinctToken

	FromToken
	WhereToken
	TableToken
	SchemaToken
	CurrentSchemaToken
	IntoToken
	ValuesToken
	JoinToken
	AsToken
	OnToken
	IfToken
	NotToken
	ExistsToken
	NullToken
	UnsignedToken
	AutoincrementToken
	CountToken
	SetToken
	OrderToken
	ByToken
	WithToken
	TimeToken
	ZoneToken
	ReturningToken
	InToken
	AndToken
	OrToken
	AscToken
	DescToken
	LimitToken
	IsToken
	ForToken
	DefaultToken
	LocalTimestampToken
	FalseToken
	UniqueToken
	NowToken
	OffsetToken
	IndexToken
	CollateToken
	NocaseToken

	TextToken
	IntToken
	PrimaryToken
	KeyToken
	StringToken
	DecimalToken
	NumberToken
	DateToken
	FloatToken

	ArgToken
	NamedArgToken
)

SQL Tokens

const DateLongFormat = "2006-01-02 15:04:05.999999999 -0700 MST"

DateLongFormat is same as time.Time#String(), except this does not include monotonic time section

const DateNumberFormat = "2006-01-02"

const DateShortFormat = "2006-Jan-02"

DateShortFormat is a short format

Functions

func ParseDate

func ParseDate(data string) (*time.Time, error)

ParseDate intends to parse all SQL date format

func TypeNameFromToken

func TypeNameFromToken(tk int) string

Types

type Decl

type Decl struct {
	Token  int
	Lexeme string
	Decl   []*Decl
}

Decl structure is the node to statement declaration tree

func NewDecl

func NewDecl(t Token) *Decl

NewDecl initialize a Decl struct from a given token

func (*Decl) Add

func (d *Decl) Add(subDecl *Decl)

Add creates a new leaf with given Decl

func (Decl) Has

func (d Decl) Has(t int) (*Decl, bool)

func (Decl) Stringy

func (d Decl) Stringy(depth int, printer func(fmt string, varargs ...any))

Stringy prints the declaration tree in console

type Instruction

type Instruction struct {
	Decls []*Decl
}

Instruction define a valid SQL statement

func ParseInstruction

func ParseInstruction(instruction string) ([]Instruction, error)

ParseInstruction calls lexer and parser, then return Decl tree for each instruction

func (Instruction) PrettyPrint

func (i Instruction) PrettyPrint(printer func(fmt string, varargs ...interface{}))

PrettyPrint prints instruction's declarations on console with indentation

type Matcher

type Matcher func() bool

Matcher tries to match given string to an SQL token

type Token

type Token struct {
	Token  int
	Lexeme string
}

Token struct holds token id and it's lexeme