vtab

Documentation

Index

• func NewTableFunc(name string, columns []Column, newIterator GetIteratorFunc, opts ...OptFunc) sqlite.Module
• type Column
• type ColumnFilter
• type Constraint
• type Context
• type GetIteratorFunc
• type Iterator
• type OptFunc
  • func EarlyOrderByConstraintExit(value bool) OptFunc
• type Orders
• type Row

Functions

func NewTableFunc

func NewTableFunc(name string, columns []Column, newIterator GetIteratorFunc, opts ...OptFunc) sqlite.Module

Types

type Column

type Column struct {
	Name    string
	Type    string
	NotNull bool
	Hidden  bool
	Filters []*ColumnFilter
	OrderBy Orders
}

type ColumnFilter

type ColumnFilter struct {
	Op        sqlite.ConstraintOp
	OmitCheck bool
}

type Constraint

type Constraint struct {
	ColIndex int
	Op       sqlite.ConstraintOp
	Value    *sqlite.Value
}

type Context

type Context interface {
	ResultInt(v int)
	ResultInt64(v int64)
	ResultFloat(v float64)
	ResultNull()
	ResultValue(v sqlite.Value)
	ResultZeroBlob(n int64)
	ResultText(v string)
	ResultError(err error)
	ResultPointer(val interface{})
}

type GetIteratorFunc

type GetIteratorFunc func(constraints []*Constraint, order []*sqlite.OrderBy) (Iterator, error)

type Iterator

type Iterator interface {
	Next() (Row, error)
}

type OptFunc

type OptFunc func(*options)

func EarlyOrderByConstraintExit

func EarlyOrderByConstraintExit(value bool) OptFunc

EarlyOrderByConstraintExit tells the table-func to end iteration early, if results are ordered by a field that is also in a WHERE clause with one of a >,>=,<,<= that would warrant an early exit. This assumes that the column in question has the GT, GE, LT, LE constraints registered.

type Orders

type Orders uint8

const (
	NONE Orders = iota
	DESC
	ASC
)

type Row

type Row interface {
	Column(ctx Context, col int) error
}