duckdbsql

Documentation

Index

• type AST
  • func Parse(sql string) (*AST, error)
  • func (a *AST) ExtractAnnotations() map[string]*Annotation
  • func (a *AST) ExtractColumnRefs() []*ColumnRef
  • func (a *AST) Format() (string, error)
  • func (a *AST) RewriteLimit(limit, offset int) error
  • func (a *AST) RewriteTableRefs(fn func(table *TableRef) (*TableRef, bool)) error
• type Annotation
• type ColumnRef
• type TableRef

Types

type AST

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

func Parse

func Parse(sql string) (*AST, error)

func (*AST) ExtractAnnotations

func (a *AST) ExtractAnnotations() map[string]*Annotation

ExtractAnnotations extracts annotations from comments prefixed with '@', and optionally a value after a ':'. Examples: "-- @materialize" and "-- @materialize: true".

func (*AST) ExtractColumnRefs

func (a *AST) ExtractColumnRefs() []*ColumnRef

ExtractColumnRefs extracts column references from the outermost SELECT of a DuckDB SQL statement

func (*AST) Format

func (a *AST) Format() (string, error)

Format normalizes a DuckDB SQL statement

func (*AST) RewriteLimit

func (a *AST) RewriteLimit(limit, offset int) error

RewriteLimit rewrites a DuckDB SQL statement to limit the result size

func (*AST) RewriteTableRefs

func (a *AST) RewriteTableRefs(fn func(table *TableRef) (*TableRef, bool)) error

RewriteTableRefs replaces table references in a DuckDB SQL query. Only replacing with a base table reference is supported right now.

type Annotation

type Annotation struct {
	Key   string
	Value string
}

Annotation is key-value annotation extracted from a DuckDB SQL comment

type ColumnRef

type ColumnRef struct {
	Name         string
	RelationName string
	Expr         string
	IsAggr       bool
	IsStar       bool
	IsExclude    bool
}

ColumnRef has information about a column in the select list of a DuckDB SQL statement

type TableRef

type TableRef struct {
	Name       string
	Function   string
	Path       string
	Properties map[string]any
	LocalAlias bool
}

TableRef has information extracted about a DuckDB table or table function reference