sq

Documentation

Index

• func ArgFunc(fn func() (any, error)) litsql.Argument
• func Build(q litsql.Query, options ...BuildOption) (string, []any, error)
• func DBNamedArg(name string, options ...ArgOption) litsql.Argument
• func NamedArg(name string, options ...ArgOption) litsql.Argument
• func NewWriter(w io.Writer, options ...WriterOption) litsql.Writer
• func ParseArgs(args []any, values litsql.ArgValues) ([]any, error)
• type ArgOption
  • func WithDefaultValue(defaultValue any) ArgOption
• type BuildOption
  • func WithParseArgs(argValues litsql.ArgValues) BuildOption
  • func WithWriterOptions(writerOptions ...WriterOption) BuildOption
• type BuildQuery
• type Handler
  • func NewHandler(options ...HandlerOption) Handler
• type HandlerOption
  • func WithDefaultBuildOptions(options ...BuildOption) HandlerOption
• type MapArgValues
  • func (m MapArgValues) Get(s string) (any, bool, error)
• 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 WithIndentString(indentString string) WriterOption
  • func WithUseNewLine(useNewLine bool) WriterOption

Functions

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, options ...BuildOption) (string, []any, error)

Build builds a query string and its arguments.

func DBNamedArg

func DBNamedArg(name string, options ...ArgOption) litsql.Argument

DBNamedArg adds a DB-native named argument (for databases that support it). The end value will be wrapped in [sql.Named].

func NamedArg

func NamedArg(name string, options ...ArgOption) litsql.Argument

NamedArg adds a named argument for replacement with ParseArgs.

func NewWriter

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

NewWriter creates the default implementation if litsql.Writer.

func ParseArgs

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

ParseArgs replaces all litsql.Argument instances in args with named values. Use litsql.MapArgValues to use a "map[string]any" as source.

Types

type ArgOption

type ArgOption func(options *argOptions)

func WithDefaultValue

func WithDefaultValue(defaultValue any) ArgOption

WithDefaultValue sets a default value if the argument name was not passed.

type BuildOption

type BuildOption = internal.BuildQueryOption

func WithParseArgs

func WithParseArgs(argValues litsql.ArgValues) BuildOption

WithParseArgs adds named argument values.

func WithWriterOptions

func WithWriterOptions(writerOptions ...WriterOption) BuildOption

WithWriterOptions adds writer options.

type BuildQuery

type BuildQuery interface {
	Build(options ...BuildOption) (string, []any, error)
}

BuildQuery builds query strings and arguments.

type Handler

type Handler interface {
	Build(q litsql.Query, options ...BuildOption) (string, []any, error)
	ParseArgs(args []any, values litsql.ArgValues) ([]any, error)
}

Handler bundles default parameters for functions.

func NewHandler

func NewHandler(options ...HandlerOption) Handler

type HandlerOption

type HandlerOption func(h *handler)

func WithDefaultBuildOptions

func WithDefaultBuildOptions(options ...BuildOption) HandlerOption

WithDefaultBuildOptions sets default options for [Handler.Build].

type MapArgValues

type MapArgValues map[string]any

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

func (MapArgValues) Get

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

type Mod

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

Mod is a mod for a generic type.

type ModTag

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

ModTag is used just for interface tagging, so implementations for each dialect aren't accept on others.

type ModTagImpl

type ModTagImpl[T any] struct {
}

type Query

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

Query is the interface for base queries.

type QueryMod

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

QueryMod is a mod for 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 = internal.WriterOption

func WithIndentString

func WithIndentString(indentString string) WriterOption

WithIndentString sets the indent string (used only if WithUseNewLine is true). Default is " " (two spaces).

func WithUseNewLine

func WithUseNewLine(useNewLine bool) WriterOption

WithUseNewLine sets whether to use newlines in the output or not. Default is true.