parser

Documentation

Index

• Variables
• type AST
• type ASTResult
• type ASTs
• type Database
  • func (d Database) String() string
• type Option
  • func WithDatabase(db Database) Option
• type 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
• type TableColumnList

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 *internal.AST

type ASTResult

type ASTResult *internal.ASTResult

type ASTs

type ASTs *internal.ASTs

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 *internal.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

type TableColumnList

type TableColumnList *internal.TableColumnList