builder

package
v0.16.0 Latest Latest
Warning

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

 Go to latest Published: Mar 16, 2026 License: MIT Imports: 6 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ErrFromItemLateralAndOnly = errors.New("from item: cannot specify both LATERAL and ONLY")
View Source 
var ErrInsertConflictConstraintAndTarget = errors.New("insert: cannot set both conflict constraint name and targets")
View Source 
var ErrInsertValuesAndQuery = errors.New("insert: cannot set both values and query")
View Source 
var ErrInvalidIdentifier = errors.New("identifier: invalid")
View Source 
var ErrInvalidType = errors.New("type: invalid")
View Source 
var ErrNoConditionsGiven = errors.New("case: no conditions given")

Functions

This section is empty.

Types

type AddColumnAlterTableBuilder added in v0.15.0 

type AddColumnAlterTableBuilder struct {
	AlterTableBuilder
}

AddColumnAlterTableBuilder provides column constraint methods after AddColumn.

func (AddColumnAlterTableBuilder) Check added in v0.15.0 

func (b AddColumnAlterTableBuilder) Check(exp Exp) AddColumnAlterTableBuilder

Check adds a CHECK constraint to the last added column.

func (AddColumnAlterTableBuilder) Default added in v0.15.0 

func (b AddColumnAlterTableBuilder) Default(exp Exp) AddColumnAlterTableBuilder

Default adds a DEFAULT expression to the last added column.

func (AddColumnAlterTableBuilder) NotNull added in v0.15.0 

func (b AddColumnAlterTableBuilder) NotNull() AddColumnAlterTableBuilder

NotNull adds NOT NULL to the last added column.

func (AddColumnAlterTableBuilder) PrimaryKey added in v0.15.0 

func (b AddColumnAlterTableBuilder) PrimaryKey() AddColumnAlterTableBuilder

PrimaryKey adds a PRIMARY KEY constraint to the last added column.

func (AddColumnAlterTableBuilder) References added in v0.15.0 

func (b AddColumnAlterTableBuilder) References(table Identer, columns ...string) ReferencesAlterTableBuilder

References adds a REFERENCES constraint to the last added column.

func (AddColumnAlterTableBuilder) Unique added in v0.15.0 

func (b AddColumnAlterTableBuilder) Unique() AddColumnAlterTableBuilder

Unique adds a UNIQUE constraint to the last added column.

type AddConstraintAlterTableBuilder added in v0.15.0 

type AddConstraintAlterTableBuilder struct {
	AlterTableBuilder
	// contains filtered or unexported fields
}

AddConstraintAlterTableBuilder holds a constraint name and provides methods to define the constraint kind.

func (AddConstraintAlterTableBuilder) Check added in v0.15.0 

func (b AddConstraintAlterTableBuilder) Check(exp Exp) AlterTableBuilder

Check adds a named CHECK constraint.

func (AddConstraintAlterTableBuilder) ForeignKey added in v0.15.0 

func (b AddConstraintAlterTableBuilder) ForeignKey(columns ...string) AddForeignKeyAlterTableBuilder

ForeignKey starts a named FOREIGN KEY constraint.

func (AddConstraintAlterTableBuilder) PrimaryKey added in v0.15.0 

func (b AddConstraintAlterTableBuilder) PrimaryKey(columns ...string) AlterTableBuilder

PrimaryKey adds a named PRIMARY KEY constraint.

func (AddConstraintAlterTableBuilder) Unique added in v0.15.0 

func (b AddConstraintAlterTableBuilder) Unique(columns ...string) AlterTableBuilder

Unique adds a named UNIQUE constraint.

type AddForeignKeyAlterTableBuilder added in v0.15.0 

type AddForeignKeyAlterTableBuilder struct {
	AlterTableBuilder
	// contains filtered or unexported fields
}

AddForeignKeyAlterTableBuilder provides References method for ALTER TABLE ADD CONSTRAINT ... FOREIGN KEY.

func (AddForeignKeyAlterTableBuilder) References added in v0.15.0 

func (b AddForeignKeyAlterTableBuilder) References(table Identer, columns ...string) ReferencesConstraintAlterTableBuilder

References specifies the referenced table and columns.

type AggBuilder added in v0.12.0 

type AggBuilder struct {
	ExpBase
	// contains filtered or unexported fields
}

func Agg 

func Agg(name string, exps []Exp) AggBuilder

func (AggBuilder) Distinct added in v0.12.0 

func (b AggBuilder) Distinct() AggBuilder

func (AggBuilder) Filter added in v0.12.0 

func (b AggBuilder) Filter(cond Exp) AggBuilder

Filter adds a filter to the aggregate function. Multiple calls to Filter are joined with AND.

func (AggBuilder) IsExp added in v0.12.0 

func (b AggBuilder) IsExp()

func (AggBuilder) OrderBy added in v0.12.0 

func (b AggBuilder) OrderBy(exp Exp) OrderByAggBuilder

OrderBy adds an ORDER BY clause to the aggregate function. If AggBuilder.WithinGroup is called, the ORDER BY clause is used after the aggregate function in WITHIN GROUP.

func (AggBuilder) Over added in v0.12.0 

func (b AggBuilder) Over(windowName ...string) WindowFuncCallBuilder

func (AggBuilder) WithinGroup added in v0.12.0 

func (b AggBuilder) WithinGroup() AggBuilder

WithinGroup adds a WITHIN GROUP order by clause after the aggregate function. Sort arguments are added via AggBuilder.OrderBy.

func (AggBuilder) WriteSQL added in v0.12.0 

func (b AggBuilder) WriteSQL(sb *SQLBuilder)

type AlterColumnBuilder added in v0.15.0 

type AlterColumnBuilder struct {
	AlterTableBuilder
	// contains filtered or unexported fields
}

AlterColumnBuilder provides ALTER COLUMN sub-actions.

func (AlterColumnBuilder) DropDefault added in v0.15.0 

func (b AlterColumnBuilder) DropDefault() AlterTableBuilder

DropDefault adds an ALTER COLUMN ... DROP DEFAULT action.

func (AlterColumnBuilder) DropNotNull added in v0.15.0 

func (b AlterColumnBuilder) DropNotNull() AlterTableBuilder

DropNotNull adds an ALTER COLUMN ... DROP NOT NULL action.

func (AlterColumnBuilder) SetDefault added in v0.15.0 

func (b AlterColumnBuilder) SetDefault(exp Exp) AlterTableBuilder

SetDefault adds an ALTER COLUMN ... SET DEFAULT action.

func (AlterColumnBuilder) SetNotNull added in v0.15.0 

func (b AlterColumnBuilder) SetNotNull() AlterTableBuilder

SetNotNull adds an ALTER COLUMN ... SET NOT NULL action.

func (AlterColumnBuilder) Type added in v0.15.0 

func (b AlterColumnBuilder) Type(typeName string) AlterTableBuilder

Type adds an ALTER COLUMN ... TYPE action.

type AlterTableBuilder added in v0.15.0 

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

AlterTableBuilder builds an ALTER TABLE statement.

func AlterTable added in v0.15.0 

func AlterTable(tableName Identer) AlterTableBuilder

AlterTable starts building an ALTER TABLE statement.

func (AlterTableBuilder) AddColumn added in v0.15.0 

func (b AlterTableBuilder) AddColumn(name string, typeName string) AddColumnAlterTableBuilder

AddColumn adds an ADD COLUMN action.

func (AlterTableBuilder) AddColumnIfNotExists added in v0.15.0 

func (b AlterTableBuilder) AddColumnIfNotExists(name string, typeName string) AddColumnAlterTableBuilder

AddColumnIfNotExists adds an ADD COLUMN IF NOT EXISTS action.

func (AlterTableBuilder) AddConstraint added in v0.15.0 

func (b AlterTableBuilder) AddConstraint(name string) AddConstraintAlterTableBuilder

AddConstraint starts adding a named constraint.

func (AlterTableBuilder) AlterColumn added in v0.15.0 

func (b AlterTableBuilder) AlterColumn(name string) AlterColumnBuilder

AlterColumn starts an ALTER COLUMN sub-builder.

func (AlterTableBuilder) DropColumn added in v0.15.0 

func (b AlterTableBuilder) DropColumn(name string) AlterTableBuilder

DropColumn adds a DROP COLUMN action.

func (AlterTableBuilder) DropColumnIfExists added in v0.15.0 

func (b AlterTableBuilder) DropColumnIfExists(name string) AlterTableBuilder

DropColumnIfExists adds a DROP COLUMN IF EXISTS action.

func (AlterTableBuilder) DropConstraint added in v0.15.0 

func (b AlterTableBuilder) DropConstraint(name string) AlterTableBuilder

DropConstraint adds a DROP CONSTRAINT action.

func (AlterTableBuilder) DropConstraintIfExists added in v0.15.0 

func (b AlterTableBuilder) DropConstraintIfExists(name string) AlterTableBuilder

DropConstraintIfExists adds a DROP CONSTRAINT IF EXISTS action.

func (AlterTableBuilder) IfExists added in v0.15.0 

func (b AlterTableBuilder) IfExists() AlterTableBuilder

IfExists adds IF EXISTS to the ALTER TABLE statement.

func (AlterTableBuilder) RenameColumn added in v0.15.0 

func (b AlterTableBuilder) RenameColumn(oldName, newName string) AlterTableBuilder

RenameColumn adds a RENAME COLUMN action.

func (AlterTableBuilder) RenameTo added in v0.15.0 

func (b AlterTableBuilder) RenameTo(newName string) AlterTableBuilder

RenameTo adds a RENAME TO action.

func (AlterTableBuilder) WriteSQL added in v0.15.0 

func (b AlterTableBuilder) WriteSQL(sb *SQLBuilder)

WriteSQL writes the ALTER TABLE statement.

type CaseBuilder 

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

func Case 

func Case(exp ...Exp) CaseBuilder

func (CaseBuilder) Else 

func (b CaseBuilder) Else(result Exp) CaseBuilder

func (CaseBuilder) End 

func (b CaseBuilder) End() CaseExp

func (CaseBuilder) When 

func (b CaseBuilder) When(condition Exp) CaseWhenBuilder

type CaseExp 

type CaseExp struct {
	ExpBase
	// contains filtered or unexported fields
}

func (CaseExp) WriteSQL 

func (c CaseExp) WriteSQL(sb *SQLBuilder)

type CaseWhenBuilder 

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

func (CaseWhenBuilder) Then 

func (b CaseWhenBuilder) Then(result Exp) CaseBuilder

type ColumnCreateTableBuilder added in v0.15.0 

type ColumnCreateTableBuilder struct {
	CreateTableBuilder
}

ColumnCreateTableBuilder is returned after adding a column, providing column constraint methods.

func (ColumnCreateTableBuilder) Check added in v0.15.0 

func (b ColumnCreateTableBuilder) Check(exp Exp) ColumnCreateTableBuilder

Check adds a CHECK constraint to the last column.

func (ColumnCreateTableBuilder) Default added in v0.15.0 

func (b ColumnCreateTableBuilder) Default(exp Exp) ColumnCreateTableBuilder

Default adds a DEFAULT expression to the last column.

func (ColumnCreateTableBuilder) NotNull added in v0.15.0 

func (b ColumnCreateTableBuilder) NotNull() ColumnCreateTableBuilder

NotNull adds a NOT NULL constraint to the last column.

func (ColumnCreateTableBuilder) PrimaryKey added in v0.15.0 

func (b ColumnCreateTableBuilder) PrimaryKey() ColumnCreateTableBuilder

PrimaryKey adds a PRIMARY KEY constraint to the last column.

func (ColumnCreateTableBuilder) References added in v0.15.0 

func (b ColumnCreateTableBuilder) References(table Identer, columns ...string) ReferencesCreateTableBuilder

References adds a REFERENCES constraint to the last column.

func (ColumnCreateTableBuilder) Unique added in v0.15.0 

func (b ColumnCreateTableBuilder) Unique() ColumnCreateTableBuilder

Unique adds a UNIQUE constraint to the last column.

type CombinationBuilder 

type CombinationBuilder struct {
	SelectBuilder
}

func (CombinationBuilder) All 

func (b CombinationBuilder) All() CombinationBuilder

func (CombinationBuilder) Query added in v0.13.1 

func (b CombinationBuilder) Query(query SelectExp) CombinationBuilder

type ConstraintCreateTableBuilder added in v0.15.0 

type ConstraintCreateTableBuilder struct {
	CreateTableBuilder
	// contains filtered or unexported fields
}

ConstraintCreateTableBuilder holds a constraint name and provides methods to define the constraint kind.

func (ConstraintCreateTableBuilder) Check added in v0.15.0 

func (b ConstraintCreateTableBuilder) Check(exp Exp) CreateTableBuilder

Check creates a named CHECK constraint.

func (ConstraintCreateTableBuilder) ForeignKey added in v0.15.0 

func (b ConstraintCreateTableBuilder) ForeignKey(columns ...string) ForeignKeyCreateTableBuilder

ForeignKey creates a named FOREIGN KEY constraint.

func (ConstraintCreateTableBuilder) PrimaryKey added in v0.15.0 

func (b ConstraintCreateTableBuilder) PrimaryKey(columns ...string) CreateTableBuilder

PrimaryKey creates a named PRIMARY KEY constraint.

func (ConstraintCreateTableBuilder) Unique added in v0.15.0 

func (b ConstraintCreateTableBuilder) Unique(columns ...string) CreateTableBuilder

Unique creates a named UNIQUE constraint.

type CreateFunctionBuilder added in v0.16.0 

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

CreateFunctionBuilder builds a CREATE FUNCTION statement.

func CreateFunction added in v0.16.0 

func CreateFunction(functionName Identer) CreateFunctionBuilder

CreateFunction starts building a CREATE FUNCTION statement.

func (CreateFunctionBuilder) Body added in v0.16.0 

func (b CreateFunctionBuilder) Body(body string) CreateFunctionBuilder

Body sets the function body.

func (CreateFunctionBuilder) DollarTag added in v0.16.0 

func (b CreateFunctionBuilder) DollarTag(tag string) CreateFunctionBuilder

DollarTag sets the dollar-quoting tag for the function body. An empty string (the default) produces $$...$$, "fn" produces $fn$...$fn$.

func (CreateFunctionBuilder) Language added in v0.16.0 

func (b CreateFunctionBuilder) Language(lang string) CreateFunctionBuilder

Language sets the language of the function.

func (CreateFunctionBuilder) OrReplace added in v0.16.0 

func (b CreateFunctionBuilder) OrReplace() CreateFunctionBuilder

OrReplace adds OR REPLACE to the CREATE FUNCTION statement.

func (CreateFunctionBuilder) Returns added in v0.16.0 

func (b CreateFunctionBuilder) Returns(typeName string) CreateFunctionBuilder

Returns sets the return type of the function.

func (CreateFunctionBuilder) WriteSQL added in v0.16.0 

func (b CreateFunctionBuilder) WriteSQL(sb *SQLBuilder)

WriteSQL writes the CREATE FUNCTION statement.

type CreateIndexBuilder added in v0.15.0 

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

CreateIndexBuilder builds a CREATE INDEX statement.

func CreateIndex added in v0.15.0 

func CreateIndex(indexName string) CreateIndexBuilder

CreateIndex starts building a CREATE INDEX statement.

func (CreateIndexBuilder) Columns added in v0.15.0 

func (b CreateIndexBuilder) Columns(columns ...Exp) CreateIndexBuilder

Columns sets the indexed columns or expressions.

func (CreateIndexBuilder) Concurrently added in v0.15.0 

func (b CreateIndexBuilder) Concurrently() CreateIndexBuilder

Concurrently adds CONCURRENTLY to the CREATE INDEX statement.

func (CreateIndexBuilder) IfNotExists added in v0.15.0 

func (b CreateIndexBuilder) IfNotExists() CreateIndexBuilder

IfNotExists adds IF NOT EXISTS to the CREATE INDEX statement.

func (CreateIndexBuilder) Include added in v0.15.0 

func (b CreateIndexBuilder) Include(columns ...string) CreateIndexBuilder

Include adds columns to the INCLUDE clause.

func (CreateIndexBuilder) On added in v0.15.0 

func (b CreateIndexBuilder) On(tableName Identer) CreateIndexBuilder

On sets the table for the index.

func (CreateIndexBuilder) Unique added in v0.15.0 

func (b CreateIndexBuilder) Unique() CreateIndexBuilder

Unique adds UNIQUE to the CREATE INDEX statement.

func (CreateIndexBuilder) Using added in v0.15.0 

func (b CreateIndexBuilder) Using(method string) CreateIndexBuilder

Using sets the index method (e.g. btree, hash, gin, gist).

func (CreateIndexBuilder) Where added in v0.15.0 

func (b CreateIndexBuilder) Where(cond Exp) CreateIndexBuilder

Where adds a WHERE condition for a partial index. Multiple calls to Where are joined with AND.

func (CreateIndexBuilder) WriteSQL added in v0.15.0 

func (b CreateIndexBuilder) WriteSQL(sb *SQLBuilder)

WriteSQL writes the CREATE INDEX statement.

type CreateSchemaBuilder added in v0.15.0 

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

CreateSchemaBuilder builds a CREATE SCHEMA statement.

func CreateSchema added in v0.15.0 

func CreateSchema(schemaName Identer) CreateSchemaBuilder

CreateSchema starts building a CREATE SCHEMA statement.

func (CreateSchemaBuilder) Authorization added in v0.15.0 

func (b CreateSchemaBuilder) Authorization(role string) CreateSchemaBuilder

Authorization adds AUTHORIZATION to the CREATE SCHEMA statement.

func (CreateSchemaBuilder) IfNotExists added in v0.15.0 

func (b CreateSchemaBuilder) IfNotExists() CreateSchemaBuilder

IfNotExists adds IF NOT EXISTS to the CREATE SCHEMA statement.

func (CreateSchemaBuilder) WriteSQL added in v0.15.0 

func (b CreateSchemaBuilder) WriteSQL(sb *SQLBuilder)

WriteSQL writes the CREATE SCHEMA statement.

type CreateTableBuilder added in v0.15.0 

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

CreateTableBuilder builds a CREATE TABLE statement.

func CreateTable added in v0.15.0 

func CreateTable(tableName Identer) CreateTableBuilder

CreateTable starts building a CREATE TABLE statement.

func (CreateTableBuilder) Check added in v0.15.0 

func (b CreateTableBuilder) Check(exp Exp) CreateTableBuilder

Check adds an anonymous table-level CHECK constraint.

func (CreateTableBuilder) Column added in v0.15.0 

func (b CreateTableBuilder) Column(name string, typeName string) ColumnCreateTableBuilder

Column adds a column definition to the CREATE TABLE statement.

func (CreateTableBuilder) Constraint added in v0.15.0 

func (b CreateTableBuilder) Constraint(name string) ConstraintCreateTableBuilder

Constraint adds a named table-level constraint.

func (CreateTableBuilder) ForeignKey added in v0.15.0 

func (b CreateTableBuilder) ForeignKey(columns ...string) ForeignKeyCreateTableBuilder

ForeignKey starts an anonymous table-level FOREIGN KEY constraint.

func (CreateTableBuilder) IfNotExists added in v0.15.0 

func (b CreateTableBuilder) IfNotExists() CreateTableBuilder

IfNotExists adds IF NOT EXISTS to the CREATE TABLE statement.

func (CreateTableBuilder) Like added in v0.16.0 

func (b CreateTableBuilder) Like(source Identer) LikeCreateTableBuilder

Like adds a LIKE source_table clause to the CREATE TABLE statement.

func (CreateTableBuilder) PrimaryKey added in v0.15.0 

func (b CreateTableBuilder) PrimaryKey(columns ...string) CreateTableBuilder

PrimaryKey adds an anonymous table-level PRIMARY KEY constraint.

func (CreateTableBuilder) Unique added in v0.15.0 

func (b CreateTableBuilder) Unique(columns ...string) CreateTableBuilder

Unique adds an anonymous table-level UNIQUE constraint.

func (CreateTableBuilder) Unlogged added in v0.15.0 

func (b CreateTableBuilder) Unlogged() CreateTableBuilder

Unlogged adds UNLOGGED to the CREATE TABLE statement.

func (CreateTableBuilder) WriteSQL added in v0.15.0 

func (b CreateTableBuilder) WriteSQL(sb *SQLBuilder)

WriteSQL writes the CREATE TABLE statement.

type DeleteBuilder 

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

func DeleteFrom 

func DeleteFrom(tableName Identer) DeleteBuilder

func (DeleteBuilder) As 

func (b DeleteBuilder) As(alias string) DeleteBuilder

func (DeleteBuilder) Returning added in v0.2.0 

func (b DeleteBuilder) Returning(outputExpression Exp) ReturningDeleteBuilder

func (DeleteBuilder) Using added in v0.2.0 

func (b DeleteBuilder) Using(from FromExp) FromDeleteBuilder

Using adds a USING clause to the delete.

func (DeleteBuilder) Where 

func (b DeleteBuilder) Where(cond Exp) DeleteBuilder

Where adds a WHERE condition to the delete. Multiple calls to Where are joined with AND.

func (DeleteBuilder) WriteSQL 

func (b DeleteBuilder) WriteSQL(sb *SQLBuilder)

type DropSchemaBuilder added in v0.15.0 

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

DropSchemaBuilder builds a DROP SCHEMA statement.

func DropSchema added in v0.15.0 

func DropSchema(schemaName Identer, rest ...Identer) DropSchemaBuilder

DropSchema starts building a DROP SCHEMA statement.

func (DropSchemaBuilder) Cascade added in v0.15.0 

func (b DropSchemaBuilder) Cascade() DropSchemaBuilder

Cascade adds CASCADE to the DROP SCHEMA statement.

func (DropSchemaBuilder) IfExists added in v0.15.0 

func (b DropSchemaBuilder) IfExists() DropSchemaBuilder

IfExists adds IF EXISTS to the DROP SCHEMA statement.

func (DropSchemaBuilder) Restrict added in v0.15.0 

func (b DropSchemaBuilder) Restrict() DropSchemaBuilder

Restrict adds RESTRICT to the DROP SCHEMA statement.

func (DropSchemaBuilder) WriteSQL added in v0.15.0 

func (b DropSchemaBuilder) WriteSQL(sb *SQLBuilder)

WriteSQL writes the DROP SCHEMA statement.

type DropTableBuilder added in v0.15.0 

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

DropTableBuilder builds a DROP TABLE statement.

func DropTable added in v0.15.0 

func DropTable(tableName Identer, rest ...Identer) DropTableBuilder

DropTable starts building a DROP TABLE statement.

func (DropTableBuilder) Cascade added in v0.15.0 

func (b DropTableBuilder) Cascade() DropTableBuilder

Cascade adds CASCADE to the DROP TABLE statement.

func (DropTableBuilder) IfExists added in v0.15.0 

func (b DropTableBuilder) IfExists() DropTableBuilder

IfExists adds IF EXISTS to the DROP TABLE statement.

func (DropTableBuilder) Restrict added in v0.15.0 

func (b DropTableBuilder) Restrict() DropTableBuilder

Restrict adds RESTRICT to the DROP TABLE statement.

func (DropTableBuilder) WriteSQL added in v0.15.0 

func (b DropTableBuilder) WriteSQL(sb *SQLBuilder)

WriteSQL writes the DROP TABLE statement.

type Exp 

type Exp interface {
	IsExp()
	SQLWriter
}

func All added in v0.8.0 

func All(exp Exp) Exp

func And 

func And(exps ...Exp) Exp

And builds an AND expression of non-nil expressions.

func Any added in v0.8.0 

func Any(exp Exp) Exp

func Bool 

func Bool(b bool) Exp

func Default 

func Default() Exp

Default builds the DEFAULT keyword.

func Exists added in v0.2.0 

func Exists(subquery SelectExp) Exp

func Float 

func Float(f float64) Exp

func Int 

func Int(s int) Exp

func Interval 

func Interval(spec string) Exp

Interval builds an interval constant.

func Not 

func Not(e Exp) Exp

Not builds a NOT expression.

func Null 

func Null() Exp

Null builds the NULL literal.

func Or 

func Or(exps ...Exp) Exp

Or builds an OR expression of non-nil expressions.

func String 

func String(s string) Exp

type ExpBase 

type ExpBase struct {
	Exp
}

ExpBase is a base type for expressions to allow embedding of various default operators.

func Arg 

func Arg(argument any) ExpBase

Arg creates an expression that represents an argument that will be bound to a placeholder with the given value. Each call to Arg will create a new placeholder and emit the argument when writing the query.

func Array 

func Array(elems ...Exp) ExpBase

Array builds an array literal.

Make sure that all elements are of the same type.

func Bind 

func Bind(argName string) ExpBase

Bind creates an expression that represents an argument that will be bound to a placeholder with the given value. If Bind is called again with the same name, the same placeholder will be used.

func Coalesce 

func Coalesce(exp Exp, rest ...Exp) ExpBase

func FuncExp 

func FuncExp(name string, args []Exp) ExpBase

FuncExp is a simple function call expression

func Greatest 

func Greatest(exp Exp, rest ...Exp) ExpBase

func Least 

func Least(exp Exp, rest ...Exp) ExpBase

func Neg added in v0.2.1 

func Neg(exp Exp) ExpBase

Neg builds the - unary operator (negation) for numeric types.

func NullIf 

func NullIf(value1, value2 Exp) ExpBase

func (ExpBase) Cast 

func (b ExpBase) Cast(typ string) ExpBase

func (ExpBase) Concat 

func (b ExpBase) Concat(rgt Exp) ExpBase

func (ExpBase) ContainedBy added in v0.2.4 

func (b ExpBase) ContainedBy(rgt Exp) ExpBase

func (ExpBase) Contains added in v0.2.4 

func (b ExpBase) Contains(rgt Exp) ExpBase

func (ExpBase) Divide added in v0.2.1 

func (b ExpBase) Divide(rgt Exp) ExpBase

Divide builds the / operator (division) for numeric types. Do not confuse with the div function that returns the integer part of the division.

func (ExpBase) Eq 

func (b ExpBase) Eq(rgt Exp) Exp

func (ExpBase) Gt 

func (b ExpBase) Gt(rgt Exp) Exp

func (ExpBase) Gte 

func (b ExpBase) Gte(rgt Exp) Exp

func (ExpBase) ILike 

func (b ExpBase) ILike(rgt Exp) MatchingBuilder

func (ExpBase) In added in v0.2.0 

func (b ExpBase) In(selectOrExpressions SelectOrExpressions) Exp

func (ExpBase) IsDistinctFrom added in v0.13.1 

func (b ExpBase) IsDistinctFrom(rgt Exp) Exp

func (ExpBase) IsExp 

func (ExpBase) IsExp()

func (ExpBase) IsNotDistinctFrom added in v0.13.1 

func (b ExpBase) IsNotDistinctFrom(rgt Exp) Exp

func (ExpBase) IsNotNull 

func (b ExpBase) IsNotNull() Exp

IsNotNull builds an IS NOT NULL expression.

func (ExpBase) IsNull 

func (b ExpBase) IsNull() Exp

IsNull builds an IS NULL expression.

func (ExpBase) JsonExtract 

func (b ExpBase) JsonExtract(rgt Exp) ExpBase

JsonExtract builds the -> operator for json / jsonb. 

json -> text → json
jsonb -> text → jsonb

Extracts JSON object field with the given key. 

json -> integer → json
jsonb -> integer → jsonb

Extracts nth element of JSON array (array elements are indexed from zero, but negative integers count from the end).

func (ExpBase) JsonExtractPath 

func (b ExpBase) JsonExtractPath(rgt Exp) ExpBase

JsonExtractPath builds the #> operator for json / jsonb. 

json #> text[] → json
jsonb #> text[] → jsonb

Extracts JSON sub-object at the specified path, where path elements can be either field keys or array indexes.

Example: 

fn.JsonExtractPath(qrb.String(`{"a": {"b": ["foo","bar"]}}`).Cast("jsonb"), qrb.Array(qrb.String("a"), qrb.String("b")))

func (ExpBase) JsonExtractPathText 

func (b ExpBase) JsonExtractPathText(rgt Exp) ExpBase

JsonExtractPathText builds the #>> operator for json / jsonb. 

json #>> text[] → text
jsonb #>> text[] → text

Extracts JSON sub-object at the specified path as text.

Example: 

fn.JsonExtractPathText(qrb.String(`{"a": {"b": ["foo","bar"]}}`).Cast("jsonb"), qrb.Array(qrb.String("a"), qrb.String("b"), qrb.String("1)))

func (ExpBase) JsonExtractText 

func (b ExpBase) JsonExtractText(rgt Exp) ExpBase

JsonExtractText builds the ->> operator for json / jsonb. 

json ->> text → text
jsonb ->> text → text

Extracts JSON object field with the given key, as text. 

json ->> integer → text
jsonb ->> integer → text

Extracts nth element of JSON array, as text.

func (ExpBase) Like 

func (b ExpBase) Like(rgt Exp) MatchingBuilder

func (ExpBase) Lt 

func (b ExpBase) Lt(rgt Exp) Exp

func (ExpBase) Lte 

func (b ExpBase) Lte(rgt Exp) Exp

func (ExpBase) Minus added in v0.2.1 

func (b ExpBase) Minus(rgt Exp) ExpBase

Minus builds the - operator (subtraction) for numeric types.

func (ExpBase) Mod added in v0.2.1 

func (b ExpBase) Mod(rgt Exp) ExpBase

Mod builds the % operator (remainder) for numeric types.

func (ExpBase) Mult added in v0.2.1 

func (b ExpBase) Mult(rgt Exp) ExpBase

Mult builds the * operator (multiplication) for numeric types.

func (ExpBase) Neq 

func (b ExpBase) Neq(rgt Exp) Exp

func (ExpBase) NotILike 

func (b ExpBase) NotILike(rgt Exp) MatchingBuilder

func (ExpBase) NotIn added in v0.2.0 

func (b ExpBase) NotIn(selectOrExpressions SelectOrExpressions) Exp

func (ExpBase) NotLike 

func (b ExpBase) NotLike(rgt Exp) MatchingBuilder

func (ExpBase) NotSimilarTo 

func (b ExpBase) NotSimilarTo(rgt Exp) MatchingBuilder

func (ExpBase) Op 

func (b ExpBase) Op(op Operator, rgt Exp) ExpBase

Op allows to use arbitrary operators.

Example: 

N("a").Op(Operator("^"), Int(5))

func (ExpBase) Plus added in v0.2.1 

func (b ExpBase) Plus(rgt Exp) ExpBase

Plus builds the + operator (addition) for numeric types.

func (ExpBase) Pow added in v0.2.1 

func (b ExpBase) Pow(rgt Exp) ExpBase

Pow builds the ^ operator (exponentiation) for numeric types.

func (ExpBase) RegexpIMatch added in v0.2.5 

func (b ExpBase) RegexpIMatch(pattern Exp) Exp

func (ExpBase) RegexpINotMatch added in v0.2.5 

func (b ExpBase) RegexpINotMatch(pattern Exp) Exp

func (ExpBase) RegexpMatch added in v0.2.5 

func (b ExpBase) RegexpMatch(pattern Exp) Exp

func (ExpBase) RegexpNotMatch added in v0.2.5 

func (b ExpBase) RegexpNotMatch(pattern Exp) Exp

func (ExpBase) SimilarTo 

func (b ExpBase) SimilarTo(rgt Exp) MatchingBuilder

func (ExpBase) Subscript added in v0.13.0 

func (b ExpBase) Subscript(index Exp, upperBound ...Exp) ExpBase

Subscript allows to access an array element by index or array slice by lower and upper bounds. When called with one argument: expression[index] When called with two arguments: expression[lower:upper]

type Expressions added in v0.4.0 

type Expressions struct {
	ExpBase
	// contains filtered or unexported fields
}

func Args added in v0.2.0 

func Args[T any](arguments ...T) Expressions

Args creates argument expressions for the given arguments.

func ToExpressions added in v0.13.0 

func ToExpressions(exps ...Exp) Expressions

func (Expressions) IsExp added in v0.4.0 

func (e Expressions) IsExp()

func (Expressions) WriteSQL added in v0.4.0 

func (e Expressions) WriteSQL(sb *SQLBuilder)

type ForSelectBuilder added in v0.6.0 

type ForSelectBuilder struct {
	SelectBuilder
}

func (ForSelectBuilder) Nowait added in v0.6.0 

func (fb ForSelectBuilder) Nowait() ForSelectBuilder

func (ForSelectBuilder) Of added in v0.6.0 

func (fb ForSelectBuilder) Of(tableName string, tableNames ...string) ForSelectBuilder

func (ForSelectBuilder) SkipLocked added in v0.6.0 

func (fb ForSelectBuilder) SkipLocked() ForSelectBuilder

type ForeignKeyCreateTableBuilder added in v0.15.0 

type ForeignKeyCreateTableBuilder struct {
	CreateTableBuilder
	// contains filtered or unexported fields
}

ForeignKeyCreateTableBuilder holds foreign key columns and provides References method.

func (ForeignKeyCreateTableBuilder) References added in v0.15.0 

func (b ForeignKeyCreateTableBuilder) References(table Identer, columns ...string) ReferencesConstraintCreateTableBuilder

References specifies the referenced table and columns for a FOREIGN KEY constraint.

type FromDeleteBuilder added in v0.2.0 

type FromDeleteBuilder struct {
	DeleteBuilder
}

func (FromDeleteBuilder) As added in v0.2.0 

func (b FromDeleteBuilder) As(alias string) FromDeleteBuilder

As sets the alias for the last added from item.

func (FromDeleteBuilder) ColumnAliases added in v0.2.0 

func (b FromDeleteBuilder) ColumnAliases(aliases ...string) FromDeleteBuilder

ColumnAliases sets the column aliases for the last added from item.

type FromExp 

type FromExp interface {
	SQLWriter // We do not actually use Exp here, since this cannot appear anywhere outside the FROM clause.
	// contains filtered or unexported methods
}

type FromLateralExp 

type FromLateralExp interface {
	FromExp
	// contains filtered or unexported methods
}

type FromSelectBuilder 

type FromSelectBuilder struct {
	SelectBuilder
}

func (FromSelectBuilder) As 

func (b FromSelectBuilder) As(alias string) FromSelectBuilder

As sets the alias for the last added from item.

func (FromSelectBuilder) ColumnAliases 

func (b FromSelectBuilder) ColumnAliases(aliases ...string) FromSelectBuilder

ColumnAliases sets the column aliases for the last added from item.

type FromUpdateBuilder added in v0.2.0 

type FromUpdateBuilder struct {
	UpdateBuilder
}

func (FromUpdateBuilder) As added in v0.2.0 

func (b FromUpdateBuilder) As(alias string) FromUpdateBuilder

As sets the alias for the last added from item.

func (FromUpdateBuilder) ColumnAliases added in v0.2.0 

func (b FromUpdateBuilder) ColumnAliases(aliases ...string) FromUpdateBuilder

ColumnAliases sets the column aliases for the last added from item.

type FuncBuilder 

type FuncBuilder struct {
	ExpBase
	// contains filtered or unexported fields
}

func Func 

func Func(name string, args ...Exp) FuncBuilder

func (FuncBuilder) As 

func (b FuncBuilder) As(alias string) FuncBuilder

func (FuncBuilder) ColumnDefinition 

func (b FuncBuilder) ColumnDefinition(name, typ string) FuncBuilder

ColumnDefinition adds a column definition to the function call. To add multiple column definitions, call this method multiple times.

func (FuncBuilder) IsExp 

func (b FuncBuilder) IsExp()

func (FuncBuilder) WithOrdinality 

func (b FuncBuilder) WithOrdinality() FuncBuilder

func (FuncBuilder) WriteSQL 

func (b FuncBuilder) WriteSQL(sb *SQLBuilder)

type GroupyBySelectBuilder 

type GroupyBySelectBuilder struct {
	SelectBuilder
}

func (GroupyBySelectBuilder) Cube 

func (b GroupyBySelectBuilder) Cube(sets ...Expressions) GroupyBySelectBuilder

Cube adds a CUBE grouping element for the given expression sets to the GROUP BY clause.

func (GroupyBySelectBuilder) Distinct 

func (b GroupyBySelectBuilder) Distinct() GroupyBySelectBuilder

Distinct adds the DISTINCT keyword to the GROUP BY clause.

func (GroupyBySelectBuilder) Empty 

func (b GroupyBySelectBuilder) Empty() GroupyBySelectBuilder

Empty adds an empty grouping element to the GROUP BY clause.

func (GroupyBySelectBuilder) GroupingSets 

func (b GroupyBySelectBuilder) GroupingSets(sets ...Expressions) GroupyBySelectBuilder

GroupingSets adds a GROUPING SETS grouping element for the given expression sets to the GROUP BY clause.

func (GroupyBySelectBuilder) Rollup 

func (b GroupyBySelectBuilder) Rollup(sets ...Expressions) GroupyBySelectBuilder

Rollup adds a ROLLUP grouping element for the given expression sets to the GROUP BY clause.

type IdentExp 

type IdentExp struct {
	ExpBase
	// contains filtered or unexported fields
}

func N 

func N(s string) IdentExp

N writes the given name / identifier.

It will validate the identifier when writing the query. Reserved PostgreSQL keywords are automatically quoted (e.g. "from" becomes `"from"`).

func (IdentExp) Ident added in v0.2.6 

func (i IdentExp) Ident() string

func (IdentExp) IsExp 

func (i IdentExp) IsExp()

func (IdentExp) WriteSQL 

func (i IdentExp) WriteSQL(sb *SQLBuilder)

type Identer added in v0.3.1 

type Identer interface {
	Exp
	Ident() string
	// contains filtered or unexported methods
}

type InsertBuilder 

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

func InsertInto 

func InsertInto(tableName Identer) InsertBuilder

func (InsertBuilder) As 

func (b InsertBuilder) As(alias string) InsertBuilder

func (InsertBuilder) ColumnNames 

func (b InsertBuilder) ColumnNames(columnName string, rest ...string) InsertBuilder

func (InsertBuilder) DefaultValues added in v0.2.0 

func (b InsertBuilder) DefaultValues() InsertBuilder

DefaultValues sets the DEFAULT VALUES clause to insert a row with default values. If InsertBuilder.Values is called after this method, it will overrule the DEFAULT VALUES clause.

func (InsertBuilder) OnConflict added in v0.2.0 

func (b InsertBuilder) OnConflict(conflictTargets ...Exp) OnConflictInsertBuilder

OnConflict sets the ON CONFLICT clause with a conflict target expression to the insert. Multiple conflict targets or none can be specified (e.g. for index column names). Specify no conflict target for later addition of ON CONSTRAINT or ON CONFLICT DO NOTHING.

func (InsertBuilder) Query added in v0.2.0 

func (b InsertBuilder) Query(query SelectExp) InsertBuilder

Query sets a select query as the values to insert.

func (InsertBuilder) Returning added in v0.2.0 

func (b InsertBuilder) Returning(outputExpression Exp, exps ...Exp) ReturningInsertBuilder

func (InsertBuilder) SetMap 

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

SetMap sets the column names and values to insert from the given map. It overwrites any previous column names and values.

func (InsertBuilder) Values 

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

Values appends the given values to insert. It can be called multiple times to insert multiple rows.

func (InsertBuilder) WriteSQL 

func (b InsertBuilder) WriteSQL(sb *SQLBuilder)

WriteSQL writes the insert as an expression.

type JoinSelectBuilder 

type JoinSelectBuilder struct {
	SelectBuilder
}

func (JoinSelectBuilder) As 

func (b JoinSelectBuilder) As(alias string) JoinSelectBuilder

func (JoinSelectBuilder) On 

func (b JoinSelectBuilder) On(cond Exp, rest ...Exp) SelectBuilder

func (JoinSelectBuilder) Using 

func (b JoinSelectBuilder) Using(columns ...string) SelectBuilder

type JsonBuildObjectBuilder 

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

func JsonBuildObject 

func JsonBuildObject(isJsonB bool) JsonBuildObjectBuilder

func (JsonBuildObjectBuilder) ApplyIf added in v0.9.0 

func (b JsonBuildObjectBuilder) ApplyIf(condition bool, apply func(b JsonBuildObjectBuilder) JsonBuildObjectBuilder) JsonBuildObjectBuilder

func (JsonBuildObjectBuilder) IsExp 

func (b JsonBuildObjectBuilder) IsExp()

func (JsonBuildObjectBuilder) Prop 

func (b JsonBuildObjectBuilder) Prop(key string, value Exp) JsonBuildObjectBuilder

func (JsonBuildObjectBuilder) PropIf 

func (b JsonBuildObjectBuilder) PropIf(condition bool, key string, value Exp) JsonBuildObjectBuilder

func (JsonBuildObjectBuilder) Start 

func (b JsonBuildObjectBuilder) Start() *JsonBuildObjectBuilderBuilder

func (JsonBuildObjectBuilder) Unset 

func (b JsonBuildObjectBuilder) Unset(key string) JsonBuildObjectBuilder

func (JsonBuildObjectBuilder) WriteSQL 

func (b JsonBuildObjectBuilder) WriteSQL(sb *SQLBuilder)

type JsonBuildObjectBuilderBuilder 

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

func (*JsonBuildObjectBuilderBuilder) End 

func (bb *JsonBuildObjectBuilderBuilder) End() JsonBuildObjectBuilder

func (*JsonBuildObjectBuilderBuilder) Prop 

func (bb *JsonBuildObjectBuilderBuilder) Prop(key string, value Exp) *JsonBuildObjectBuilderBuilder

func (*JsonBuildObjectBuilderBuilder) PropIf 

func (bb *JsonBuildObjectBuilderBuilder) PropIf(condition bool, key string, value Exp) *JsonBuildObjectBuilderBuilder

type LikeCreateTableBuilder added in v0.16.0 

type LikeCreateTableBuilder struct {
	CreateTableBuilder
}

LikeCreateTableBuilder is returned after adding a LIKE clause, providing INCLUDING/EXCLUDING methods.

func (LikeCreateTableBuilder) ExcludingComments added in v0.16.0 

func (b LikeCreateTableBuilder) ExcludingComments() LikeCreateTableBuilder

ExcludingComments adds EXCLUDING COMMENTS to the LIKE clause.

func (LikeCreateTableBuilder) ExcludingCompression added in v0.16.0 

func (b LikeCreateTableBuilder) ExcludingCompression() LikeCreateTableBuilder

ExcludingCompression adds EXCLUDING COMPRESSION to the LIKE clause.

func (LikeCreateTableBuilder) ExcludingConstraints added in v0.16.0 

func (b LikeCreateTableBuilder) ExcludingConstraints() LikeCreateTableBuilder

ExcludingConstraints adds EXCLUDING CONSTRAINTS to the LIKE clause.

func (LikeCreateTableBuilder) ExcludingDefaults added in v0.16.0 

func (b LikeCreateTableBuilder) ExcludingDefaults() LikeCreateTableBuilder

ExcludingDefaults adds EXCLUDING DEFAULTS to the LIKE clause.

func (LikeCreateTableBuilder) ExcludingGenerated added in v0.16.0 

func (b LikeCreateTableBuilder) ExcludingGenerated() LikeCreateTableBuilder

ExcludingGenerated adds EXCLUDING GENERATED to the LIKE clause.

func (LikeCreateTableBuilder) ExcludingIdentity added in v0.16.0 

func (b LikeCreateTableBuilder) ExcludingIdentity() LikeCreateTableBuilder

ExcludingIdentity adds EXCLUDING IDENTITY to the LIKE clause.

func (LikeCreateTableBuilder) ExcludingIndexes added in v0.16.0 

func (b LikeCreateTableBuilder) ExcludingIndexes() LikeCreateTableBuilder

ExcludingIndexes adds EXCLUDING INDEXES to the LIKE clause.

func (LikeCreateTableBuilder) ExcludingStatistics added in v0.16.0 

func (b LikeCreateTableBuilder) ExcludingStatistics() LikeCreateTableBuilder

ExcludingStatistics adds EXCLUDING STATISTICS to the LIKE clause.

func (LikeCreateTableBuilder) ExcludingStorage added in v0.16.0 

func (b LikeCreateTableBuilder) ExcludingStorage() LikeCreateTableBuilder

ExcludingStorage adds EXCLUDING STORAGE to the LIKE clause.

func (LikeCreateTableBuilder) IncludingAll added in v0.16.0 

func (b LikeCreateTableBuilder) IncludingAll() LikeCreateTableBuilder

IncludingAll adds INCLUDING ALL to the LIKE clause.

func (LikeCreateTableBuilder) IncludingComments added in v0.16.0 

func (b LikeCreateTableBuilder) IncludingComments() LikeCreateTableBuilder

IncludingComments adds INCLUDING COMMENTS to the LIKE clause.

func (LikeCreateTableBuilder) IncludingCompression added in v0.16.0 

func (b LikeCreateTableBuilder) IncludingCompression() LikeCreateTableBuilder

IncludingCompression adds INCLUDING COMPRESSION to the LIKE clause.

func (LikeCreateTableBuilder) IncludingConstraints added in v0.16.0 

func (b LikeCreateTableBuilder) IncludingConstraints() LikeCreateTableBuilder

IncludingConstraints adds INCLUDING CONSTRAINTS to the LIKE clause.

func (LikeCreateTableBuilder) IncludingDefaults added in v0.16.0 

func (b LikeCreateTableBuilder) IncludingDefaults() LikeCreateTableBuilder

IncludingDefaults adds INCLUDING DEFAULTS to the LIKE clause.

func (LikeCreateTableBuilder) IncludingGenerated added in v0.16.0 

func (b LikeCreateTableBuilder) IncludingGenerated() LikeCreateTableBuilder

IncludingGenerated adds INCLUDING GENERATED to the LIKE clause.

func (LikeCreateTableBuilder) IncludingIdentity added in v0.16.0 

func (b LikeCreateTableBuilder) IncludingIdentity() LikeCreateTableBuilder

IncludingIdentity adds INCLUDING IDENTITY to the LIKE clause.

func (LikeCreateTableBuilder) IncludingIndexes added in v0.16.0 

func (b LikeCreateTableBuilder) IncludingIndexes() LikeCreateTableBuilder

IncludingIndexes adds INCLUDING INDEXES to the LIKE clause.

func (LikeCreateTableBuilder) IncludingStatistics added in v0.16.0 

func (b LikeCreateTableBuilder) IncludingStatistics() LikeCreateTableBuilder

IncludingStatistics adds INCLUDING STATISTICS to the LIKE clause.

func (LikeCreateTableBuilder) IncludingStorage added in v0.16.0 

func (b LikeCreateTableBuilder) IncludingStorage() LikeCreateTableBuilder

IncludingStorage adds INCLUDING STORAGE to the LIKE clause.

type MatchingBuilder 

type MatchingBuilder interface {
	Exp
	Escape(escapeCharacter rune) MatchingBuilder
}

type OnConflictDoUpdateInsertBuilder added in v0.2.0 

type OnConflictDoUpdateInsertBuilder struct {
	InsertBuilder
}

func (OnConflictDoUpdateInsertBuilder) Set added in v0.2.0 

func (b OnConflictDoUpdateInsertBuilder) Set(columnName string, value Exp) OnConflictDoUpdateInsertBuilder

Set adds a SET column = value to the DO UPDATE conflict action.

func (OnConflictDoUpdateInsertBuilder) Where added in v0.2.0 

func (b OnConflictDoUpdateInsertBuilder) Where(cond Exp) OnConflictDoUpdateInsertBuilder

Where adds a WHERE condition to the DO UPDATE conflict action. Multiple calls to Where are joined with AND.

type OnConflictInsertBuilder added in v0.2.0 

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

func (OnConflictInsertBuilder) DoNothing added in v0.2.0 

func (b OnConflictInsertBuilder) DoNothing() InsertBuilder

func (OnConflictInsertBuilder) DoUpdate added in v0.2.0 

func (b OnConflictInsertBuilder) DoUpdate() OnConflictDoUpdateInsertBuilder

func (OnConflictInsertBuilder) OnConstraint added in v0.2.0 

func (b OnConflictInsertBuilder) OnConstraint(constraintName string) OnConflictInsertBuilder

func (OnConflictInsertBuilder) Where added in v0.2.0 

func (b OnConflictInsertBuilder) Where(cond Exp) OnConflictInsertBuilder

Where adds a WHERE condition as the index predicate to the conflict target. Multiple calls to Where are joined with AND.

type Operator 

type Operator string

type OrderByAggBuilder added in v0.12.0 

type OrderByAggBuilder struct {
	AggBuilder
}

func (OrderByAggBuilder) Asc added in v0.12.0 

func (b OrderByAggBuilder) Asc() OrderByAggBuilder

func (OrderByAggBuilder) Desc added in v0.12.0 

func (b OrderByAggBuilder) Desc() OrderByAggBuilder

func (OrderByAggBuilder) NullsFirst added in v0.12.0 

func (b OrderByAggBuilder) NullsFirst() OrderByAggBuilder

func (OrderByAggBuilder) NullsLast added in v0.12.0 

func (b OrderByAggBuilder) NullsLast() OrderByAggBuilder

type OrderBySelectBuilder 

type OrderBySelectBuilder struct {
	SelectBuilder
}

func (OrderBySelectBuilder) Asc 

func (b OrderBySelectBuilder) Asc() OrderBySelectBuilder

func (OrderBySelectBuilder) Desc 

func (b OrderBySelectBuilder) Desc() OrderBySelectBuilder

func (OrderBySelectBuilder) NullsFirst 

func (b OrderBySelectBuilder) NullsFirst() OrderBySelectBuilder

func (OrderBySelectBuilder) NullsLast 

func (b OrderBySelectBuilder) NullsLast() OrderBySelectBuilder

type OrderByWindowFuncCallBuilder added in v0.11.0 

type OrderByWindowFuncCallBuilder struct {
	WindowFuncCallBuilder
}

func (OrderByWindowFuncCallBuilder) Asc added in v0.11.0 

func (b OrderByWindowFuncCallBuilder) Asc() OrderByWindowFuncCallBuilder

func (OrderByWindowFuncCallBuilder) Desc added in v0.11.0 

func (b OrderByWindowFuncCallBuilder) Desc() OrderByWindowFuncCallBuilder

func (OrderByWindowFuncCallBuilder) NullsFirst added in v0.11.0 

func (b OrderByWindowFuncCallBuilder) NullsFirst() OrderByWindowFuncCallBuilder

func (OrderByWindowFuncCallBuilder) NullsLast added in v0.11.0 

func (b OrderByWindowFuncCallBuilder) NullsLast() OrderByWindowFuncCallBuilder

type OrderByWindowSelectBuilder added in v0.11.0 

type OrderByWindowSelectBuilder struct {
	WindowSelectBuilder
}

func (OrderByWindowSelectBuilder) Asc added in v0.11.0 

func (b OrderByWindowSelectBuilder) Asc() OrderByWindowSelectBuilder

func (OrderByWindowSelectBuilder) Desc added in v0.11.0 

func (b OrderByWindowSelectBuilder) Desc() OrderByWindowSelectBuilder

func (OrderByWindowSelectBuilder) NullsFirst added in v0.11.0 

func (b OrderByWindowSelectBuilder) NullsFirst() OrderByWindowSelectBuilder

func (OrderByWindowSelectBuilder) NullsLast added in v0.11.0 

func (b OrderByWindowSelectBuilder) NullsLast() OrderByWindowSelectBuilder

type Precedencer added in v0.7.0 

type Precedencer interface {
	Precedence() int
}

type QueryBuilder 

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

func Build 

func Build(builder SQLWriter) *QueryBuilder

Build starts a new query builder based on the given SQLWriter. For executing the query, use qrbpgx.Build or qrbsql.Build which can set an executor specific to a driver.

func (*QueryBuilder) PrettyPrint added in v0.10.1 

func (b *QueryBuilder) PrettyPrint() *QueryBuilder

PrettyPrint indents the generated SQL for better readability.

Note: For now this only has an effect for insert statements.

func (*QueryBuilder) ToSQL 

func (b *QueryBuilder) ToSQL() (sql string, args []any, err error)

func (*QueryBuilder) WithNamedArgs 

func (b *QueryBuilder) WithNamedArgs(args map[string]any) *QueryBuilder

func (*QueryBuilder) WithoutValidation 

func (b *QueryBuilder) WithoutValidation() *QueryBuilder

WithoutValidation disables validation of the query while building.

Errors might still occur when building the query, but no additional validation (like validating identifiers) will be performed.

type ReferencesAlterTableBuilder added in v0.15.0 

type ReferencesAlterTableBuilder struct {
	AlterTableBuilder
}

ReferencesAlterTableBuilder provides ON DELETE/ON UPDATE for ALTER TABLE ADD COLUMN REFERENCES.

func (ReferencesAlterTableBuilder) OnDelete added in v0.15.0 

func (b ReferencesAlterTableBuilder) OnDelete(action string) ReferencesAlterTableBuilder

OnDelete adds ON DELETE action.

func (ReferencesAlterTableBuilder) OnUpdate added in v0.15.0 

func (b ReferencesAlterTableBuilder) OnUpdate(action string) ReferencesAlterTableBuilder

OnUpdate adds ON UPDATE action.

type ReferencesConstraintAlterTableBuilder added in v0.15.0 

type ReferencesConstraintAlterTableBuilder struct {
	AlterTableBuilder
}

ReferencesConstraintAlterTableBuilder provides ON DELETE/ON UPDATE for ALTER TABLE ADD CONSTRAINT ... FOREIGN KEY ... REFERENCES.

func (ReferencesConstraintAlterTableBuilder) OnDelete added in v0.15.0 

func (b ReferencesConstraintAlterTableBuilder) OnDelete(action string) ReferencesConstraintAlterTableBuilder

OnDelete adds ON DELETE action.

func (ReferencesConstraintAlterTableBuilder) OnUpdate added in v0.15.0 

func (b ReferencesConstraintAlterTableBuilder) OnUpdate(action string) ReferencesConstraintAlterTableBuilder

OnUpdate adds ON UPDATE action.

type ReferencesConstraintCreateTableBuilder added in v0.15.0 

type ReferencesConstraintCreateTableBuilder struct {
	CreateTableBuilder
}

ReferencesConstraintCreateTableBuilder provides ON DELETE/ON UPDATE for table-level FOREIGN KEY constraints.

func (ReferencesConstraintCreateTableBuilder) OnDelete added in v0.15.0 

func (b ReferencesConstraintCreateTableBuilder) OnDelete(action string) ReferencesConstraintCreateTableBuilder

OnDelete adds ON DELETE action to the last table-level FOREIGN KEY constraint.

func (ReferencesConstraintCreateTableBuilder) OnUpdate added in v0.15.0 

func (b ReferencesConstraintCreateTableBuilder) OnUpdate(action string) ReferencesConstraintCreateTableBuilder

OnUpdate adds ON UPDATE action to the last table-level FOREIGN KEY constraint.

type ReferencesCreateTableBuilder added in v0.15.0 

type ReferencesCreateTableBuilder struct {
	CreateTableBuilder
}

ReferencesCreateTableBuilder is returned after adding REFERENCES, providing ON DELETE/ON UPDATE methods.

func (ReferencesCreateTableBuilder) OnDelete added in v0.15.0 

func (b ReferencesCreateTableBuilder) OnDelete(action string) ReferencesCreateTableBuilder

OnDelete adds ON DELETE action to the last column's REFERENCES constraint.

func (ReferencesCreateTableBuilder) OnUpdate added in v0.15.0 

func (b ReferencesCreateTableBuilder) OnUpdate(action string) ReferencesCreateTableBuilder

OnUpdate adds ON UPDATE action to the last column's REFERENCES constraint.

type ReturningDeleteBuilder added in v0.2.0 

type ReturningDeleteBuilder struct {
	DeleteBuilder
}

func (ReturningDeleteBuilder) As added in v0.2.0 

func (b ReturningDeleteBuilder) As(outputName string) DeleteBuilder

As sets the output name for the last output expression.

type ReturningInsertBuilder added in v0.2.0 

type ReturningInsertBuilder struct {
	InsertBuilder
}

func (ReturningInsertBuilder) As added in v0.2.0 

func (b ReturningInsertBuilder) As(outputName string) InsertBuilder

As sets the output name for the last output expression.

type ReturningUpdateBuilder added in v0.2.0 

type ReturningUpdateBuilder struct {
	UpdateBuilder
}

func (ReturningUpdateBuilder) As added in v0.2.0 

func (b ReturningUpdateBuilder) As(outputName string) UpdateBuilder

As sets the output name for the last output expression.

type RowsFromBuilder 

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

func NewRowsFromBuilder 

func NewRowsFromBuilder(fns ...FuncBuilder) RowsFromBuilder

func (RowsFromBuilder) WithOrdinality 

func (r RowsFromBuilder) WithOrdinality() RowsFromBuilder

func (RowsFromBuilder) WriteSQL 

func (r RowsFromBuilder) WriteSQL(sb *SQLBuilder)

type SQLBuilder 

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

func (*SQLBuilder) AddError 

func (b *SQLBuilder) AddError(err error)

func (*SQLBuilder) BindPlaceholder 

func (b *SQLBuilder) BindPlaceholder(name string) string

func (*SQLBuilder) CreatePlaceholder 

func (b *SQLBuilder) CreatePlaceholder(argument any) string

func (*SQLBuilder) Validating 

func (b *SQLBuilder) Validating() bool

func (*SQLBuilder) WriteRune 

func (b *SQLBuilder) WriteRune(r rune)

func (*SQLBuilder) WriteString 

func (b *SQLBuilder) WriteString(s string)

type SQLWriter 

type SQLWriter interface {
	WriteSQL(sb *SQLBuilder)
}

type SelectBuilder 

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

func (SelectBuilder) AppendWith added in v0.2.0 

func (b SelectBuilder) AppendWith(w WithBuilder) SelectBuilder

AppendWith adds the given with queries to the select builder.

func (SelectBuilder) ApplyIf 

func (b SelectBuilder) ApplyIf(cond bool, apply func(q SelectBuilder) SelectBuilder) SelectBuilder

ApplyIf applies the given function to the builder if the condition is true. It returns the builder itself if the condition is false, otherwise it returns the result of the function. It's especially helpful for building a query conditionally.

func (SelectBuilder) ApplySelectJson added in v0.2.0 

func (b SelectBuilder) ApplySelectJson(apply func(obj JsonBuildObjectBuilder) JsonBuildObjectBuilder) SelectJsonSelectBuilder

ApplySelectJson applies the given function to the current JSON selection (empty JsonBuildObjectBuilder if none set).

func (SelectBuilder) CrossJoin added in v0.3.4 

func (b SelectBuilder) CrossJoin(from FromExp) JoinSelectBuilder

func (SelectBuilder) CrossJoinLateral added in v0.3.4 

func (b SelectBuilder) CrossJoinLateral(from FromExp) JoinSelectBuilder

func (SelectBuilder) Except 

func (b SelectBuilder) Except() CombinationBuilder

func (SelectBuilder) ForKeyShare added in v0.6.0 

func (b SelectBuilder) ForKeyShare() ForSelectBuilder

func (SelectBuilder) ForNoKeyUpdate added in v0.6.0 

func (b SelectBuilder) ForNoKeyUpdate() ForSelectBuilder

func (SelectBuilder) ForShare added in v0.6.0 

func (b SelectBuilder) ForShare() ForSelectBuilder

func (SelectBuilder) ForUpdate added in v0.6.0 

func (b SelectBuilder) ForUpdate() ForSelectBuilder

func (SelectBuilder) From 

func (b SelectBuilder) From(from FromExp) FromSelectBuilder

func (SelectBuilder) FromLateral 

func (b SelectBuilder) FromLateral(from FromLateralExp) FromSelectBuilder

func (SelectBuilder) FromOnly 

func (b SelectBuilder) FromOnly(from FromExp) FromSelectBuilder

func (SelectBuilder) FullJoin 

func (b SelectBuilder) FullJoin(from FromExp) JoinSelectBuilder

func (SelectBuilder) GroupBy 

func (b SelectBuilder) GroupBy(exps ...Exp) GroupyBySelectBuilder

GroupBy adds a grouping element for the given expressions to the GROUP BY clause. If no expressions are given, special grouping elements can be added via GroupyBySelectBuilder. Use GroupyBySelectBuilder.Empty to add an empty grouping element.

func (SelectBuilder) Having 

func (b SelectBuilder) Having(cond Exp) SelectBuilder

Having adds a HAVING condition to the query. Multiple calls to Having are joined with AND.

func (SelectBuilder) Intersect 

func (b SelectBuilder) Intersect() CombinationBuilder

func (SelectBuilder) IsEmpty added in v0.10.1 

func (b SelectBuilder) IsEmpty() bool

func (SelectBuilder) IsExp 

func (b SelectBuilder) IsExp()

func (SelectBuilder) Join 

func (b SelectBuilder) Join(from FromExp) JoinSelectBuilder

func (SelectBuilder) JoinLateral 

func (b SelectBuilder) JoinLateral(from FromExp) JoinSelectBuilder

func (SelectBuilder) LeftJoin 

func (b SelectBuilder) LeftJoin(from FromExp) JoinSelectBuilder

func (SelectBuilder) LeftJoinLateral 

func (b SelectBuilder) LeftJoinLateral(from FromExp) JoinSelectBuilder

func (SelectBuilder) Limit 

func (b SelectBuilder) Limit(exp Exp) SelectBuilder

func (SelectBuilder) Offset 

func (b SelectBuilder) Offset(exp Exp) SelectBuilder

func (SelectBuilder) OrderBy 

func (b SelectBuilder) OrderBy(exp Exp) OrderBySelectBuilder

func (SelectBuilder) RightJoin 

func (b SelectBuilder) RightJoin(from FromExp) JoinSelectBuilder

func (SelectBuilder) Select 

func (b SelectBuilder) Select(exps ...Exp) SelectSelectBuilder

Select adds the given expressions to the select list.

func (SelectBuilder) Union 

func (b SelectBuilder) Union() CombinationBuilder

func (SelectBuilder) Where 

func (b SelectBuilder) Where(cond Exp) SelectBuilder

Where adds a WHERE condition to the query. Multiple calls to Where are joined with AND.

func (SelectBuilder) Window added in v0.11.0 

func (b SelectBuilder) Window(name string) WindowSelectBuilder

func (SelectBuilder) WriteSQL 

func (b SelectBuilder) WriteSQL(sb *SQLBuilder)

WriteSQL writes the select as an expression.

type SelectDistinctBuilder 

type SelectDistinctBuilder struct {
	SelectBuilder
}

func (SelectDistinctBuilder) On 

func (b SelectDistinctBuilder) On(exp Exp, exps ...Exp) SelectBuilder

type SelectExp added in v0.2.0 

type SelectExp interface {
	Exp
	// contains filtered or unexported methods
}

type SelectJsonSelectBuilder 

type SelectJsonSelectBuilder struct {
	SelectBuilder
}

func (SelectJsonSelectBuilder) As 

func (b SelectJsonSelectBuilder) As(alias string) SelectJsonSelectBuilder

type SelectOrExpressions added in v0.2.0 

type SelectOrExpressions interface {
	Exp
	// contains filtered or unexported methods
}

type SelectSelectBuilder 

type SelectSelectBuilder struct {
	SelectBuilder
}

func (SelectSelectBuilder) As 

func (b SelectSelectBuilder) As(alias string) SelectSelectBuilder

func (SelectSelectBuilder) Distinct 

func (b SelectSelectBuilder) Distinct() SelectDistinctBuilder

type UpdateBuilder 

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

func Update 

func Update(tableName Identer) UpdateBuilder

func (UpdateBuilder) ApplyIf added in v0.8.0 

func (b UpdateBuilder) ApplyIf(cond bool, apply func(q UpdateBuilder) UpdateBuilder) UpdateBuilder

ApplyIf applies the given function to the builder if the condition is true. It returns the builder itself if the condition is false, otherwise it returns the result of the function. It's especially helpful for building a query conditionally.

func (UpdateBuilder) As 

func (b UpdateBuilder) As(alias string) UpdateBuilder

func (UpdateBuilder) From added in v0.2.0 

func (b UpdateBuilder) From(from FromExp) FromUpdateBuilder

func (UpdateBuilder) Returning added in v0.2.0 

func (b UpdateBuilder) Returning(outputExpression Exp) ReturningUpdateBuilder

func (UpdateBuilder) Set 

func (b UpdateBuilder) Set(columnName string, value Exp) UpdateBuilder

func (UpdateBuilder) SetMap 

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

SetMap sets the items in the set clause to the given map. It overwrites any previous set clause items.

func (UpdateBuilder) Where 

func (b UpdateBuilder) Where(cond Exp) UpdateBuilder

Where adds a WHERE condition to the update. Multiple calls to Where are joined with AND.

func (UpdateBuilder) WriteSQL 

func (b UpdateBuilder) WriteSQL(sb *SQLBuilder)

WriteSQL writes the update as an expression.

type WindowFuncBuilder added in v0.11.1 

type WindowFuncBuilder struct {
	// FuncCall is the base function / aggregate call
	FuncCall Exp
}

WindowFuncBuilder is the base builder for a window function (e.g. row_number()).

func (WindowFuncBuilder) Over added in v0.11.1 

func (b WindowFuncBuilder) Over(existingWindowName ...string) WindowFuncCallBuilder

type WindowFuncCallBuilder added in v0.11.0 

type WindowFuncCallBuilder struct {
	// FuncCall is the base function / aggregate call
	FuncCall Exp
	// contains filtered or unexported fields
}

func (WindowFuncCallBuilder) IsExp added in v0.11.0 

func (b WindowFuncCallBuilder) IsExp()

func (WindowFuncCallBuilder) OrderBy added in v0.11.0 

func (b WindowFuncCallBuilder) OrderBy(exp Exp) OrderByWindowFuncCallBuilder

func (WindowFuncCallBuilder) PartitionBy added in v0.11.0 

func (b WindowFuncCallBuilder) PartitionBy(exp Exp, exps ...Exp) WindowFuncCallBuilder

func (WindowFuncCallBuilder) WriteSQL added in v0.11.0 

func (b WindowFuncCallBuilder) WriteSQL(sb *SQLBuilder)

type WindowSelectBuilder added in v0.11.0 

type WindowSelectBuilder struct {
	SelectBuilder
}

func (WindowSelectBuilder) As added in v0.11.0 

func (b WindowSelectBuilder) As(existingWindowName ...string) WindowSelectBuilder

func (WindowSelectBuilder) OrderBy added in v0.11.0 

func (b WindowSelectBuilder) OrderBy(exp Exp) OrderByWindowSelectBuilder

func (WindowSelectBuilder) PartitionBy added in v0.11.0 

func (b WindowSelectBuilder) PartitionBy(exp Exp, exps ...Exp) WindowSelectBuilder

type WithBuilder 

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

WithBuilder builds the WITH clause.

func (WithBuilder) DeleteFrom added in v0.2.0 

func (b WithBuilder) DeleteFrom(tableName Identer) DeleteBuilder

DeleteFrom starts a new DeleteBuilder following the with clause.

func (WithBuilder) InsertInto added in v0.2.0 

func (b WithBuilder) InsertInto(tableName Identer) InsertBuilder

InsertInto starts a new InsertBuilder following the with clause.

func (WithBuilder) SearchBreadthFirst added in v0.2.0 

func (b WithBuilder) SearchBreadthFirst() WithSearchBuilder

func (WithBuilder) SearchDepthFirst added in v0.2.0 

func (b WithBuilder) SearchDepthFirst() WithSearchBuilder

func (WithBuilder) Select added in v0.2.0 

func (b WithBuilder) Select(exps ...Exp) SelectSelectBuilder

Select starts a new SelectBuilder following the with clause.

func (WithBuilder) Update added in v0.2.0 

func (b WithBuilder) Update(tableName Identer) UpdateBuilder

Update starts a new UpdateBuilder following the with clause.

func (WithBuilder) With added in v0.2.0 

func (b WithBuilder) With(queryName string) WithWithBuilder

With adds a WITH query to the with clause. The actual query must be supplied via As.

func (WithBuilder) WithRecursive added in v0.2.0 

func (b WithBuilder) WithRecursive(queryName string) WithWithBuilder

WithRecursive adds a WITH RECURSIVE query to the select builder. The actual query must be supplied via As.

type WithQuery 

type WithQuery interface {
	SQLWriter
	// contains filtered or unexported methods
}

type WithSearchBuilder 

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

func (WithSearchBuilder) By 

func (b WithSearchBuilder) By(columnName Exp, columnNames ...Exp) WithSearchByBuilder

type WithSearchByBuilder 

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

func (WithSearchByBuilder) Set 

func (b WithSearchByBuilder) Set(searchColumnName string) WithBuilder

type WithWithBuilder added in v0.2.0 

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

func With added in v0.2.0 

func With(queryName string) WithWithBuilder

With starts a new WITH clause.

func WithRecursive added in v0.2.0 

func WithRecursive(queryName string) WithWithBuilder

WithRecursive starts a new WITH RECURSIVE clause.

func (WithWithBuilder) As added in v0.2.0 

func (b WithWithBuilder) As(query WithQuery) WithBuilder

func (WithWithBuilder) AsMaterialized added in v0.2.0 

func (b WithWithBuilder) AsMaterialized(builder WithQuery) WithBuilder

func (WithWithBuilder) AsNotMaterialized added in v0.2.0 

func (b WithWithBuilder) AsNotMaterialized(builder WithQuery) WithBuilder

func (WithWithBuilder) ColumnNames added in v0.2.0 

func (b WithWithBuilder) ColumnNames(names ...string) WithWithBuilder

ColumnNames sets the column names for the currently started WITH query.

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.