parser

Documentation

Index

• Variables
• type AST
  • func (a AST) Alter() (*types.Alter, error)
  • func (a AST) Create() (*types.Create, error)
  • func (a AST) Delete() (*types.Delete, error)
  • func (a AST) Drop() (*types.Drop, error)
  • func (a AST) Insert() (*types.Insert, error)
  • func (a AST) Is(s types.Statement) bool
  • func (a AST) Select() (*types.Select, error)
  • func (a AST) Type() types.Statement
  • func (a AST) Update() (*types.Update, error)
  • func (a AST) Use() (*types.Use, error)
• type ASTResult
  • func NewASTResult(val *internal.ASTResult) *ASTResult
• type ASTs
  • func (s ASTs) FindAll(t types.Statement) ASTs
  • func (s ASTs) FindFirst(t types.Statement) AST
  • func (s ASTs) First() AST
  • func (s ASTs) Len() int
• type Database
  • func (d Database) String() string
• type Option
  • func WithDatabase(db Database) Option
• type ParseResult
  • func NewParseResult(val *internal.ParseResult) *ParseResult
• type Parser
  • func New() (*Parser, error)
  • func (p *Parser) Astify(sql string, opts ...Option) (*ASTResult, error)
  • func (p *Parser) ColumnList(sql string, opts ...Option) ([]string, error)
  • func (p *Parser) Parse(sql string, opts ...Option) (*ParseResult, error)
  • func (p *Parser) Sqlify(ast *ASTResult, opts ...Option) (string, error)
  • func (p *Parser) TableList(sql string, opts ...Option) ([]string, error)
  • func (p *Parser) WhiteListCheck(sql string, whiteList []string, opts ...Option) error

Variables

var Databases = []Database{
	Athena,
	BigQuery,
	DB2,
	FlinkSQL,
	Hive,
	MariaDB,
	MySQL,
	Noql,
	PostgreSQL,
	Redshift,
	Snowflake,
	Sqlite,
	TransactSQL,
	Trino,
}

var (
	ErrParserNotInitialized = fmt.Errorf("parser not initialized")
)

Types

type AST

type AST map[string]any

func (AST) Alter

func (a AST) Alter() (*types.Alter, error)

func (AST) Create

func (a AST) Create() (*types.Create, error)

func (AST) Delete

func (a AST) Delete() (*types.Delete, error)

func (AST) Drop

func (a AST) Drop() (*types.Drop, error)

func (AST) Insert

func (a AST) Insert() (*types.Insert, error)

func (AST) Is

func (a AST) Is(s types.Statement) bool

func (AST) Select

func (a AST) Select() (*types.Select, error)

func (AST) Type

func (a AST) Type() types.Statement

func (AST) Update

func (a AST) Update() (*types.Update, error)

func (AST) Use

func (a AST) Use() (*types.Use, error)

type ASTResult

type ASTResult struct {
	*internal.ASTResult
	AST ASTs
}

func NewASTResult

func NewASTResult(val *internal.ASTResult) *ASTResult

type ASTs

type ASTs []AST

func (ASTs) FindAll

func (s ASTs) FindAll(t types.Statement) ASTs

func (ASTs) FindFirst

func (s ASTs) FindFirst(t types.Statement) AST

func (ASTs) First

func (s ASTs) First() AST

func (ASTs) Len

func (s ASTs) Len() int

type Database

type Database string

const (
	Athena      Database = "athena"
	BigQuery    Database = "bigquery"
	DB2         Database = "db2"
	FlinkSQL    Database = "flinksql"
	Hive        Database = "hive"
	MariaDB     Database = "mariadb"
	MySQL       Database = "mysql"
	Noql        Database = "noql"
	PostgreSQL  Database = "postgresql"
	Redshift    Database = "redshift"
	Snowflake   Database = "snowflake"
	Sqlite      Database = "sqlite"
	TransactSQL Database = "transactsql"
	Trino       Database = "trino"
)

func (Database) String

func (d Database) String() string

type Option

type Option interface {
	Opt(types.Option)
}

func WithDatabase

func WithDatabase(db Database) Option

type ParseResult

type ParseResult struct {
	*ASTResult
	internal.TableColumnList
}

func NewParseResult

func NewParseResult(val *internal.ParseResult) *ParseResult

type Parser

type Parser struct {
	// contains filtered or unexported fields
}

func New

func New() (*Parser, error)

func (*Parser) Astify

func (p *Parser) Astify(sql string, opts ...Option) (*ASTResult, error)

func (*Parser) ColumnList

func (p *Parser) ColumnList(sql string, opts ...Option) ([]string, error)

func (*Parser) Parse

func (p *Parser) Parse(sql string, opts ...Option) (*ParseResult, error)

func (*Parser) Sqlify

func (p *Parser) Sqlify(ast *ASTResult, opts ...Option) (string, error)

func (*Parser) TableList

func (p *Parser) TableList(sql string, opts ...Option) ([]string, error)

func (*Parser) WhiteListCheck

func (p *Parser) WhiteListCheck(sql string, whiteList []string, opts ...Option) error