internal

Documentation

Index

• Constants
• func BuildQuery(q litsql.Query, options ...BuildQueryOption) (string, []any, error)
• func GetArgValuesInstance(values any, options ...GetArgValuesInstanceOption) (litsql.ArgValues, error)
• func MergeClauses[T litsql.QueryClause](clauses ...T) (T, error)
• func NewClauseError(f string, args ...any) error
• func NewClauseErrorInvalidMerge(clauseName string) error
• func NewClauseErrorInvalidMergeCannotHaveMultiple(clauseName string) error
• func NewClauseErrorInvalidMergeHasChanges(clauseName string) error
• func NewClauseErrorWrap(err error) error
• func NewWriter(w io.Writer, options ...WriterOption) litsql.Writer
• func ParseArgValues(args []any, values litsql.ArgValues) ([]any, error)
• func ParseArgs(args []any, values any, options ...GetArgValuesInstanceOption) ([]any, error)
• func ToAnySlice[T any, Ts ~[]T](slice Ts) []any
• type BuildQueryOption
  • func WithBuildQueryGetArgValuesInstanceOptions(options ...GetArgValuesInstanceOption) BuildQueryOption
  • func WithBuildQueryParseArgValues(argValues litsql.ArgValues) BuildQueryOption
  • func WithBuildQueryParseArgs(argValues any) BuildQueryOption
  • func WithBuildQueryWriterOptions(writerOptions ...WriterOption) BuildQueryOption
• type DBNamedArgument
  • func (a DBNamedArgument) DBName() string
• type DBNamedArgumentWithDefault
  • func (a DBNamedArgumentWithDefault) DBName() string
  • func (a DBNamedArgumentWithDefault) Value() (any, error)
• type FuncArgument
  • func (f FuncArgument) Value() (any, error)
• type GetArgValuesInstanceOption
  • func WithGetArgValuesInstanceOptionCustom(custom func(values any) (litsql.ArgValues, error)) GetArgValuesInstanceOption
• type NamedArgument
  • func (a NamedArgument) Name() string
• type NamedArgumentWithDefault
  • func (a NamedArgumentWithDefault) Name() string
  • func (a NamedArgumentWithDefault) Value() (any, error)
• type WriterIO
  • func WewWriterIO(w io.Writer) *WriterIO
  • func (w *WriterIO) Err() error
  • func (w *WriterIO) Write(s string)
• type WriterOption
  • func WithWriterIndentString(indentString string) WriterOption
  • func WithWriterUseNewLine(useNewLine bool) WriterOption

Constants

const (
	Space      = " "
	NewLine    = "\n"
	OpenPar    = "("
	ClosePar   = ")"
	Comma      = ","
	CommaSpace = ", "
)

Functions

func BuildQuery

func BuildQuery(q litsql.Query, options ...BuildQueryOption) (string, []any, error)

BuildQuery builds a query string and its arguments.

func GetArgValuesInstance

func GetArgValuesInstance(values any, options ...GetArgValuesInstanceOption) (litsql.ArgValues, error)

GetArgValuesInstance gets the litsql.ArgValues instance from the passed parameter.

func MergeClauses

func MergeClauses[T litsql.QueryClause](clauses ...T) (T, error)

MergeClauses merge all clauses into the first one in the list.

func NewClauseError

func NewClauseError(f string, args ...any) error

func NewClauseErrorInvalidMerge

func NewClauseErrorInvalidMerge(clauseName string) error

func NewClauseErrorInvalidMergeCannotHaveMultiple

func NewClauseErrorInvalidMergeCannotHaveMultiple(clauseName string) error

func NewClauseErrorInvalidMergeHasChanges

func NewClauseErrorInvalidMergeHasChanges(clauseName string) error

func NewClauseErrorWrap

func NewClauseErrorWrap(err error) error

func NewWriter

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

func ParseArgValues

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

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

func ParseArgs

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

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

func ToAnySlice

func ToAnySlice[T any, Ts ~[]T](slice Ts) []any

Types

type BuildQueryOption

type BuildQueryOption func(options *buildQueryOptions)

func WithBuildQueryGetArgValuesInstanceOptions

func WithBuildQueryGetArgValuesInstanceOptions(options ...GetArgValuesInstanceOption) BuildQueryOption

WithBuildQueryGetArgValuesInstanceOptions adds query parse args options.

func WithBuildQueryParseArgValues

func WithBuildQueryParseArgValues(argValues litsql.ArgValues) BuildQueryOption

WithBuildQueryParseArgValues adds named argument values.

func WithBuildQueryParseArgs

func WithBuildQueryParseArgs(argValues any) BuildQueryOption

WithBuildQueryParseArgs adds named argument values.

func WithBuildQueryWriterOptions

func WithBuildQueryWriterOptions(writerOptions ...WriterOption) BuildQueryOption

WithBuildQueryWriterOptions adds writer options.

type DBNamedArgument

type DBNamedArgument struct {
	litsql.ArgumentBase
	ArgName string
}

func (DBNamedArgument) DBName

func (a DBNamedArgument) DBName() string

type DBNamedArgumentWithDefault

type DBNamedArgumentWithDefault struct {
	litsql.ArgumentBase
	ArgName      string
	DefaultValue any
}

func (DBNamedArgumentWithDefault) DBName

func (a DBNamedArgumentWithDefault) DBName() string

func (DBNamedArgumentWithDefault) Value

func (a DBNamedArgumentWithDefault) Value() (any, error)

type FuncArgument

type FuncArgument struct {
	litsql.ArgumentBase
	FN func() (any, error)
}

func (FuncArgument) Value

func (f FuncArgument) Value() (any, error)

type GetArgValuesInstanceOption

type GetArgValuesInstanceOption func(*getArgValuesInstanceOptions)

func WithGetArgValuesInstanceOptionCustom

func WithGetArgValuesInstanceOptionCustom(custom func(values any) (litsql.ArgValues, error)) GetArgValuesInstanceOption

WithGetArgValuesInstanceOptionCustom adds a custom litsql.ArgValues detector.

type NamedArgument

type NamedArgument struct {
	litsql.ArgumentBase
	ArgName string
}

func (NamedArgument) Name

func (a NamedArgument) Name() string

type NamedArgumentWithDefault

type NamedArgumentWithDefault struct {
	litsql.ArgumentBase
	ArgName      string
	DefaultValue any
}

func (NamedArgumentWithDefault) Name

func (a NamedArgumentWithDefault) Name() string

func (NamedArgumentWithDefault) Value

func (a NamedArgumentWithDefault) Value() (any, error)

type WriterIO

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

func WewWriterIO

func WewWriterIO(w io.Writer) *WriterIO

func (*WriterIO) Err

func (w *WriterIO) Err() error

func (*WriterIO) Write

func (w *WriterIO) Write(s string)

type WriterOption

type WriterOption func(*writer)

func WithWriterIndentString

func WithWriterIndentString(indentString string) WriterOption

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

func WithWriterUseNewLine

func WithWriterUseNewLine(useNewLine bool) WriterOption

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