superbasic

README

The superbasic SQL-Builder

This package compiles expressions into SQL strings and thus offers an alternative to conventional query builders.

Compile Values into SQL

In this example, a list of values is compiled into an SQL string. https://github.com/wroge/superbasic/blob/5daab8f309f59becbe89872659894345e5976221/example/main.go#L11-L26

Compile Expressions into SQL

Similarly, expressions can be compiled in place of placeholders, which offers many new possibilities to create prepared statements.

https://github.com/wroge/superbasic/blob/5daab8f309f59becbe89872659894345e5976221/example/main.go#L28-L38

Queries

With this library it is particularly easy to create dynamic queries based on conditions. In this example, the WHERE-clause is only included if a corresponding expression exists.

https://github.com/wroge/superbasic/blob/5daab8f309f59becbe89872659894345e5976221/example/main.go#L40-L52

Of course you can do the same with this Query.

https://github.com/wroge/superbasic/blob/5daab8f309f59becbe89872659894345e5976221/example/main.go#L54-L62

Insert, Update, Delete

Additionally, there are Insert, Update and Delete helpers that can be used to create prepared statements.

https://github.com/wroge/superbasic/blob/5daab8f309f59becbe89872659894345e5976221/example/main.go#L64-L80

Documentation

Index

• func ToPositional(placeholder string, expr Expression) (string, []any, error)
• type Append
  • func (b Append) ToSQL() (string, []any, error)
• type Builder
  • func Build() *Builder
  • func (b *Builder) Append(expressions ...Expression) *Builder
  • func (b *Builder) If(condition bool, then Expression) *Builder
  • func (b *Builder) IfElse(condition bool, then Expression, els Expression) *Builder
  • func (b *Builder) Join(sep string, expressions ...Expression) *Builder
  • func (b *Builder) SQL(sql string, args ...any) *Builder
  • func (b *Builder) Space() *Builder
  • func (b *Builder) ToSQL() (string, []any, error)
• type Delete
  • func (d Delete) ToSQL() (string, []any, error)
• type Expression
  • func If(condition bool, then Expression) Expression
  • func IfElse(condition bool, then, els Expression) Expression
• type ExpressionError
  • func (e ExpressionError) Error() string
  • func (e ExpressionError) Unwrap() error
• type Insert
  • func (i Insert) ToSQL() (string, []any, error)
• type Join
  • func (j Join) ToSQL() (string, []any, error)
• type NumberOfArgumentsError
  • func (e NumberOfArgumentsError) Error() string
• type Query
  • func (q Query) ToSQL() (string, []any, error)
• type Raw
  • func SQL(sql string, expressions ...any) Raw
  • func (e Raw) ToSQL() (string, []any, error)
• type Update
  • func (u Update) ToSQL() (string, []any, error)
• type Values
  • func (v Values) ToSQL() (string, []any, error)

Functions

func ToPositional

func ToPositional(placeholder string, expr Expression) (string, []any, error)

Types

type Append

type Append []Expression

func (Append) ToSQL

func (b Append) ToSQL() (string, []any, error)

type Builder

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

func Build

func Build() *Builder

func (*Builder) Append

func (b *Builder) Append(expressions ...Expression) *Builder

func (*Builder) If

func (b *Builder) If(condition bool, then Expression) *Builder

func (*Builder) IfElse

func (b *Builder) IfElse(condition bool, then Expression, els Expression) *Builder

func (*Builder) Join

func (b *Builder) Join(sep string, expressions ...Expression) *Builder

func (*Builder) SQL

func (b *Builder) SQL(sql string, args ...any) *Builder

func (*Builder) Space

func (b *Builder) Space() *Builder

func (*Builder) ToSQL

func (b *Builder) ToSQL() (string, []any, error)

type Delete

type Delete struct {
	From  string
	Where Expression
}

func (Delete) ToSQL

func (d Delete) ToSQL() (string, []any, error)

type Expression

type Expression interface {
	ToSQL() (string, []any, error)
}

func If

func If(condition bool, then Expression) Expression

func IfElse

func IfElse(condition bool, then, els Expression) Expression

type ExpressionError

type ExpressionError struct {
	Err error
}

ExpressionError is returned if expressions are nil.

func (ExpressionError) Error

func (e ExpressionError) Error() string

func (ExpressionError) Unwrap

func (e ExpressionError) Unwrap() error

type Insert

type Insert struct {
	Into    string
	Columns []string
	Data    []Values
}

func (Insert) ToSQL

func (i Insert) ToSQL() (string, []any, error)

type Join

type Join struct {
	Sep         string
	Expressions []Expression
}

func (Join) ToSQL

func (j Join) ToSQL() (string, []any, error)

type NumberOfArgumentsError

type NumberOfArgumentsError struct {
	Got, Want int
}

NumberOfArgumentsError is returned if arguments doesn't match the number of placeholders.

func (NumberOfArgumentsError) Error

func (e NumberOfArgumentsError) Error() string

type Query

type Query struct {
	With    Expression
	Select  Expression
	From    Expression
	Where   Expression
	GroupBy Expression
	Having  Expression
	Window  Expression
	OrderBy Expression
	Limit   uint64
	Offset  uint64
}

func (Query) ToSQL

func (q Query) ToSQL() (string, []any, error)

type Raw

type Raw struct {
	SQL  string
	Args []any
	Err  error
}

func SQL

func SQL(sql string, expressions ...any) Raw

SQL takes b template with placeholders into which expressions can be compiled. []Expression is compiled to Join(", ", expr...). Escape '?' by using '??'.

func (Raw) ToSQL

func (e Raw) ToSQL() (string, []any, error)

type Update

type Update struct {
	Table string
	Sets  []Expression
	Where Expression
}

func (Update) ToSQL

func (u Update) ToSQL() (string, []any, error)

type Values

type Values []any

func (Values) ToSQL

func (v Values) ToSQL() (string, []any, error)