yqb

package
v0.0.0-...-7a30d57 Latest Latest
Warning

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

 Go to latest Published: Jan 8, 2024 License: MIT Imports: 14 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

View Source 
var (
	// Question is a PlaceholderFormat instance that leaves placeholders as
	// question marks.
	Question = questionFormat{}

	// Dollar is a PlaceholderFormat instance that replaces placeholders with
	// dollar-prefixed positional placeholders (e.g. $1, $2, $3).
	Dollar = dollarFormat{}

	// DollarP is a PlaceholderFormat instance that replaces placeholders with
	// dollar-prefixed positional placeholders (e.g. $p1, $p2, $p3).
	// DollarP use for YDB create DECLARE params.
	DollarP = dollarpFormat{}
)
View Source 
var RunnerNotQueryRunner = fmt.Errorf("cannot QueryRow; Runner is not a QueryRower")

RunnerNotQueryRunner is returned by QueryRow if the RunWith value doesn't implement QueryRower.

View Source 
var RunnerNotSet = fmt.Errorf("cannot run; no Runner set (RunWith)")

RunnerNotSet is returned by methods that need a Runner if it isn't set.

View Source 
var StatementBuilder = StatementBuilderType(builder.EmptyBuilder).PlaceholderFormat(DollarP)

StatementBuilder is a parent builder for other builders, e.g. SelectBuilder.

Functions

func Alias 

func Alias(expr Sqlizer, alias string) aliasExpr

Alias allows to define alias for column in SelectBuilder. Useful when column is defined as complex expression like IF or CASE Ex: 

.Column(Alias(caseStmt, "case_column"))

func ConcatExpr 

func ConcatExpr(parts ...any) concatExpr

ConcatExpr builds an expression by concatenating strings and other expressions.

Ex: 

name_expr := Expr("CONCAT(?, ' ', ?)", firstName, lastName)
ConcatExpr("COALESCE(full_name,", name_expr, ")")

func ExecWith 

func ExecWith(db Execer, s Sqlizer) (res sql.Result, err error)

ExecWith Execs the SQL returned by s with db.

func Placeholders 

func Placeholders(count int) string

Placeholders returns a string with count ? placeholders joined with commas.

func QueryWith 

func QueryWith(db Queryer, s Sqlizer) (rows *sql.Rows, err error)

QueryWith Querys the SQL returned by s with db.

Types

type And 

type And conj

And conjunction Sqlizers

func (And) ToSql 

func (a And) ToSql() (string, []any, error)

type BaseRunner 

type BaseRunner interface {
	Execer
	Queryer
}

BaseRunner groups the Execer and Queryer interfaces.

type CaseBuilder 

type CaseBuilder builder.Builder

CaseBuilder builds SQL CASE construct which could be used as parts of queries.

func Case 

func Case(what ...any) CaseBuilder

Case returns a new CaseBuilder "what" represents case value

func (CaseBuilder) Else 

func (b CaseBuilder) Else(expr any) CaseBuilder

What sets optional "ELSE ..." part for CASE construct

func (CaseBuilder) ToSql 

func (b CaseBuilder) ToSql() (string, []any, error)

ToSql builds the query into a SQL string and bound args.

func (CaseBuilder) When 

func (b CaseBuilder) When(when any, then any) CaseBuilder

When adds "WHEN ... THEN ..." part to CASE construct

type CreateBuilder 

type CreateBuilder builder.Builder

CreateBuilder builds SQL CREATE statements.

func Create 

func Create(table string) CreateBuilder

Create returns a new CreateBuilder with the given table name.

See CreateBuilder.Table.

func (CreateBuilder) Columns 

func (b CreateBuilder) Columns(columns ...string) CreateBuilder

Columns adds create columns to the query.

func (CreateBuilder) Exec 

func (b CreateBuilder) Exec() (sql.Result, error)

Exec builds and Execs the query with the Runner set by RunWith.

func (CreateBuilder) PlaceholderFormat 

func (b CreateBuilder) PlaceholderFormat(f PlaceholderFormat) CreateBuilder

PlaceholderFormat sets PlaceholderFormat (e.g. Question or Dollar) for the query.

func (CreateBuilder) Prefix 

func (b CreateBuilder) Prefix(sql string, args ...any) CreateBuilder

Prefix adds an expression to the beginning of the query

func (CreateBuilder) PrefixExpr 

func (b CreateBuilder) PrefixExpr(expr Sqlizer) CreateBuilder

PrefixExpr adds an expression to the very beginning of the query

func (CreateBuilder) PrimaryKey 

func (b CreateBuilder) PrimaryKey(sql string, args ...any) CreateBuilder

PrimaryKey adds an primary key to the query

func (CreateBuilder) PrimaryKeyExpr 

func (b CreateBuilder) PrimaryKeyExpr(expr Sqlizer) CreateBuilder

PrimaryKeyExpr adds an expression to the query

func (CreateBuilder) Query 

func (b CreateBuilder) Query() (*sql.Rows, error)

Query builds and Querys the query with the Runner set by RunWith.

func (CreateBuilder) RunWith 

func (b CreateBuilder) RunWith(runner BaseRunner) CreateBuilder

RunWith sets a Runner (like database/sql.DB) to be used with e.g. Exec.

func (CreateBuilder) SetMap 

func (b CreateBuilder) SetMap(clauses map[string]string) CreateBuilder

SetMap set columns and values for insert builder from a map of column name and value note that it will reset all previous columns and values was set if any

func (CreateBuilder) Suffix 

func (b CreateBuilder) Suffix(sql string, args ...any) CreateBuilder

Suffix adds an expression to the end of the query

func (CreateBuilder) SuffixExpr 

func (b CreateBuilder) SuffixExpr(expr Sqlizer) CreateBuilder

SuffixExpr adds an expression to the end of the query

func (CreateBuilder) Table 

func (b CreateBuilder) Table(table string) CreateBuilder

Table sets the TABLE clause of the query.

func (CreateBuilder) ToSql 

func (b CreateBuilder) ToSql() (string, []any, error)

ToSql builds the query into a SQL string and bound args.

func (CreateBuilder) ToYdbSql 

func (b CreateBuilder) ToYdbSql() (string, []table.ParameterOption, error)

ToYdbSql builds the query into a SQL string and bound args.

func (CreateBuilder) Types 

func (b CreateBuilder) Types(types ...string) CreateBuilder

Types adds create types to the query.

type DeleteBuilder 

type DeleteBuilder builder.Builder

DeleteBuilder builds SQL DELETE statements.

func Delete 

func Delete(from string) DeleteBuilder

Delete returns a new DeleteBuilder with the given table name.

See DeleteBuilder.Table.

func (DeleteBuilder) Exec 

func (b DeleteBuilder) Exec() (sql.Result, error)

Exec builds and Execs the query with the Runner set by RunWith.

func (DeleteBuilder) From 

func (b DeleteBuilder) From(from string) DeleteBuilder

From sets the table to be deleted from.

func (DeleteBuilder) Limit 

func (b DeleteBuilder) Limit(limit uint64) DeleteBuilder

Limit sets a LIMIT clause on the query.

func (DeleteBuilder) Offset 

func (b DeleteBuilder) Offset(offset uint64) DeleteBuilder

Offset sets a OFFSET clause on the query.

func (DeleteBuilder) OrderBy 

func (b DeleteBuilder) OrderBy(orderBys ...string) DeleteBuilder

OrderBy adds ORDER BY expressions to the query.

func (DeleteBuilder) PlaceholderFormat 

func (b DeleteBuilder) PlaceholderFormat(f PlaceholderFormat) DeleteBuilder

PlaceholderFormat sets PlaceholderFormat (e.g. Question or Dollar) for the query.

func (DeleteBuilder) Prefix 

func (b DeleteBuilder) Prefix(sql string, args ...any) DeleteBuilder

Prefix adds an expression to the beginning of the query

func (DeleteBuilder) PrefixExpr 

func (b DeleteBuilder) PrefixExpr(expr Sqlizer) DeleteBuilder

PrefixExpr adds an expression to the very beginning of the query

func (DeleteBuilder) Query 

func (b DeleteBuilder) Query() (*sql.Rows, error)

func (DeleteBuilder) RunWith 

func (b DeleteBuilder) RunWith(runner BaseRunner) DeleteBuilder

RunWith sets a Runner (like database/sql.DB) to be used with e.g. Exec.

func (DeleteBuilder) Suffix 

func (b DeleteBuilder) Suffix(sql string, args ...any) DeleteBuilder

Suffix adds an expression to the end of the query

func (DeleteBuilder) SuffixExpr 

func (b DeleteBuilder) SuffixExpr(expr Sqlizer) DeleteBuilder

SuffixExpr adds an expression to the end of the query

func (DeleteBuilder) ToSql 

func (b DeleteBuilder) ToSql() (string, []any, error)

ToSql builds the query into a SQL string and bound args.

func (DeleteBuilder) ToYdbSql 

func (b DeleteBuilder) ToYdbSql() (string, []table.ParameterOption, error)

ToYdbSql builds the query into a SQL string and bound args.

func (DeleteBuilder) Where 

func (b DeleteBuilder) Where(pred any, args ...any) DeleteBuilder

Where adds WHERE expressions to the query.

See SelectBuilder.Where for more information.

type DropBuilder 

type DropBuilder builder.Builder

DropBuilder builds SQL DROP statements.

func Drop 

func Drop(table string) DropBuilder

Drop returns a new DropBuilder with the given table name.

See DropBuilder.Table.

func (DropBuilder) Exec 

func (b DropBuilder) Exec() (sql.Result, error)

Exec builds and Execs the query with the Runner set by RunWith.

func (DropBuilder) PlaceholderFormat 

func (b DropBuilder) PlaceholderFormat(f PlaceholderFormat) DropBuilder

PlaceholderFormat sets PlaceholderFormat (e.g. Question or Dollar) for the query.

func (DropBuilder) Prefix 

func (b DropBuilder) Prefix(sql string, args ...any) DropBuilder

Prefix adds an expression to the beginning of the query

func (DropBuilder) PrefixExpr 

func (b DropBuilder) PrefixExpr(expr Sqlizer) DropBuilder

PrefixExpr adds an expression to the very beginning of the query

func (DropBuilder) Query 

func (b DropBuilder) Query() (*sql.Rows, error)

Query builds and Querys the query with the Runner set by RunWith.

func (DropBuilder) RunWith 

func (b DropBuilder) RunWith(runner BaseRunner) DropBuilder

RunWith sets a Runner (like database/sql.DB) to be used with e.g. Exec.

func (DropBuilder) Suffix 

func (b DropBuilder) Suffix(sql string, args ...any) DropBuilder

Suffix adds an expression to the end of the query

func (DropBuilder) SuffixExpr 

func (b DropBuilder) SuffixExpr(expr Sqlizer) DropBuilder

SuffixExpr adds an expression to the end of the query

func (DropBuilder) Table 

func (b DropBuilder) Table(table string) DropBuilder

Table sets the TABLE clause of the query.

func (DropBuilder) ToSql 

func (b DropBuilder) ToSql() (string, []any, error)

ToSql builds the query into a SQL string and bound args.

func (DropBuilder) ToYdbSql 

func (b DropBuilder) ToYdbSql() (string, []table.ParameterOption, error)

ToYdbSql builds the query into a SQL string and bound args.

type Eq 

type Eq map[string]any

Eq is syntactic sugar for use with Where/Having/Set methods.

Example 
Select("id", "created", "first_name").From("users").Where(Eq{
	"company": 20,
})

Output:

func (Eq) ToSql 

func (eq Eq) ToSql() (sql string, args []any, err error)

type Execer 

type Execer interface {
	Exec(query string, args ...any) (sql.Result, error)
}

Execer is the interface that wraps the Exec method.

Exec executes the given query as implemented by database/sql.Exec.

type Gt 

type Gt Lt

Gt is syntactic sugar for use with Where/Having/Set methods. Ex: 

.Where(Gt{"id": 1}) == "id > 1"

func (Gt) ToSql 

func (gt Gt) ToSql() (sql string, args []any, err error)

type GtOrEq 

type GtOrEq Lt

GtOrEq is syntactic sugar for use with Where/Having/Set methods. Ex: 

.Where(GtOrEq{"id": 1}) == "id >= 1"

func (GtOrEq) ToSql 

func (gtOrEq GtOrEq) ToSql() (sql string, args []any, err error)

type ILike 

type ILike Like

ILike is syntactic sugar for use with ILIKE conditions. Ex: 

.Where(ILike{"name": "sq%"})

func (ILike) ToSql 

func (ilk ILike) ToSql() (sql string, args []any, err error)

type InsertBuilder 

type InsertBuilder builder.Builder

InsertBuilder builds SQL INSERT statements.

func Insert 

func Insert(into string) InsertBuilder

Insert returns a new InsertBuilder with the given table name.

See InsertBuilder.Into.

func Replace 

func Replace(into string) InsertBuilder

Replace returns a new InsertBuilder with the statement keyword set to "REPLACE" and with the given table name.

See InsertBuilder.Into.

func (InsertBuilder) Columns 

func (b InsertBuilder) Columns(columns ...string) InsertBuilder

Columns adds insert columns to the query.

func (InsertBuilder) Exec 

func (b InsertBuilder) Exec() (sql.Result, error)

Exec builds and Execs the query with the Runner set by RunWith.

func (InsertBuilder) Into 

func (b InsertBuilder) Into(from string) InsertBuilder

Into sets the INTO clause of the query.

func (InsertBuilder) Options 

func (b InsertBuilder) Options(options ...string) InsertBuilder

Options adds keyword options before the INTO clause of the query.

func (InsertBuilder) PlaceholderFormat 

func (b InsertBuilder) PlaceholderFormat(f PlaceholderFormat) InsertBuilder

PlaceholderFormat sets PlaceholderFormat (e.g. Question or Dollar) for the query.

func (InsertBuilder) Prefix 

func (b InsertBuilder) Prefix(sql string, args ...any) InsertBuilder

Prefix adds an expression to the beginning of the query

func (InsertBuilder) PrefixExpr 

func (b InsertBuilder) PrefixExpr(expr Sqlizer) InsertBuilder

PrefixExpr adds an expression to the very beginning of the query

func (InsertBuilder) Query 

func (b InsertBuilder) Query() (*sql.Rows, error)

Query builds and Querys the query with the Runner set by RunWith.

func (InsertBuilder) QueryRow 

func (b InsertBuilder) QueryRow() RowScanner

QueryRow builds and QueryRows the query with the Runner set by RunWith.

func (InsertBuilder) RunWith 

func (b InsertBuilder) RunWith(runner BaseRunner) InsertBuilder

RunWith sets a Runner (like database/sql.DB) to be used with e.g. Exec.

func (InsertBuilder) Scan 

func (b InsertBuilder) Scan(dest ...any) error

Scan is a shortcut for QueryRow().Scan.

func (InsertBuilder) Select 

func (b InsertBuilder) Select(sb SelectBuilder) InsertBuilder

Select set Select clause for insert query If Values and Select are used, then Select has higher priority

func (InsertBuilder) SetMap 

func (b InsertBuilder) SetMap(clauses map[string]any) InsertBuilder

SetMap set columns and values for insert builder from a map of column name and value note that it will reset all previous columns and values was set if any

func (InsertBuilder) Suffix 

func (b InsertBuilder) Suffix(sql string, args ...any) InsertBuilder

Suffix adds an expression to the end of the query

func (InsertBuilder) SuffixExpr 

func (b InsertBuilder) SuffixExpr(expr Sqlizer) InsertBuilder

SuffixExpr adds an expression to the end of the query

func (InsertBuilder) ToSql 

func (b InsertBuilder) ToSql() (string, []any, error)

ToSql builds the query into a SQL string and bound args.

func (InsertBuilder) ToYdbSql 

func (b InsertBuilder) ToYdbSql() (string, []table.ParameterOption, error)

ToYdbSql builds the query into a SQL string and bound args.

func (InsertBuilder) Values 

func (b InsertBuilder) Values(values ...any) InsertBuilder

Values adds a single row's values to the query.

type Like 

type Like map[string]any

Like is syntactic sugar for use with LIKE conditions. Ex: 

.Where(Like{"name": "%irrel"})

func (Like) ToSql 

func (lk Like) ToSql() (sql string, args []any, err error)

type Lt 

type Lt map[string]any

Lt is syntactic sugar for use with Where/Having/Set methods. Ex: 

.Where(Lt{"id": 1})

func (Lt) ToSql 

func (lt Lt) ToSql() (sql string, args []any, err error)

type LtOrEq 

type LtOrEq Lt

LtOrEq is syntactic sugar for use with Where/Having/Set methods. Ex: 

.Where(LtOrEq{"id": 1}) == "id <= 1"

func (LtOrEq) ToSql 

func (ltOrEq LtOrEq) ToSql() (sql string, args []any, err error)

type NotEq 

type NotEq Eq

NotEq is syntactic sugar for use with Where/Having/Set methods. Ex: 

.Where(NotEq{"id": 1}) == "id <> 1"

func (NotEq) ToSql 

func (neq NotEq) ToSql() (sql string, args []any, err error)

type NotILike 

type NotILike Like

NotILike is syntactic sugar for use with ILIKE conditions. Ex: 

.Where(NotILike{"name": "sq%"})

func (NotILike) ToSql 

func (nilk NotILike) ToSql() (sql string, args []any, err error)

type NotLike 

type NotLike Like

NotLike is syntactic sugar for use with LIKE conditions. Ex: 

.Where(NotLike{"name": "%irrel"})

func (NotLike) ToSql 

func (nlk NotLike) ToSql() (sql string, args []any, err error)

type Or 

type Or conj

Or conjunction Sqlizers

func (Or) ToSql 

func (o Or) ToSql() (string, []any, error)

type PlaceholderFormat 

type PlaceholderFormat interface {
	ReplacePlaceholders(sql string) (string, error)
}

PlaceholderFormat is the interface that wraps the ReplacePlaceholders method.

ReplacePlaceholders takes a SQL statement and replaces each question mark placeholder with a (possibly different) SQL placeholder.

type QueryRower 

type QueryRower interface {
	QueryRow(query string, args ...any) RowScanner
}

QueryRower is the interface that wraps the QueryRow method.

QueryRow executes the given query as implemented by database/sql.QueryRow.

type Queryer 

type Queryer interface {
	Query(query string, args ...any) (*sql.Rows, error)
}

Queryer is the interface that wraps the Query method.

Query executes the given query as implemented by database/sql.Query.

type Row 

type Row struct {
	RowScanner
	// contains filtered or unexported fields
}

Row wraps database/sql.Row to let squirrel return new errors on Scan.

func (*Row) Scan 

func (r *Row) Scan(dest ...any) error

Scan returns Row.err or calls RowScanner.Scan.

type RowScanner 

type RowScanner interface {
	Scan(...any) error
}

RowScanner is the interface that wraps the Scan method.

Scan behaves like database/sql.Row.Scan.

func QueryRowWith 

func QueryRowWith(db QueryRower, s Sqlizer) RowScanner

QueryRowWith QueryRows the SQL returned by s with db.

type Runner 

type Runner interface {
	Execer
	Queryer
	QueryRower
}

Runner groups the Execer, Queryer, and QueryRower interfaces.

func WrapStdSql 

func WrapStdSql(stdSql StdSql) Runner

WrapStdSql wraps a type implementing the standard SQL interface with methods that squirrel expects.

type SelectBuilder 

type SelectBuilder builder.Builder

SelectBuilder builds SQL SELECT statements.

func Select 

func Select(columns ...string) SelectBuilder

Select returns a new SelectBuilder, optionally setting some result columns.

See SelectBuilder.Columns.

Example 
Select("id", "created", "first_name").From("users") // ... continue building up your query

// sql methods in select columns are ok
Select("first_name", "count(*)").From("users")

// column aliases are ok too
Select("first_name", "count(*) as n_users").From("users")

Output:

func (SelectBuilder) AssumeOrderBy 

func (b SelectBuilder) AssumeOrderBy() SelectBuilder

AssumeOrderBy adds a ASSUME clause to the query.

func (SelectBuilder) Column 

func (b SelectBuilder) Column(column any, args ...any) SelectBuilder

Column adds a result column to the query. Unlike Columns, Column accepts args which will be bound to placeholders in the columns string, for example: 

Column("IF(col IN ("+squirrel.Placeholders(3)+"), 1, 0) as col", 1, 2, 3)

func (SelectBuilder) Columns 

func (b SelectBuilder) Columns(columns ...string) SelectBuilder

Columns adds result columns to the query.

Example 
query := Select("id").Columns("created", "first_name").From("users")

sql, _, _ := query.ToSql()
fmt.Println(sql)

Output:

SELECT id, created, first_name FROM users
Example (Order) 
// out of order is ok too
query := Select("id").Columns("created").From("users").Columns("first_name")

sql, _, _ := query.ToSql()
fmt.Println(sql)

Output:

SELECT id, created, first_name FROM users

func (SelectBuilder) CrossJoin 

func (b SelectBuilder) CrossJoin(join string, rest ...any) SelectBuilder

CrossJoin adds a CROSS JOIN clause to the query.

func (SelectBuilder) Distinct 

func (b SelectBuilder) Distinct() SelectBuilder

Distinct adds a DISTINCT clause to the query.

func (SelectBuilder) Exec 

func (b SelectBuilder) Exec() (sql.Result, error)

Exec builds and Execs the query with the Runner set by RunWith.

func (SelectBuilder) Flatten 

func (b SelectBuilder) Flatten(flatten string, rest ...any) SelectBuilder

Flatten adds a FLATTEN BY clause to the query.

func (SelectBuilder) FlattenClause 

func (b SelectBuilder) FlattenClause(pred any, args ...any) SelectBuilder

FlattenClause adds a flatten clause to the query.

func (SelectBuilder) FlattenColumns 

func (b SelectBuilder) FlattenColumns(flatten string, rest ...any) SelectBuilder

FlattenOptional adds a FLATTEN BY clause to the query.

func (SelectBuilder) FlattenDict 

func (b SelectBuilder) FlattenDict(flatten string, rest ...any) SelectBuilder

FlattenDict adds a FLATTEN BY clause to the query.

func (SelectBuilder) FlattenList 

func (b SelectBuilder) FlattenList(flatten string, rest ...any) SelectBuilder

FlattenList adds a FLATTEN BY clause to the query.

func (SelectBuilder) FlattenOptional 

func (b SelectBuilder) FlattenOptional(flatten string, rest ...any) SelectBuilder

FlattenOptional adds a FLATTEN BY clause to the query.

func (SelectBuilder) From 

func (b SelectBuilder) From(from string) SelectBuilder

From sets the FROM clause of the query.

Example 
Select("id", "created", "first_name").From("users") // ... continue building up your query

Output:

func (SelectBuilder) FromSelect 

func (b SelectBuilder) FromSelect(from SelectBuilder, alias string) SelectBuilder

FromSelect sets a subquery into the FROM clause of the query.

Example 
usersByCompany := Select("company", "count(*) as n_users").From("users").GroupBy("company")
query := Select("company.id", "company.name", "users_by_company.n_users").
	FromSelect(usersByCompany, "users_by_company").
	Join("company on company.id = users_by_company.company")

sql, _, _ := query.ToSql()
fmt.Println(sql)

Output:

SELECT company.id, company.name, users_by_company.n_users FROM (SELECT company, count(*) as n_users FROM users GROUP BY company) AS users_by_company JOIN company on company.id = users_by_company.company

func (SelectBuilder) GroupBy 

func (b SelectBuilder) GroupBy(groupBys ...string) SelectBuilder

GroupBy adds GROUP BY expressions to the query.

func (SelectBuilder) Having 

func (b SelectBuilder) Having(pred any, rest ...any) SelectBuilder

Having adds an expression to the HAVING clause of the query.

See Where.

func (SelectBuilder) InnerJoin 

func (b SelectBuilder) InnerJoin(join string, rest ...any) SelectBuilder

InnerJoin adds a INNER JOIN clause to the query.

func (SelectBuilder) Join 

func (b SelectBuilder) Join(join string, rest ...any) SelectBuilder

Join adds a JOIN clause to the query.

func (SelectBuilder) JoinClause 

func (b SelectBuilder) JoinClause(pred any, args ...any) SelectBuilder

JoinClause adds a join clause to the query.

func (SelectBuilder) LeftJoin 

func (b SelectBuilder) LeftJoin(join string, rest ...any) SelectBuilder

LeftJoin adds a LEFT JOIN clause to the query.

func (SelectBuilder) Limit 

func (b SelectBuilder) Limit(limit uint64) SelectBuilder

Limit sets a LIMIT clause on the query.

func (SelectBuilder) Offset 

func (b SelectBuilder) Offset(offset uint64) SelectBuilder

Offset sets a OFFSET clause on the query.

func (SelectBuilder) Options 

func (b SelectBuilder) Options(options ...string) SelectBuilder

Options adds select option to the query

func (SelectBuilder) OrderBy 

func (b SelectBuilder) OrderBy(orderBys ...string) SelectBuilder

OrderBy adds ORDER BY expressions to the query.

func (SelectBuilder) OrderByClause 

func (b SelectBuilder) OrderByClause(pred any, args ...any) SelectBuilder

OrderByClause adds ORDER BY clause to the query.

func (SelectBuilder) PlaceholderFormat 

func (b SelectBuilder) PlaceholderFormat(f PlaceholderFormat) SelectBuilder

PlaceholderFormat sets PlaceholderFormat (e.g. Question or Dollar) for the query.

func (SelectBuilder) Prefix 

func (b SelectBuilder) Prefix(sql string, args ...any) SelectBuilder

Prefix adds an expression to the beginning of the query

func (SelectBuilder) PrefixExpr 

func (b SelectBuilder) PrefixExpr(expr Sqlizer) SelectBuilder

PrefixExpr adds an expression to the very beginning of the query

func (SelectBuilder) Query 

func (b SelectBuilder) Query() (*sql.Rows, error)

Query builds and Querys the query with the Runner set by RunWith.

func (SelectBuilder) QueryRow 

func (b SelectBuilder) QueryRow() RowScanner

QueryRow builds and QueryRows the query with the Runner set by RunWith.

func (SelectBuilder) RemoveColumns 

func (b SelectBuilder) RemoveColumns() SelectBuilder

RemoveColumns remove all columns from query. Must add a new column with Column or Columns methods, otherwise return a error.

func (SelectBuilder) RemoveLimit 

func (b SelectBuilder) RemoveLimit() SelectBuilder

Limit ALL allows to access all records with limit

func (SelectBuilder) RemoveOffset 

func (b SelectBuilder) RemoveOffset() SelectBuilder

RemoveOffset removes OFFSET clause.

func (SelectBuilder) RightJoin 

func (b SelectBuilder) RightJoin(join string, rest ...any) SelectBuilder

RightJoin adds a RIGHT JOIN clause to the query.

func (SelectBuilder) RunWith 

func (b SelectBuilder) RunWith(runner BaseRunner) SelectBuilder

RunWith sets a Runner (like database/sql.DB) to be used with e.g. Exec. For most cases runner will be a database connection.

Internally we use this to mock out the database connection for testing.

func (SelectBuilder) Scan 

func (b SelectBuilder) Scan(dest ...any) error

Scan is a shortcut for QueryRow().Scan.

Example 
var db *sql.DB

query := Select("id", "created", "first_name").From("users")
query = query.RunWith(db)

var id int
var created time.Time
var firstName string

if err := query.Scan(&id, &created, &firstName); err != nil {
	log.Println(err)
	return
}

Output:

func (SelectBuilder) Suffix 

func (b SelectBuilder) Suffix(sql string, args ...any) SelectBuilder

Suffix adds an expression to the end of the query

func (SelectBuilder) SuffixExpr 

func (b SelectBuilder) SuffixExpr(expr Sqlizer) SelectBuilder

SuffixExpr adds an expression to the end of the query

func (SelectBuilder) ToSql 

func (b SelectBuilder) ToSql() (string, []any, error)

ToSql builds the query into a SQL string and bound args.

Example 
var db *sql.DB

query := Select("id", "created", "first_name").From("users")

sql, args, err := query.ToSql()
if err != nil {
	log.Println(err)
	return
}

rows, err := db.Query(sql, args...)
if err != nil {
	log.Println(err)
	return
}

defer rows.Close()

for rows.Next() {
	// scan...
}

Output:

func (SelectBuilder) ToYdbSql 

func (b SelectBuilder) ToYdbSql() (string, []table.ParameterOption, error)

ToYdbSql builds the query into a SQL string and bound args.

func (SelectBuilder) View 

func (b SelectBuilder) View(view string) SelectBuilder

View sets the VIEW clause of the query.

func (SelectBuilder) Where 

func (b SelectBuilder) Where(pred any, args ...any) SelectBuilder

Where adds an expression to the WHERE clause of the query.

Expressions are ANDed together in the generated SQL.

Where accepts several types for its pred argument:

nil OR "" - ignored.

string - SQL expression. If the expression has SQL placeholders then a set of arguments must be passed as well, one for each placeholder.

map[string]any OR Eq - map of SQL expressions to values. Each key is transformed into an expression like "<key> = ?", with the corresponding value bound to the placeholder. If the value is nil, the expression will be "<key> IS NULL". If the value is an array or slice, the expression will be "<key> IN (?,?,...)", with one placeholder for each item in the value. These expressions are ANDed together.

Where will panic if pred isn't any of the above types.

Example 
companyId := 20
Select("id", "created", "first_name").From("users").Where("company = ?", companyId)

Output:
Example (Helpers) 
companyId := 20

Select("id", "created", "first_name").From("users").Where(Eq{
	"company": companyId,
})

Select("id", "created", "first_name").From("users").Where(GtOrEq{
	"created": time.Now().AddDate(0, 0, -7),
})

Select("id", "created", "first_name").From("users").Where(And{
	GtOrEq{
		"created": time.Now().AddDate(0, 0, -7),
	},
	Eq{
		"company": companyId,
	},
})

Output:
Example (Multiple) 
companyId := 20

// multiple where's are ok

Select("id", "created", "first_name").
	From("users").
	Where("company = ?", companyId).
	Where(GtOrEq{
		"created": time.Now().AddDate(0, 0, -7),
	})

Output:

func (SelectBuilder) With 

func (b SelectBuilder) With(pred any, rest ...any) SelectBuilder

With adds an expression to the WITH clause of the query.

See Where.

type Sqlizer 

type Sqlizer interface {
	ToSql() (string, []any, error)
}

Sqlizer is the interface that wraps the ToSql method.

ToSql returns a SQL representation of the Sqlizer, along with a slice of args as passed to e.g. database/sql.Exec. It can also return an error.

func Expr 

func Expr(sql string, args ...any) Sqlizer

Expr builds an expression from a SQL fragment and arguments.

Ex: 

Expr("FROM_UNIXTIME(?)", t)

type StatementBuilderType 

type StatementBuilderType builder.Builder

StatementBuilderType is the type of StatementBuilder.

func (StatementBuilderType) Create 

func (b StatementBuilderType) Create(table string) CreateBuilder

Create returns a CreateBuilder for this StatementBuilderType.

func (StatementBuilderType) Delete 

func (b StatementBuilderType) Delete(from string) DeleteBuilder

Delete returns a DeleteBuilder for this StatementBuilderType.

func (StatementBuilderType) Drop 

func (b StatementBuilderType) Drop(table string) DropBuilder

Drop returns a DropBuilder for this StatementBuilderType.

func (StatementBuilderType) Insert 

func (b StatementBuilderType) Insert(into string) InsertBuilder

Insert returns a InsertBuilder for this StatementBuilderType.

func (StatementBuilderType) PlaceholderFormat 

func (b StatementBuilderType) PlaceholderFormat(f PlaceholderFormat) StatementBuilderType

PlaceholderFormat sets the PlaceholderFormat field for any child builders.

func (StatementBuilderType) Replace 

func (b StatementBuilderType) Replace(into string) InsertBuilder

Replace returns a InsertBuilder for this StatementBuilderType with the statement keyword set to "REPLACE".

func (StatementBuilderType) RunWith 

func (b StatementBuilderType) RunWith(runner BaseRunner) StatementBuilderType

RunWith sets the RunWith field for any child builders.

func (StatementBuilderType) Select 

func (b StatementBuilderType) Select(columns ...string) SelectBuilder

Select returns a SelectBuilder for this StatementBuilderType.

func (StatementBuilderType) Update 

func (b StatementBuilderType) Update(table string) UpdateBuilder

Update returns a UpdateBuilder for this StatementBuilderType.

func (StatementBuilderType) Where 

func (b StatementBuilderType) Where(pred any, args ...any) StatementBuilderType

Where adds WHERE expressions to the query.

See SelectBuilder.Where for more information.

type StdSql 

type StdSql interface {
	Query(string, ...any) (*sql.Rows, error)
	QueryRow(string, ...any) *sql.Row
	Exec(string, ...any) (sql.Result, error)
}

StdSql encompasses the standard methods of the *sql.DB type, and other types that wrap these methods.

type UpdateBuilder 

type UpdateBuilder builder.Builder

UpdateBuilder builds SQL UPDATE statements.

func Update 

func Update(table string) UpdateBuilder

Update returns a new UpdateBuilder with the given table name.

See UpdateBuilder.Table.

func (UpdateBuilder) Exec 

func (b UpdateBuilder) Exec() (sql.Result, error)

Exec builds and Execs the query with the Runner set by RunWith.

func (UpdateBuilder) From 

func (b UpdateBuilder) From(from string) UpdateBuilder

From adds FROM clause to the query FROM is valid construct in postgresql only.

func (UpdateBuilder) FromSelect 

func (b UpdateBuilder) FromSelect(from SelectBuilder, alias string) UpdateBuilder

FromSelect sets a subquery into the FROM clause of the query.

func (UpdateBuilder) Limit 

func (b UpdateBuilder) Limit(limit uint64) UpdateBuilder

Limit sets a LIMIT clause on the query.

func (UpdateBuilder) Offset 

func (b UpdateBuilder) Offset(offset uint64) UpdateBuilder

Offset sets a OFFSET clause on the query.

func (UpdateBuilder) OrderBy 

func (b UpdateBuilder) OrderBy(orderBys ...string) UpdateBuilder

OrderBy adds ORDER BY expressions to the query.

func (UpdateBuilder) PlaceholderFormat 

func (b UpdateBuilder) PlaceholderFormat(f PlaceholderFormat) UpdateBuilder

PlaceholderFormat sets PlaceholderFormat (e.g. Question or Dollar) for the query.

func (UpdateBuilder) Prefix 

func (b UpdateBuilder) Prefix(sql string, args ...any) UpdateBuilder

Prefix adds an expression to the beginning of the query

func (UpdateBuilder) PrefixExpr 

func (b UpdateBuilder) PrefixExpr(expr Sqlizer) UpdateBuilder

PrefixExpr adds an expression to the very beginning of the query

func (UpdateBuilder) Query 

func (b UpdateBuilder) Query() (*sql.Rows, error)

func (UpdateBuilder) QueryRow 

func (b UpdateBuilder) QueryRow() RowScanner

func (UpdateBuilder) RunWith 

func (b UpdateBuilder) RunWith(runner BaseRunner) UpdateBuilder

RunWith sets a Runner (like database/sql.DB) to be used with e.g. Exec.

func (UpdateBuilder) Scan 

func (b UpdateBuilder) Scan(dest ...any) error

func (UpdateBuilder) Set 

func (b UpdateBuilder) Set(column string, value any) UpdateBuilder

Set adds SET clauses to the query.

func (UpdateBuilder) SetMap 

func (b UpdateBuilder) SetMap(clauses map[string]any) UpdateBuilder

SetMap is a convenience method which calls .Set for each key/value pair in clauses.

func (UpdateBuilder) Suffix 

func (b UpdateBuilder) Suffix(sql string, args ...any) UpdateBuilder

Suffix adds an expression to the end of the query

func (UpdateBuilder) SuffixExpr 

func (b UpdateBuilder) SuffixExpr(expr Sqlizer) UpdateBuilder

SuffixExpr adds an expression to the end of the query

func (UpdateBuilder) Table 

func (b UpdateBuilder) Table(table string) UpdateBuilder

Table sets the table to be updated.

func (UpdateBuilder) ToSql 

func (b UpdateBuilder) ToSql() (string, []any, error)

ToSql builds the query into a SQL string and bound args.

func (UpdateBuilder) ToYdbSql 

func (b UpdateBuilder) ToYdbSql() (string, []table.ParameterOption, error)

ToYdbSql builds the query into a SQL string and bound args.

func (UpdateBuilder) Where 

func (b UpdateBuilder) Where(pred any, args ...any) UpdateBuilder

Where adds WHERE expressions to the query.

See SelectBuilder.Where for more information.

type YdbSqlizer 

type YdbSqlizer interface {
	ToYdbSql() (string, []table.ParameterOption, error)
}

YdbSqlizer is the interface that wraps the ToYdbSql method.

Source Files

View all Source files

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.