superbasic

package module
v0.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 31, 2022 License: MIT Imports: 2 Imported by: 1

README

The superbasic SQL-Builder

go.dev reference Go Report Card golangci-lint codecov GitHub tag (latest SemVer)

This package compiles expressions and value-lists 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.

	insert := superbasic.SQL("INSERT INTO presidents (nr, first, last) VALUES ? RETURNING id",
		[][]any{
			{46, "Joe", "Biden"},
			{45, "Donald", "trump"},
			{44, "Barack", "Obama"},
			{43, "George W.", "Bush"},
			{42, "Bill", "Clinton"},
			{41, "George H. W.", "Bush"},
		},
	)

	fmt.Println(superbasic.ToPositional("$", insert))
	// INSERT INTO presidents (nr, first, last) VALUES
	// 		($1, $2, $3), ($4, $5, $6), ($7, $8, $9), ($10, $11, $12), ($13, $14, $15), ($16, $17, $18)
	//		RETURNING id
	// [46 Joe Biden 45 Donald trump 44 Barack Obama 43 George W. Bush 42 Bill Clinton 41 George H. W. Bush]
Compile Expressions into SQL

Similarly, expressions can be compiled in place of placeholders, which offers many new possibilities to create prepared statements. Some helper functions can be used, but my favorite is to write raw sql at any time.

	update := superbasic.SQL("UPDATE presidents SET ? WHERE ?",
		superbasic.Join(", ",
			superbasic.EqualsIdent("first", "Donald"),
			superbasic.SQL("last = ?", "Trump"),
		),
		superbasic.SQL("nr = ?", 45),
	)

	fmt.Println(update.ToSQL())
	// UPDATE presidents SET first = ?, last = ? WHERE nr = ?
	// [Donald Trump 45]
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.

	columns := []string{"nr", "first", "last"}

	where := superbasic.Or(
		superbasic.EqualsIdent("last", "Bush"),
		superbasic.SQL("nr >= ?", 45),
	)

	query := superbasic.Join(" ",
		superbasic.SQL("SELECT"),
		superbasic.IfElse(len(columns) > 0, superbasic.SQL(strings.Join(columns, ", ")), superbasic.SQL("*")),
		superbasic.SQL("FROM presidents"),
		superbasic.If(where != nil, superbasic.SQL("WHERE ?", where)),
		superbasic.SQL(fmt.Sprintf("ORDER BY %s", "nr")),
		superbasic.SQL(fmt.Sprintf("LIMIT %d", 3)),
	)

	fmt.Println(query.ToSQL())
	// SELECT nr, first, last FROM presidents WHERE (last = ? OR nr >= ?) ORDER BY nr LIMIT 3
	// [Bush 44]

Of course you can do the same with an ordinary Select Builder.

	select_builder := &superbasic.SelectBuilder{}

	if len(columns) > 0 {
		select_builder.Select(strings.Join(columns, ", "))
	}

	select_builder.From("presidents")

	if where != nil {
		select_builder.WhereExpr(where)
	}

	select_builder.OrderBy("nr").Limit(3)

	fmt.Println(select_builder.ToSQL())
	// SELECT nr, first, last FROM presidents WHERE (last = ? OR nr >= ?) ORDER BY nr LIMIT 3
	// [Bush 44]
Insert Builder

Additionally, there are other query builders (Insert, Update, Delete) that can be used to create prepared statements.

	insert_builder := superbasic.Insert("presidents").
		Columns("nr", "first", "last").
		Values(46, "Joe", "Biden").
		Values(45, "Donald", "trump").
		Values(44, "Barack", "Obama").
		Values(43, "George W.", "Bush").
		Values(42, "Bill", "Clinton").
		Values(41, "George H. W.", "Bush")

	fmt.Println(superbasic.Join(" ", insert_builder, superbasic.SQL("RETURNING id")).ToSQL())
	// INSERT INTO presidents (nr, first, last) VALUES
	// 		(?, ?, ?), (?, ?, ?), (?, ?, ?), (?, ?, ?), (?, ?, ?), (?, ?, ?) RETURNING id
	// [46 Joe Biden 45 Donald trump 44 Barack Obama 43 George W. Bush 42 Bill Clinton 41 George H. W. Bush]

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ToPositional added in v0.0.11 

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

Types

type DeleteBuilder added in v0.0.14 

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

func Delete added in v0.0.3 

func Delete(from string) *DeleteBuilder

func (*DeleteBuilder) ToSQL added in v0.0.14 

func (db *DeleteBuilder) ToSQL() (string, []any, error)

func (*DeleteBuilder) Where added in v0.0.14 

func (db *DeleteBuilder) Where(sql string, args ...any) *DeleteBuilder

func (*DeleteBuilder) WhereExpr added in v0.1.1 

func (db *DeleteBuilder) WhereExpr(expr Expression) *DeleteBuilder

type Expression 

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

Expression represents a prepared statement.

func And added in v0.0.6 

func And(expr ...Expression) Expression

And returns a AND expression.

func Append 

func Append(expressions ...Expression) Expression

Append expressions.

func Between added in v0.0.12 

func Between(expr, lower, higher any) Expression

Between returns a BETWEEN expression.

func BetweenIdent added in v0.0.13 

func BetweenIdent(ident string, lower, higher any) Expression

BetweenIdent returns a BETWEEN expression.

func Cast added in v0.0.12 

func Cast(expr any, as string) Expression

Cast returns a CAST expression.

func CastIdent added in v0.0.13 

func CastIdent(ident string, as string) Expression

CastIdent returns a CAST expression.

func Equals added in v0.0.6 

func Equals(left, right any) Expression

Equals returns an expression with an '=' sign.

func EqualsIdent added in v0.0.13 

func EqualsIdent(ident string, value any) Expression

EqualsIdent returns an expression with an '=' sign.

func Greater added in v0.0.6 

func Greater(left, right any) Expression

Greater returns an expression with an '>' sign.

func GreaterIdent added in v0.0.13 

func GreaterIdent(ident string, value any) Expression

GreaterIdent returns an expression with an '>' sign.

func GreaterOrEquals added in v0.0.6 

func GreaterOrEquals(left, right any) Expression

GreaterOrEquals returns an expression with an '>=' sign.

func GreaterOrEqualsIdent added in v0.0.13 

func GreaterOrEqualsIdent(ident string, value any) Expression

GreaterOrEqualsIdent returns an expression with an '>=' sign.

func If 

func If(condition bool, then any) Expression

If returns an expression based on a condition. If false an empty expression is returned.

func IfElse added in v0.0.4 

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

IfElse returns an expression based on a condition.

func In added in v0.0.10 

func In(left, right any) Expression

In returns a IN expression.

func InIdent added in v0.0.13 

func InIdent(ident string, value any) Expression

InIdent returns a IN expression.

func IsNotNull added in v0.0.12 

func IsNotNull(expr any) Expression

IsNotNull returns a IS NOT NULL expression.

func IsNotNullIdent added in v0.0.13 

func IsNotNullIdent(ident string) Expression

IsNotNullIdent returns a IS NOT NULL expression.

func IsNull added in v0.0.12 

func IsNull(expr any) Expression

IsNull returns a IS NULL expression.

func IsNullIdent added in v0.0.13 

func IsNullIdent(ident string) Expression

IsNullIdent returns a IS NULL expression.

func Join 

func Join(sep string, expressions ...Expression) Expression

Join joins expressions by a separator.

func Less added in v0.0.6 

func Less(left, right any) Expression

Less returns an expression with an '<' sign.

func LessIdent added in v0.0.13 

func LessIdent(ident string, value any) Expression

LessIdent returns an expression with an '<' sign.

func LessOrEquals added in v0.0.6 

func LessOrEquals(left, right any) Expression

LessOrEquals returns an expression with an '<=' sign.

func LessOrEqualsIdent added in v0.0.13 

func LessOrEqualsIdent(ident string, value any) Expression

LessOrEqualsIdent returns an expression with an '<=' sign.

func Like added in v0.0.12 

func Like(left, right any) Expression

Like returns a LIKE expression.

func LikeIdent added in v0.0.13 

func LikeIdent(ident string, value any) Expression

LikeIdent returns a LIKE expression.

func Not added in v0.0.6 

func Not(expr Expression) Expression

Not returns a NOT expression.

func NotBetween added in v0.0.12 

func NotBetween(expr, lower, higher any) Expression

NotBetween returns a NOT BETWEEN expression.

func NotBetweenIdent added in v0.0.13 

func NotBetweenIdent(ident string, lower, higher any) Expression

NotBetweenIdent returns a NOT BETWEEN expression.

func NotEquals added in v0.0.6 

func NotEquals(left, right any) Expression

NotEquals returns an expression with an '<>' sign.

func NotEqualsIdent added in v0.0.13 

func NotEqualsIdent(ident string, value any) Expression

NotEqualsIdent returns an expression with an '<>' sign.

func NotIn added in v0.0.12 

func NotIn(left, right any) Expression

NotIn returns a NOT IN expression.

func NotInIdent added in v0.0.13 

func NotInIdent(ident string, value any) Expression

NotInIdent returns a NOT IN expression.

func NotLike added in v0.0.12 

func NotLike(left, right any) Expression

NotLike returns a NOT LIKE expression.

func NotLikeIdent added in v0.0.13 

func NotLikeIdent(ident string, value any) Expression

NotLikeIdent returns a LIKE expression.

func Or added in v0.0.6 

func Or(left, right Expression) Expression

Or returns a OR expression.

func SQL 

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

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

func Values added in v0.0.3 

func Values(values ...any) Expression

type ExpressionError added in v0.0.11 

type ExpressionError struct{}

ExpressionError is returned if expressions are nil.

func (ExpressionError) Error added in v0.0.11 

func (e ExpressionError) Error() string

func (ExpressionError) ToSQL added in v0.0.11 

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

type InsertBuilder added in v0.0.14 

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

func Insert added in v0.0.3 

func Insert(into string) *InsertBuilder

func (*InsertBuilder) Columns added in v0.0.14 

func (ib *InsertBuilder) Columns(columns ...string) *InsertBuilder

func (*InsertBuilder) ToSQL added in v0.0.14 

func (ib *InsertBuilder) ToSQL() (string, []any, error)

func (*InsertBuilder) Values added in v0.1.1 

func (ib *InsertBuilder) Values(values ...any) *InsertBuilder

type NumberOfArgumentsError added in v0.0.11 

type NumberOfArgumentsError struct{}

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

func (NumberOfArgumentsError) Error added in v0.0.11 

func (e NumberOfArgumentsError) Error() string

func (NumberOfArgumentsError) ToSQL added in v0.0.11 

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

type SelectBuilder added in v0.0.14 

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

func Select added in v0.0.3 

func Select(sql string, args ...any) *SelectBuilder

func SelectExpr added in v0.1.1 

func SelectExpr(expr Expression) *SelectBuilder

func (*SelectBuilder) From added in v0.0.14 

func (sb *SelectBuilder) From(sql string, args ...any) *SelectBuilder

func (*SelectBuilder) FromExpr added in v0.1.1 

func (sb *SelectBuilder) FromExpr(expr Expression) *SelectBuilder

func (*SelectBuilder) GroupBy added in v0.0.14 

func (sb *SelectBuilder) GroupBy(sql string, args ...any) *SelectBuilder

func (*SelectBuilder) GroupByExpr added in v0.1.1 

func (sb *SelectBuilder) GroupByExpr(expr Expression) *SelectBuilder

func (*SelectBuilder) Having added in v0.0.14 

func (sb *SelectBuilder) Having(sql string, args ...any) *SelectBuilder

func (*SelectBuilder) HavingExpr added in v0.1.1 

func (sb *SelectBuilder) HavingExpr(expr Expression) *SelectBuilder

func (*SelectBuilder) Limit added in v0.0.14 

func (sb *SelectBuilder) Limit(limit uint64) *SelectBuilder

func (*SelectBuilder) Offset added in v0.0.14 

func (sb *SelectBuilder) Offset(offset uint64) *SelectBuilder

func (*SelectBuilder) OrderBy added in v0.0.14 

func (sb *SelectBuilder) OrderBy(sql string, args ...any) *SelectBuilder

func (*SelectBuilder) OrderByExpr added in v0.1.1 

func (sb *SelectBuilder) OrderByExpr(expr Expression) *SelectBuilder

func (*SelectBuilder) Select added in v0.1.1 

func (sb *SelectBuilder) Select(sql string, args ...any) *SelectBuilder

func (*SelectBuilder) SelectExpr added in v0.1.1 

func (sb *SelectBuilder) SelectExpr(expr Expression) *SelectBuilder

func (*SelectBuilder) ToSQL added in v0.0.14 

func (sb *SelectBuilder) ToSQL() (string, []any, error)

func (*SelectBuilder) Where added in v0.0.14 

func (sb *SelectBuilder) Where(sql string, args ...any) *SelectBuilder

func (*SelectBuilder) WhereExpr added in v0.1.1 

func (sb *SelectBuilder) WhereExpr(expr Expression) *SelectBuilder

type UpdateBuilder added in v0.0.14 

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

func Update added in v0.0.3 

func Update(table string) *UpdateBuilder

func (*UpdateBuilder) Set added in v0.1.1 

func (ub *UpdateBuilder) Set(sql string, args ...any) *UpdateBuilder

func (*UpdateBuilder) SetExpr added in v0.1.1 

func (ub *UpdateBuilder) SetExpr(set Expression) *UpdateBuilder

func (*UpdateBuilder) ToSQL added in v0.0.14 

func (ub *UpdateBuilder) ToSQL() (string, []any, error)

func (*UpdateBuilder) Where added in v0.0.14 

func (ub *UpdateBuilder) Where(sql string, args ...any) *UpdateBuilder

func (*UpdateBuilder) WhereExpr added in v0.1.1 

func (ub *UpdateBuilder) WhereExpr(expr Expression) *UpdateBuilder

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.