compiler

Documentation

Overview

Package compiler provides compiler implementations for compiling an (*ast.SQLStmt) into a (command.Command), which then can be executed by an (executor.Executor).

Index

• type Compiler
  • func New(opts ...Option) Compiler
• type Error
  • func (e Error) Error() string
• type Option

Types

type Compiler

type Compiler interface {
	// Compile compiles an SQLStmt to a command, which can be used by an
	// executor. If an error occurs during the compiling, it will be returned.
	// If such an error is not fatal to the compile process and there occur more
	// errors, the returned error will contain all occurred errors until a fatal
	// error.
	Compile(*ast.SQLStmt) (command.Command, error)
}

Compiler describes a component that is able to convert an (*ast.SQLStmt) to a (command.Command).

func New

func New(opts ...Option) Compiler

New creates a new, ready to use compiler with the given options applied.

type Error

type Error string

Error is a helper type for creating constant errors.

const (
	// ErrUnsupported indicates that something is not supported. What exactly is
	// unsupported, must be indicated by a wrapping error.
	ErrUnsupported Error = "unsupported"
)

func (Error) Error

func (e Error) Error() string

type Option

type Option func(*simpleCompiler)

Option is a functional option that can be applied to a compiler. If the option is applicable to the compiler, is determined by the compiler itself.