sq

Documentation

Index

• func Arg(name string) litsql.Argument
• func ArgDefault(name string, defaultValue any) litsql.Argument
• func ArgFunc(fn func() (any, error)) litsql.Argument
• func Build(q litsql.Query, writerOptions ...WriterOption) (string, []any, error)
• func DBArg(name string) litsql.Argument
• func NewWriter(w io.Writer, options ...WriterOption) litsql.Writer
• func ParseArgs(args []any, values ...ArgValues) ([]any, error)
• type ArgValues
• type BuildQuery
• type Builder
  • func NewQueryBuilder(d litsql.Dialect) *Builder
  • func (s *Builder) Add(q litsql.QueryClause)
  • func (s *Builder) ClauseList() []litsql.QueryClause
  • func (s *Builder) Dialect() litsql.Dialect
• type MapArgValues
  • func (m MapArgValues) Get(s string) (any, bool)
• type Mod
• type ModTag
• type ModTagImpl
• type Query
• type QueryMod
  • func QueryModFunc[T any](f func(apply litsql.QueryBuilder)) QueryMod[T]
• type QueryModApply
• type WriterOption
  • func WithWriterIndentStr(indentStr string) WriterOption
  • func WithWriterUseNewLine(useNewLine bool) WriterOption

Functions

func Arg

func Arg(name string) litsql.Argument

Arg adds a named argument.

func ArgDefault

func ArgDefault(name string, defaultValue any) litsql.Argument

ArgDefault adds a named argument with a default value.

func ArgFunc

func ArgFunc(fn func() (any, error)) litsql.Argument

ArgFunc returns the argument value in a callback.

func Build

func Build(q litsql.Query, writerOptions ...WriterOption) (string, []any, error)

func DBArg

func DBArg(name string) litsql.Argument

DBArg adds a DB named argument.

func NewWriter

func NewWriter(w io.Writer, options ...WriterOption) litsql.Writer

func ParseArgs

func ParseArgs(args []any, values ...ArgValues) ([]any, error)

ParseArgs replaces all litsql.Argument instances in args with named values.

Types

type ArgValues

type ArgValues interface {
	Get(string) (any, bool)
}

ArgValues is the supplier of values for named arguments.

type BuildQuery

type BuildQuery interface {
	Build(writerOptions ...WriterOption) (string, []any, error)
}

type Builder

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

func NewQueryBuilder

func NewQueryBuilder(d litsql.Dialect) *Builder

func (*Builder) Add

func (s *Builder) Add(q litsql.QueryClause)

func (*Builder) ClauseList

func (s *Builder) ClauseList() []litsql.QueryClause

func (*Builder) Dialect

func (s *Builder) Dialect() litsql.Dialect

type MapArgValues

type MapArgValues map[string]any

MapArgValues is an ArgValues backed from a map[string]any.

func (MapArgValues) Get

func (m MapArgValues) Get(s string) (any, bool)

type Mod

type Mod[T, A any] interface {
	ModTag[T]
	Apply(A)
}

type ModTag

type ModTag[T any] interface {
	// contains filtered or unexported methods
}

type ModTagImpl

type ModTagImpl[T any] struct {
}

type Query

type Query[T any] interface {
	litsql.QueryBuilder
	litsql.Query
	QueryModApply[T]
	BuildQuery
}

type QueryMod

type QueryMod[T any] interface {
	ModTag[T]
	Apply(qb litsql.QueryBuilder)
}

func QueryModFunc

func QueryModFunc[T any](f func(apply litsql.QueryBuilder)) QueryMod[T]

type QueryModApply

type QueryModApply[T any] interface {
	Apply(...QueryMod[T])
}

type WriterOption

type WriterOption func(*writer)

func WithWriterIndentStr

func WithWriterIndentStr(indentStr string) WriterOption

func WithWriterUseNewLine

func WithWriterUseNewLine(useNewLine bool) WriterOption