sqlb

package module

Go to main page

Versions in this module

v0

v0.10.0

Aug 5, 2026

Changes in this version

type Builder

+ func (b *Builder[T]) Resolved(ctx context.Context, db Executor) (*Builder[T], error)

type Delete

+ func (d *Delete[T]) Resolved(ctx context.Context, db Executor) (*Delete[T], error)

type Hooks

+ func (h *Hooks[T]) AfterDeleteRows(fn func(context.Context, []T) error) *Hooks[T]

type Update

+ func (u *Update[T]) Resolved(ctx context.Context, db Executor) (*Update[T], error)

v0.9.0

Aug 3, 2026

v0.8.0

Aug 2, 2026

Changes in this version

type ColumnInfo

+ Wire string

type Model

+ func (m *Model) ColumnByWire(wire string) *ColumnInfo

v0.7.0

Aug 1, 2026

Changes in this version

+ func PrincipalFrom[T any](ctx context.Context) (T, bool)

+ func WithPrincipal(ctx context.Context, p any) context.Context

v0.6.0

Aug 1, 2026

Changes in this version

type Builder

+ func (b *Builder[T]) WithComputed(names ...string) *Builder[T]

type ColumnInfo

+ PGType string

+ SortNulls NullsOrder

+ type ConflictRef struct

+ func Current(name string) ConflictRef

+ func Excluded(name string) ConflictRef

+ func (r ConflictRef) IsExcluded() bool

+ func (r ConflictRef) Name() string

type Description

+ func (d *Description[T]) SQLType(name string, columns ...string) *Description[T]

+ func (d *Description[T]) SortNullsFirst(columns ...string) *Description[T]

+ func (d *Description[T]) SortNullsLast(columns ...string) *Description[T]

type Expr

+ func Add(a, b Expr) Expr

+ func Now() Expr

+ func Sub(a, b Expr) Expr

+ func Val(v any) Expr

type Field

+ func (f Field) NotContainsJSON(doc string) Pred

+ func (f Field) NotHas(v any) Pred

+ func (f Field) NotHasAll(values ...any) Pred

+ func (f Field) NotHasAny(values ...any) Pred

type Insert

+ func (i *Insert[T]) OnConflictSet(column string, value Expr) *Insert[T]

+ type NullsOrder uint8

+ const NullsDefault

+ const NullsFirst

+ const NullsLast

v0.5.0

Jul 31, 2026

Changes in this version

type Builder

+ func (b *Builder[T]) Bind(key string, value any) *Builder[T]

+ func (b *Builder[T]) Bound() []string

type ColumnInfo

+ Expr string

+ Needs []string

+ func (c *ColumnInfo) Computed() bool

+ type Computed struct

+ Expr string

+ Name string

+ Needs []string

+ type Deriver interface

+ ComputedColumns func() []Computed

type Description

+ func (d *Description[T]) Computed(column, expr string, needs ...string) *Description[T]

type Model

+ Derived []*ColumnInfo

v0.4.0

Jul 30, 2026

Changes in this version

+ func RegisterVectorType(ctx context.Context, conn *pgx.Conn) error

+ func VectorPoolConfig(dsn string) (*pgxpool.Config, error)

type DB

+ func (d *DB) Exec(ctx context.Context, query string, args ...any) (pgconn.CommandTag, error)

+ func (d *DB) Query(ctx context.Context, query string, args ...any) (pgx.Rows, error)

type Executor

+ Exec func(ctx context.Context, sql string, args ...any) (pgconn.CommandTag, error)

+ Query func(ctx context.Context, sql string, args ...any) (pgx.Rows, error)

type Field

+ func (f Field) ContainsJSON(doc string) Pred

+ type Nearness struct

+ func Near(f Field, v Vector) Nearness

+ func (n Nearness) AtLeast(score float64) Pred

+ func (n Nearness) Distance() Selection

+ func (n Nearness) Nearest() Order

+ func (n Nearness) Similarity() Selection

+ type Vector []float32

+ func (v Vector) String() string

v0.3.0

Jul 30, 2026

v0.2.0

Jul 30, 2026

Changes in this version

+ var ErrAfterCommit = errors.New("sqlb: transaction committed, but an after-commit callback failed")

+ var ErrBadCursor = errors.New("sqlb: invalid cursor")

+ var ErrConstraint = errors.New("sqlb: constraint violated")

+ var ErrNotFound = errors.New("sqlb: no rows matched")

+ var ErrUnscoped = errors.New(...)

+ var SeqScanRowThreshold int64 = 1000

+ func AfterCommit(ctx context.Context, fn func(context.Context) error) error

+ func Array(values ...any) any

+ func Collect[R, T any](ctx context.Context, db Executor, b *Builder[T]) ([]R, error)

+ func Diagnostics(ds []PlanDiagnostic) string

+ func EncodeArray(v any) (string, error)

+ func SetErrorClassifier(fn ErrorClassifier)

+ type ArrayCol struct

+ func ArrayColumn[E any](name string) ArrayCol[E]

+ func (c ArrayCol[E]) Column() Column

+ func (c ArrayCol[E]) Eq(v []E) Pred

+ func (c ArrayCol[E]) Field() Field

+ func (c ArrayCol[E]) Has(v E) Pred

+ func (c ArrayCol[E]) HasAll(values ...E) Pred

+ func (c ArrayCol[E]) HasAny(values ...E) Pred

+ func (c ArrayCol[E]) IsNull() Pred

+ func (c ArrayCol[E]) Name() string

+ func (c ArrayCol[E]) Neq(v []E) Pred

+ func (c ArrayCol[E]) NotNull() Pred

+ func (c ArrayCol[E]) Qualify(table string) ArrayCol[E]

+ type Beginner interface

+ BeginTx func(ctx context.Context, opts *sql.TxOptions) (*sql.Tx, error)

+ type BetweenExpr struct

+ Hi Expr

+ Lo Expr

+ Not bool

+ Operand Expr

+ type Binary struct

+ Left Expr

+ Op string

+ Right Expr

+ type Builder struct

+ func Query[T any]() *Builder[T]

+ func (b *Builder[T]) After(c Cursor) *Builder[T]

+ func (b *Builder[T]) All(ctx context.Context, db Executor) ([]T, error)

+ func (b *Builder[T]) As(alias string) *Builder[T]

+ func (b *Builder[T]) ClearSelect() *Builder[T]

+ func (b *Builder[T]) Clone() *Builder[T]

+ func (b *Builder[T]) Count(ctx context.Context, db Executor) (int64, error)

+ func (b *Builder[T]) CursorFor(row T) (Cursor, error)

+ func (b *Builder[T]) Distinct() *Builder[T]

+ func (b *Builder[T]) Err() error

+ func (b *Builder[T]) Exists(ctx context.Context, db Executor) (bool, error)

+ func (b *Builder[T]) Expand(names ...string) *Builder[T]

+ func (b *Builder[T]) Expanded() []string

+ func (b *Builder[T]) Fail(err error) *Builder[T]

+ func (b *Builder[T]) First(ctx context.Context, db Executor) (T, error)

+ func (b *Builder[T]) ForShare() *Builder[T]

+ func (b *Builder[T]) ForUpdate() *Builder[T]

+ func (b *Builder[T]) GroupBy(fields ...Field) *Builder[T]

+ func (b *Builder[T]) GroupByExpr(exprs ...Expr) *Builder[T]

+ func (b *Builder[T]) Having(preds ...Pred) *Builder[T]

+ func (b *Builder[T]) Join(table, alias string, on Pred) *Builder[T]

+ func (b *Builder[T]) LeftJoin(table, alias string, on Pred) *Builder[T]

+ func (b *Builder[T]) Limit(n int) *Builder[T]

+ func (b *Builder[T]) Model() *Model

+ func (b *Builder[T]) Offset(n int) *Builder[T]

+ func (b *Builder[T]) One(ctx context.Context, db Executor) (T, error)

+ func (b *Builder[T]) OrderBy(orders ...Order) *Builder[T]

+ func (b *Builder[T]) OrderColumns() []string

+ func (b *Builder[T]) Page(number, size int) *Builder[T]

+ func (b *Builder[T]) SQL() (string, []any, error)

+ func (b *Builder[T]) Select(items ...Selectable) *Builder[T]

+ func (b *Builder[T]) SkipLocked() *Builder[T]

+ func (b *Builder[T]) Stable() *Builder[T]

+ func (b *Builder[T]) UseDialect(d Dialect) *Builder[T]

+ func (b *Builder[T]) Where(preds ...Pred) *Builder[T]

+ type Call struct

+ Args []Expr

+ Distinct bool

+ Name string

+ Star bool

+ type Cast struct

+ Inner Expr

+ Type string

+ type Col struct

+ func Typed[T any](name string) Col[T]

+ func (c Col[T]) Asc() Order

+ func (c Col[T]) Between(lo, hi T) Pred

+ func (c Col[T]) Column() Column

+ func (c Col[T]) Desc() Order

+ func (c Col[T]) Eq(v T) Pred

+ func (c Col[T]) EqCol(other Col[T]) Pred

+ func (c Col[T]) Field() Field

+ func (c Col[T]) Gt(v T) Pred

+ func (c Col[T]) Gte(v T) Pred

+ func (c Col[T]) IsNull() Pred

+ func (c Col[T]) Lt(v T) Pred

+ func (c Col[T]) Lte(v T) Pred

+ func (c Col[T]) Name() string

+ func (c Col[T]) Neq(v T) Pred

+ func (c Col[T]) NotNull() Pred

+ func (c Col[T]) NotOneOf(values ...T) Pred

+ func (c Col[T]) OneOf(values ...T) Pred

+ func (c Col[T]) Qualify(table string) Col[T]

+ type Collection struct

+ HasMore bool

+ Items []T

+ func (c Collection[T]) Len() int

+ type Column struct

+ Name string

+ Table string

+ type ColumnInfo struct

+ Expandable bool

+ Field string

+ Filterable bool

+ HasDefault bool

+ Hidden bool

+ Immutable bool

+ Index []int

+ Name string

+ Nullable bool

+ PrimaryKey bool

+ ReadOnly bool

+ Scoped bool

+ Searchable bool

+ SoftDelete bool

+ Sortable bool

+ Type reflect.Type

+ type Compilable interface

+ SQL func() (string, []any, error)

+ type ConstraintError struct

+ Column string

+ Constraint string

+ Detail string

+ Kind ConstraintKind

+ Table string

+ func (e *ConstraintError) Error() string

+ func (e *ConstraintError) Is(target error) bool

+ func (e *ConstraintError) Unwrap() error

+ type ConstraintKind string

+ const ConstraintCheck

+ const ConstraintExclusion

+ const ConstraintForeignKey

+ const ConstraintNotNull

+ const ConstraintUnique

+ func ConstraintKindOf(sqlstate string) (ConstraintKind, bool)

+ type Cursor string

+ func (c Cursor) IsZero() bool

+ type DB struct

+ func New(exec Executor) *DB

+ func TxFrom(ctx context.Context) (*DB, bool)

+ func (d *DB) AfterCommit(fn func(context.Context) error) error

+ func (d *DB) CanBeginTx() bool

+ func (d *DB) ExecContext(ctx context.Context, query string, args ...any) (sql.Result, error)

+ func (d *DB) Hooks() *Registry

+ func (d *DB) InTx() bool

+ func (d *DB) QueryContext(ctx context.Context, query string, args ...any) (*sql.Rows, error)

+ func (d *DB) Tx() (*sql.Tx, bool)

+ func (d *DB) WithHooks(r *Registry) *DB

+ func (d *DB) WithTx(ctx context.Context, fn func(ctx context.Context, tx *DB) error) error

+ func (d *DB) WithTxOptions(ctx context.Context, opts *sql.TxOptions, ...) error

+ type Delete struct

+ func DeleteRows[T any]() *Delete[T]

+ func (d *Delete[T]) Clone() *Delete[T]

+ func (d *Delete[T]) Everything() *Delete[T]

+ func (d *Delete[T]) Exec(ctx context.Context, db Executor) (int64, error)

+ func (d *Delete[T]) SQL() (string, []any, error)

+ func (d *Delete[T]) UseDialect(dl Dialect) *Delete[T]

+ func (d *Delete[T]) Where(preds ...Pred) *Delete[T]

+ type Description struct

+ func Describe[T any]() *Description[T]

+ func (d *Description[T]) Column(field, column string) *Description[T]

+ func (d *Description[T]) Defaulted(columns ...string) *Description[T]

+ func (d *Description[T]) Filterable(columns ...string) *Description[T]

+ func (d *Description[T]) Hidden(columns ...string) *Description[T]

+ func (d *Description[T]) Immutable(columns ...string) *Description[T]

+ func (d *Description[T]) Model() *Model

+ func (d *Description[T]) PrimaryKey(column string) *Description[T]

+ func (d *Description[T]) ReadOnly(columns ...string) *Description[T]

+ func (d *Description[T]) Relation(field, fkColumn string, opts ...RelationOption) *Description[T]

+ func (d *Description[T]) Scoped(column string) *Description[T]

+ func (d *Description[T]) Searchable(columns ...string) *Description[T]

+ func (d *Description[T]) SoftDeleted(column string) *Description[T]

+ func (d *Description[T]) Sortable(columns ...string) *Description[T]

+ func (d *Description[T]) Table(name string) *Description[T]

+ func (d *Description[T]) Timestamps(columns ...string) *Description[T]

+ type Dialect interface

+ Name func() string

+ Placeholder func(n int) string

+ QuoteIdent func(s string) string

+ type ErrorClassifier func(error) (ConstraintError, bool)

+ type Executor interface

+ ExecContext func(ctx context.Context, query string, args ...any) (sql.Result, error)

+ QueryContext func(ctx context.Context, query string, args ...any) (*sql.Rows, error)

+ type Expr interface

+ type Field struct

+ func F(name string) Field

+ func (f Field) Asc() Order

+ func (f Field) Between(lo, hi any) Pred

+ func (f Field) Cast(typ string) Expr

+ func (f Field) Column() Column

+ func (f Field) Contains(v string) Pred

+ func (f Field) Desc() Order

+ func (f Field) EndsWith(v string) Pred

+ func (f Field) Eq(v any) Pred

+ func (f Field) EqField(other Field) Pred

+ func (f Field) Gt(v any) Pred

+ func (f Field) Gte(v any) Pred

+ func (f Field) Has(v any) Pred

+ func (f Field) HasAll(values ...any) Pred

+ func (f Field) HasAny(values ...any) Pred

+ func (f Field) ILike(pattern string) Pred

+ func (f Field) IsNull() Pred

+ func (f Field) Like(pattern string) Pred

+ func (f Field) Lt(v any) Pred

+ func (f Field) Lte(v any) Pred

+ func (f Field) Name() string

+ func (f Field) Neq(v any) Pred

+ func (f Field) NotBetween(lo, hi any) Pred

+ func (f Field) NotNull() Pred

+ func (f Field) NotOneOf(values ...any) Pred

+ func (f Field) OneOf(values ...any) Pred

+ func (f Field) Qualify(table string) Field

+ func (f Field) StartsWith(v string) Pred

+ func (f Field) Table() string

+ type Hooks struct

+ func OnIn[T any](r *Registry) *Hooks[T]

+ func On[T any]() *Hooks[T]

+ func (h *Hooks[T]) AfterCreate(fn func(context.Context, *T) error) *Hooks[T]

+ func (h *Hooks[T]) AfterDelete(fn func(context.Context, int64) error) *Hooks[T]

+ func (h *Hooks[T]) AfterUpdate(fn func(context.Context, []T) error) *Hooks[T]

+ func (h *Hooks[T]) BeforeCreate(fn func(context.Context, *T) error) *Hooks[T]

+ func (h *Hooks[T]) BeforeDelete(fn func(context.Context, *Delete[T]) error) *Hooks[T]

+ func (h *Hooks[T]) BeforeQuery(fn func(context.Context, *Builder[T]) error) *Hooks[T]

+ func (h *Hooks[T]) BeforeUpdate(fn func(context.Context, *Update[T]) error) *Hooks[T]

+ func (h *Hooks[T]) Registered() RegisteredHooks

+ func (h *Hooks[T]) Reset()

+ type Insert struct

+ func InsertRows[T any](rows ...*T) *Insert[T]

+ func (i *Insert[T]) Exec(ctx context.Context, db Executor) ([]T, error)

+ func (i *Insert[T]) Omit(columns ...string) *Insert[T]

+ func (i *Insert[T]) OnConflictDoNothing(target ...string) *Insert[T]

+ func (i *Insert[T]) OnConflictUpdate(target []string, update ...string) *Insert[T]

+ func (i *Insert[T]) One(ctx context.Context, db Executor) (T, error)

+ func (i *Insert[T]) Only(columns ...string) *Insert[T]

+ func (i *Insert[T]) SQL() (string, []any, error)

+ func (i *Insert[T]) UseDialect(d Dialect) *Insert[T]

+ type List struct

+ Items []Expr

+ type Model struct

+ Columns []*ColumnInfo

+ PK *ColumnInfo

+ Relations []*RelationInfo

+ Scope *ColumnInfo

+ Soft *ColumnInfo

+ Table string

+ Type reflect.Type

+ func ModelOf[T any]() *Model

+ func (m *Model) Column(name string) *ColumnInfo

+ func (m *Model) ColumnNames() []string

+ func (m *Model) InUse() bool

+ func (m *Model) Relation(name string) *RelationInfo

+ func (m *Model) RelationNames() []string

+ func (m *Model) Selectable() []*ColumnInfo

+ type Order struct

+ func OrderBy(e Expr) Order

+ func OrderByDesc(e Expr) Order

+ func (o Order) NullsFirst() Order

+ func (o Order) NullsLast() Order

+ type Param struct

+ Value any

+ type Plan struct

+ ActualMS float64

+ ActualRows int64

+ Analyzed bool

+ Args []any

+ Nodes []PlanNode

+ PlanRows int64

+ Raw json.RawMessage

+ SQL string

+ TotalCost float64

+ func Explain(ctx context.Context, db Executor, q Compilable) (*Plan, error)

+ func ExplainAnalyze(ctx context.Context, db Executor, q Compilable) (*Plan, error)

+ func (p *Plan) Diagnostics() []PlanDiagnostic

+ func (p *Plan) String() string

+ func (p *Plan) UsesIndex(name string) bool

+ func (p *Plan) UsesSeqScan(relation string) bool

+ type PlanDiagnostic struct

+ Fix string

+ Message string

+ Node string

+ Rule string

+ func (d PlanDiagnostic) String() string

+ type PlanNode struct

+ ActualMS float64

+ ActualRows int64

+ Depth int

+ Filter string

+ Index string

+ PlanRows int64

+ Relation string

+ SortMethod string

+ SortSpace string

+ TotalCost float64

+ Type string

+ type Postgres struct

+ func (Postgres) Name() string

+ func (Postgres) Placeholder(n int) string

+ func (Postgres) QuoteIdent(s string) string

+ type Pred struct

+ func And(preds ...Pred) Pred

+ func If(cond bool, p Pred) Pred

+ func Not(p Pred) Pred

+ func Or(preds ...Pred) Pred

+ func RawPred(sql string, args ...any) Pred

+ func (p Pred) Expr() Expr

+ func (p Pred) IsZero() bool

+ type Raw struct

+ Args []any

+ SQL string

+ type RegisteredHooks struct

+ BeforeCreate bool

+ BeforeDelete bool

+ BeforeQuery bool

+ BeforeUpdate bool

+ func RegisteredFor[T any](exec Executor) RegisteredHooks

+ type Registry struct

+ func NewRegistry() *Registry

+ type RelationInfo struct

+ Collection bool

+ Elem reflect.Type

+ FK *ColumnInfo

+ Field string

+ Index []int

+ Limit int

+ Name string

+ Order string

+ OrderDesc bool

+ func (r *RelationInfo) Cap() int

+ func (r *RelationInfo) Target() (*Model, error)

+ type RelationOption func(*relationTag)

+ func ExpandLimit(n int) RelationOption

+ func ExpandOrder(column string) RelationOption

+ type Selectable interface

+ type Selection struct

+ func Avg(f Field) Selection

+ func Coalesce(exprs ...Expr) Selection

+ func Count() Selection

+ func CountDistinct(f Field) Selection

+ func CountOf(f Field) Selection

+ func Max(f Field) Selection

+ func Min(f Field) Selection

+ func RawSel(sql string, args ...any) Selection

+ func Sel(e Expr) Selection

+ func Sum(f Field) Selection

+ func (s Selection) Alias() string

+ func (s Selection) As(alias string) Selection

+ func (s Selection) Expr() Expr

+ type Tabler interface

+ TableName func() string

+ type TextCol struct

+ func TextColumn[T ~string](name string) TextCol[T]

+ func (c TextCol[T]) Contains(v string) Pred

+ func (c TextCol[T]) EndsWith(v string) Pred

+ func (c TextCol[T]) ILike(pattern string) Pred

+ func (c TextCol[T]) Like(pattern string) Pred

+ func (c TextCol[T]) StartsWith(v string) Pred

+ type Unary struct

+ Op string

+ Operand Expr

+ Postfix bool

+ type Update struct

+ func UpdateRows[T any]() *Update[T]

+ func (u *Update[T]) Clone() *Update[T]

+ func (u *Update[T]) Everything() *Update[T]

+ func (u *Update[T]) Exec(ctx context.Context, db Executor) ([]T, error)

+ func (u *Update[T]) One(ctx context.Context, db Executor) (T, error)

+ func (u *Update[T]) SQL() (string, []any, error)

+ func (u *Update[T]) Set(column string, value any) *Update[T]

+ func (u *Update[T]) SetExpr(column string, value Expr) *Update[T]

+ func (u *Update[T]) UseDialect(d Dialect) *Update[T]

+ func (u *Update[T]) Where(preds ...Pred) *Update[T]

v0.1.0

Jul 27, 2026

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL