sorm

package module

Go to main page

Versions in this module

v0

v0.5.0

Jul 13, 2026

Changes in this version

type DB

+ func Primary(db DB) DB

+ func Replica(db DB) DB

+ func WithReplicas(primary DB, replicas ...DB) DB

v0.4.0

Jul 13, 2026

Changes in this version

+ type AfterLoader interface

+ AfterLoad func(ctx context.Context) error

+ type BeforeSaver interface

+ BeforeSave func(ctx context.Context, op SaveOp) error

type DeleteBuilder

+ func (q DeleteBuilder[E]) Hard() DeleteBuilder[E]

type FromBuilder

+ func (q FromBuilder[E]) WithDeleted() FromBuilder[E]

type Meta

+ SetDeleted func(*E, time.Time)

+ SoftDeleteCol string

type Pred

+ func EqQ[E any, V comparable](c ColOfV[E, V], sub SubQ[V]) Pred[E]

+ func GtQ[E any, V comparable](c ColOfV[E, V], sub SubQ[V]) Pred[E]

+ func GteQ[E any, V comparable](c ColOfV[E, V], sub SubQ[V]) Pred[E]

+ func InQuery[E any, V comparable](c ColOfV[E, V], sub SubQ[V]) Pred[E]

+ func LtQ[E any, V comparable](c ColOfV[E, V], sub SubQ[V]) Pred[E]

+ func LteQ[E any, V comparable](c ColOfV[E, V], sub SubQ[V]) Pred[E]

+ func NeqQ[E any, V comparable](c ColOfV[E, V], sub SubQ[V]) Pred[E]

+ func NotInQuery[E any, V comparable](c ColOfV[E, V], sub SubQ[V]) Pred[E]

type QueryBuilder

+ func (q QueryBuilder[E]) ForUpdate() QueryBuilder[E]

+ func (q QueryBuilder[E]) ForUpdateSkipLocked() QueryBuilder[E]

+ func (q QueryBuilder[E]) OnlyDeleted() QueryBuilder[E]

+ func (q QueryBuilder[E]) WithDeleted() QueryBuilder[E]

+ type SaveOp int

+ const SaveDelete

+ const SaveInsert

+ const SaveUpdate

+ func (o SaveOp) String() string

+ type SubQ struct

+ func PickScalar[E any, V comparable](a AggExpr[E, V], q QueryBuilder[E]) SubQ[V]

+ func Pick[E any, V comparable](c ColOfV[E, V], q QueryBuilder[E]) SubQ[V]

type UpdateBuilder

+ func (q UpdateBuilder[E]) WithDeleted() UpdateBuilder[E]

+ type UpsertBuilder struct

+ func Upsert[E any](db DB) UpsertBuilder[E]

+ func (q UpsertBuilder[E]) DoNothing() UpsertBuilder[E]

+ func (q UpsertBuilder[E]) DoUpdate(cols ...ColOf[E]) UpsertBuilder[E]

+ func (q UpsertBuilder[E]) Exec(ctx context.Context) (int64, error)

+ func (q UpsertBuilder[E]) Named(name string) UpsertBuilder[E]

+ func (q UpsertBuilder[E]) OnConflict(cols ...ColOf[E]) UpsertBuilder[E]

+ func (q UpsertBuilder[E]) Rows(es ...*E) UpsertBuilder[E]

+ func (q UpsertBuilder[E]) ToSQL() (string, []any, error)

v0.3.0

Jul 12, 2026

Changes in this version

+ var ErrCyclicGraph = errors.New("sorm: cyclic dependency between new entities")

+ var ErrNotFound = errors.New("sorm: not found")

+ func Add[E any](s *Session, entities ...*E)

+ func ClonePtr[V any](p *V) *V

+ func CloneTimePtr(p *time.Time) *time.Time

+ func IsUniqueViolation(err error) bool

+ func JSONScan[T any](dst *T) sql.Scanner

+ func JSONSnapshot(v any) []byte

+ func JSONValue(v any) driver.Valuer

+ func PtrEq[V comparable](a, b *V) bool

+ func QueryNameFromContext(ctx context.Context) string

+ func RegisterTable(def TableDef)

+ func Register[E any](m Meta[E])

+ func Remove[E any](s *Session, entities ...*E)

+ func RunInTx(ctx context.Context, db DB, fn func(tx Tx) error) error

+ func SQLTypeFor(dialect string, c ColumnDef) string

+ func ScalarSnapshot(v driver.Valuer) any

+ func TimePtrEq(a, b *time.Time) bool

+ func UnregisterTable(name string)

+ func WithQueryName(ctx context.Context, name string) context.Context

+ type AggExpr struct

+ func Avg[E any](c AnyCol) AggExpr[E, float64]

+ func CountAll[E any]() AggExpr[E, int64]

+ func CountDistinct[E any](c AnyCol) AggExpr[E, int64]

+ func Count[E any](c AnyCol) AggExpr[E, int64]

+ func Max[E any, V comparable](c ColV[V]) AggExpr[E, V]

+ func Min[E any, V comparable](c ColV[V]) AggExpr[E, V]

+ func NewAgg[E any, V comparable](parts ...AggPart) AggExpr[E, V]

+ func Sum[E any, V comparable](c ColV[V]) AggExpr[E, V]

+ func (a AggExpr[E, V]) Eq(v V) Pred[E]

+ func (a AggExpr[E, V]) Gt(v V) Pred[E]

+ func (a AggExpr[E, V]) Gte(v V) Pred[E]

+ func (a AggExpr[E, V]) Lt(v V) Pred[E]

+ func (a AggExpr[E, V]) Lte(v V) Pred[E]

+ type AggPart struct

+ func AggArg(v any) AggPart

+ func AggCol(c AnyCol) AggPart

+ func AggDialect(name string) AggPart

+ func AggLit(s string) AggPart

+ func AggRaw(sql string) AggPart

+ type AnyCol interface

+ ColName func() string

+ type ArrayCol struct

+ func NewArrayCol[E any, V comparable](table, name string) ArrayCol[E, V]

+ func (c ArrayCol[E, V]) ColName() string

+ func (c ArrayCol[E, V]) Contains(vs ...V) Pred[E]

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

+ func (c ArrayCol[E, V]) IsNotNull() Pred[E]

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

+ func (c ArrayCol[E, V]) Overlaps(vs ...V) Pred[E]

+ func (c ArrayCol[E, V]) Set(vs []V) Assign[E]

+ func (c ArrayCol[E, V]) SetNull() Assign[E]

+ type Assign struct

+ type BatchItem struct

+ Args []any

+ Check func(rowsAffected int64) error

+ IDCount int

+ OnIDs func(ids []int64)

+ SQL string

+ type BelongsTo struct

+ func NewBelongsTo[C, P any](fkCol string, childFK func(*C) any, setParent func(*C, *P)) BelongsTo[C, P]

+ func (r BelongsTo[C, P]) Include(opts ...ChildOpt[P]) IncludeSpec[C]

+ func (r BelongsTo[C, P]) Is(preds ...Pred[P]) Pred[C]

+ type BytesCol struct

+ func NewBytesCol[E any](table, name string) BytesCol[E]

+ func (c BytesCol[E]) ColName() string

+ func (c BytesCol[E]) Eq(v []byte) Pred[E]

+ func (c BytesCol[E]) IsNotNull() Pred[E]

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

+ func (c BytesCol[E]) Neq(v []byte) Pred[E]

+ func (c BytesCol[E]) Set(v []byte) Assign[E]

+ func (c BytesCol[E]) SetNull() Assign[E]

+ type ChildOpt interface

+ type Col struct

+ func NewCol[E any, V comparable](table, name string) Col[E, V]

+ func (c Col[E, V]) Asc() Order[E]

+ func (c Col[E, V]) ColName() string

+ func (c Col[E, V]) Desc() Order[E]

+ func (c Col[E, V]) Eq(v V) Pred[E]

+ func (c Col[E, V]) In(vs ...V) Pred[E]

+ func (c Col[E, V]) IsNotNull() Pred[E]

+ func (c Col[E, V]) IsNull() Pred[E]

+ func (c Col[E, V]) Neq(v V) Pred[E]

+ func (c Col[E, V]) NotIn(vs ...V) Pred[E]

+ func (c Col[E, V]) Set(v V) Assign[E]

+ func (c Col[E, V]) SetNull() Assign[E]

+ type ColOf interface

+ type ColOfV interface

+ type ColV interface

+ type ColumnDef struct

+ Auto bool

+ GoKind string

+ Name string

+ Nullable bool

+ PK bool

+ RefCol string

+ RefTable string

+ SQLType string

+ Unique bool

+ type ConflictError struct

+ PK any

+ Table string

+ func (e *ConflictError) Error() string

+ type ConstraintError struct

+ Constraint string

+ Err error

+ Kind ConstraintKind

+ func (e *ConstraintError) Error() string

+ func (e *ConstraintError) Unwrap() error

+ type ConstraintKind int

+ const ConstraintCheck

+ const ConstraintForeignKey

+ const ConstraintNotNull

+ const ConstraintUnique

+ func (k ConstraintKind) String() string

+ type DB interface

+ Begin func(ctx context.Context) (Tx, error)

+ Dialect func() dialect.Dialect

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

+ ExecBatch func(ctx context.Context, items []BatchItem) error

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

+ func InSchema(db DB, schema string) DB

+ func Instrument(db DB, fn InstrumentFunc) DB

+ type DeleteBuilder struct

+ func Delete[E any](db DB) DeleteBuilder[E]

+ func (q DeleteBuilder[E]) AllRows() DeleteBuilder[E]

+ func (q DeleteBuilder[E]) Exec(ctx context.Context) (int64, error)

+ func (q DeleteBuilder[E]) Named(name string) DeleteBuilder[E]

+ func (q DeleteBuilder[E]) ToSQL() (string, []any, error)

+ func (q DeleteBuilder[E]) Where(ps ...Pred[E]) DeleteBuilder[E]

+ type FromBuilder struct

+ func From[E any](db DB) FromBuilder[E]

+ func (q FromBuilder[E]) GroupBy(cols ...ColOf[E]) FromBuilder[E]

+ func (q FromBuilder[E]) Having(ps ...Pred[E]) FromBuilder[E]

+ func (q FromBuilder[E]) Join(specs ...JoinSpec[E]) FromBuilder[E]

+ func (q FromBuilder[E]) Limit(n int) FromBuilder[E]

+ func (q FromBuilder[E]) Named(name string) FromBuilder[E]

+ func (q FromBuilder[E]) Offset(n int) FromBuilder[E]

+ func (q FromBuilder[E]) OrderBy(os ...Order[E]) FromBuilder[E]

+ func (q FromBuilder[E]) Where(ps ...Pred[E]) FromBuilder[E]

+ type HasMany struct

+ func NewHasMany[E, C any](fkCol string, parentKey func(*E) any, childKey func(*C) any, ...) HasMany[E, C]

+ func (r HasMany[E, C]) Any(preds ...Pred[C]) Pred[E]

+ func (r HasMany[E, C]) Include(opts ...ChildOpt[C]) IncludeSpec[E]

+ func (r HasMany[E, C]) InnerJoin(preds ...Pred[C]) JoinSpec[E]

+ func (r HasMany[E, C]) LeftJoin(preds ...Pred[C]) JoinSpec[E]

+ func (r HasMany[E, C]) None(preds ...Pred[C]) Pred[E]

+ type HasOne struct

+ func NewHasOne[E, C any](fkCol string, parentKey func(*E) any, childKey func(*C) any, ...) HasOne[E, C]

+ func (r HasOne[E, C]) Any(preds ...Pred[C]) Pred[E]

+ func (r HasOne[E, C]) Include(opts ...ChildOpt[C]) IncludeSpec[E]

+ func (r HasOne[E, C]) None(preds ...Pred[C]) Pred[E]

+ type IncludeSpec struct

+ type IndexDef struct

+ Columns []string

+ Name string

+ Parts []IndexPart

+ Type string

+ Unique bool

+ Where string

+ func (ix IndexDef) IndexParts() []IndexPart

+ type IndexPart struct

+ Column string

+ Desc bool

+ Expr string

+ type InstrumentFunc func(ctx context.Context, op Op, next func(ctx context.Context) error) error

+ type JSONArr struct

+ func NewJSONArr[E any](table, col, path string) JSONArr[E]

+ func (j JSONArr[E]) Contains(v any) Pred[E]

+ func (j JSONArr[E]) IsNotNull() Pred[E]

+ func (j JSONArr[E]) IsNull() Pred[E]

+ type JSONBool struct

+ func NewJSONBool[E any](table, col, path string) JSONBool[E]

+ func (j JSONBool[E]) Eq(v bool) Pred[E]

+ func (j JSONBool[E]) IsFalse() Pred[E]

+ func (j JSONBool[E]) IsNotNull() Pred[E]

+ func (j JSONBool[E]) IsNull() Pred[E]

+ func (j JSONBool[E]) IsTrue() Pred[E]

+ type JSONCol struct

+ func NewJSONCol[E any](table, name string) JSONCol[E]

+ func (c JSONCol[E]) ColName() string

+ func (c JSONCol[E]) Contains(v any) Pred[E]

+ func (c JSONCol[E]) HasKey(key string) Pred[E]

+ func (c JSONCol[E]) IsNotNull() Pred[E]

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

+ func (c JSONCol[E]) Path(path string) JSONPath[E]

+ func (c JSONCol[E]) Set(v any) Assign[E]

+ func (c JSONCol[E]) SetNull() Assign[E]

+ type JSONNum struct

+ func NewJSONNum[E any, V int64 | float64](table, col, path string) JSONNum[E, V]

+ func (j JSONNum[E, V]) Eq(v V) Pred[E]

+ func (j JSONNum[E, V]) Gt(v V) Pred[E]

+ func (j JSONNum[E, V]) Gte(v V) Pred[E]

+ func (j JSONNum[E, V]) IsNotNull() Pred[E]

+ func (j JSONNum[E, V]) IsNull() Pred[E]

+ func (j JSONNum[E, V]) Lt(v V) Pred[E]

+ func (j JSONNum[E, V]) Lte(v V) Pred[E]

+ func (j JSONNum[E, V]) Neq(v V) Pred[E]

+ type JSONPath struct

+ func (p JSONPath[E]) Eq(v string) Pred[E]

+ func (p JSONPath[E]) In(vs ...string) Pred[E]

+ func (p JSONPath[E]) IsNotNull() Pred[E]

+ func (p JSONPath[E]) IsNull() Pred[E]

+ func (p JSONPath[E]) Neq(v string) Pred[E]

+ type JSONStr struct

+ func NewJSONStr[E any](table, col, path string) JSONStr[E]

+ func (j JSONStr[E]) Eq(v string) Pred[E]

+ func (j JSONStr[E]) In(vs ...string) Pred[E]

+ func (j JSONStr[E]) IsNotNull() Pred[E]

+ func (j JSONStr[E]) IsNull() Pred[E]

+ func (j JSONStr[E]) Like(p string) Pred[E]

+ func (j JSONStr[E]) Neq(v string) Pred[E]

+ type JoinOn struct

+ func ColEq[C, E any, V comparable](joined ColOfV[C, V], existing ColOfV[E, V]) JoinOn[C, E]

+ type JoinSpec struct

+ func CrossJoin[C, E any]() JoinSpec[E]

+ func InnerJoinOn[C, E any](on JoinOn[C, E], preds ...Pred[C]) JoinSpec[E]

+ func LeftJoinOn[C, E any](on JoinOn[C, E], preds ...Pred[C]) JoinSpec[E]

+ type ManyToMany struct

+ func NewManyToMany[E, C any](joinTable, parentCol, childCol string, initSlice func(*E), ...) ManyToMany[E, C]

+ func (r ManyToMany[E, C]) Any(preds ...Pred[C]) Pred[E]

+ func (r ManyToMany[E, C]) Include(opts ...ChildOpt[C]) IncludeSpec[E]

+ func (r ManyToMany[E, C]) Link(ctx context.Context, db DB, parent *E, children ...*C) error

+ func (r ManyToMany[E, C]) Unlink(ctx context.Context, db DB, parent *E, children ...*C) error

+ type Meta struct

+ Auto bool

+ Diff func(any, *E) []int

+ GetVersion func(*E) int64

+ InsertCols []string

+ InsertValues func(*E) []any

+ PK string

+ PKValue func(*E) any

+ RefTables []string

+ Refs []Ref[E]

+ Scan func(*E) []any

+ SelectCols []string

+ SetPK func(*E, int64)

+ SetVersion func(*E, int64)

+ Snapshot func(*E) any

+ Table string

+ TouchCreate func(*E, time.Time)

+ TouchUpdate func(*E, time.Time)

+ ValuesFor func(*E, []int) []any

+ VersionCol string

+ func MetaOf[E any]() *Meta[E]

+ type Op struct

+ Args []any

+ Kind string

+ SQL string

+ Statements []string

+ type OrdCol struct

+ func NewOrdCol[E any, V comparable](table, name string) OrdCol[E, V]

+ func (c OrdCol[E, V]) Between(lo, hi V) Pred[E]

+ func (c OrdCol[E, V]) Gt(v V) Pred[E]

+ func (c OrdCol[E, V]) Gte(v V) Pred[E]

+ func (c OrdCol[E, V]) Lt(v V) Pred[E]

+ func (c OrdCol[E, V]) Lte(v V) Pred[E]

+ type Order struct

+ type Pred struct

+ func And[E any](ps ...Pred[E]) Pred[E]

+ func Not[E any](p Pred[E]) Pred[E]

+ func Or[E any](ps ...Pred[E]) Pred[E]

+ type ProjQuery struct

+ func Project[R any, E any](q FromBuilder[E], exprs ...SelectExpr[E]) ProjQuery[R]

+ func (q ProjQuery[R]) All(ctx context.Context) ([]*R, error)

+ func (q ProjQuery[R]) One(ctx context.Context) (*R, error)

+ func (q ProjQuery[R]) ToSQL() (string, []any, error)

+ type QueryBuilder struct

+ func Query[E any](db DB) QueryBuilder[E]

+ func Track[E any](s *Session) QueryBuilder[E]

+ func (q QueryBuilder[E]) All(ctx context.Context) ([]*E, error)

+ func (q QueryBuilder[E]) Count(ctx context.Context) (int64, error)

+ func (q QueryBuilder[E]) Iter(ctx context.Context) iter.Seq2[*E, error]

+ func (q QueryBuilder[E]) Limit(n int) QueryBuilder[E]

+ func (q QueryBuilder[E]) Named(name string) QueryBuilder[E]

+ func (q QueryBuilder[E]) Offset(n int) QueryBuilder[E]

+ func (q QueryBuilder[E]) One(ctx context.Context) (*E, error)

+ func (q QueryBuilder[E]) OrderBy(os ...Order[E]) QueryBuilder[E]

+ func (q QueryBuilder[E]) ToSQL() (string, []any)

+ func (q QueryBuilder[E]) Where(ps ...Pred[E]) QueryBuilder[E]

+ func (q QueryBuilder[E]) With(specs ...IncludeSpec[E]) QueryBuilder[E]

+ type RawQuery struct

+ func RawAs[R any](db DB, sql string, args ...any) RawQuery[R]

+ func Raw[E any](db DB, sql string, args ...any) RawQuery[E]

+ func (q RawQuery[T]) All(ctx context.Context) ([]*T, error)

+ func (q RawQuery[T]) Named(name string) RawQuery[T]

+ func (q RawQuery[T]) One(ctx context.Context) (*T, error)

+ type Ref struct

+ FKCol string

+ FKIsZero func(*E) bool

+ Nav func(*E) any

+ NavPK func(*E) any

+ NotNull bool

+ SetFK func(*E, any)

+ type Rows interface

+ Close func()

+ Columns func() []string

+ Err func() error

+ Next func() bool

+ Scan func(dest ...any) error

+ type ScalarCol struct

+ func NewScalarCol[E any, V any](table, name string) ScalarCol[E, V]

+ func (c ScalarCol[E, V]) Asc() Order[E]

+ func (c ScalarCol[E, V]) ColName() string

+ func (c ScalarCol[E, V]) Desc() Order[E]

+ func (c ScalarCol[E, V]) Eq(v V) Pred[E]

+ func (c ScalarCol[E, V]) Gt(v V) Pred[E]

+ func (c ScalarCol[E, V]) Gte(v V) Pred[E]

+ func (c ScalarCol[E, V]) In(vs ...V) Pred[E]

+ func (c ScalarCol[E, V]) IsNotNull() Pred[E]

+ func (c ScalarCol[E, V]) IsNull() Pred[E]

+ func (c ScalarCol[E, V]) Lt(v V) Pred[E]

+ func (c ScalarCol[E, V]) Lte(v V) Pred[E]

+ func (c ScalarCol[E, V]) Neq(v V) Pred[E]

+ func (c ScalarCol[E, V]) NotIn(vs ...V) Pred[E]

+ func (c ScalarCol[E, V]) Set(v V) Assign[E]

+ func (c ScalarCol[E, V]) SetNull() Assign[E]

+ type ScanError struct

+ Extra []string

+ Missing []string

+ func (e *ScanError) Error() string

+ type SelectExpr struct

+ func As[E any, V comparable](a AggExpr[E, V], alias string) SelectExpr[E]

+ func FieldAs[E any](c ColOf[E], alias string) SelectExpr[E]

+ func FieldOfAs[E any](c AnyCol, alias string) SelectExpr[E]

+ func FieldOf[E any](c AnyCol) SelectExpr[E]

+ func Field[E any](c ColOf[E]) SelectExpr[E]

+ type Session struct

+ func NewSession(db DB) *Session

+ func (s *Session) DB() DB

+ func (s *Session) SaveChanges(ctx context.Context) error

+ func (s *Session) SaveChangesTx(ctx context.Context, tx Tx) error

+ type Set struct

+ func NewSet[E any](s *Session) Set[E]

+ func (s Set[E]) Add(entities ...*E)

+ func (s Set[E]) All(ctx context.Context) ([]*E, error)

+ func (s Set[E]) Count(ctx context.Context) (int64, error)

+ func (s Set[E]) Find(ctx context.Context, pk any) (*E, error)

+ func (s Set[E]) Iter(ctx context.Context) iter.Seq2[*E, error]

+ func (s Set[E]) Limit(n int) QueryBuilder[E]

+ func (s Set[E]) Named(name string) QueryBuilder[E]

+ func (s Set[E]) NoTracking() QueryBuilder[E]

+ func (s Set[E]) OrderBy(os ...Order[E]) QueryBuilder[E]

+ func (s Set[E]) Query() QueryBuilder[E]

+ func (s Set[E]) Remove(entities ...*E)

+ func (s Set[E]) Where(ps ...Pred[E]) QueryBuilder[E]

+ func (s Set[E]) With(specs ...IncludeSpec[E]) QueryBuilder[E]

+ type StrCol struct

+ func NewStrCol[E any](table, name string) StrCol[E]

+ func (c StrCol[E]) Contains(s string) Pred[E]

+ func (c StrCol[E]) HasPrefix(s string) Pred[E]

+ func (c StrCol[E]) HasSuffix(s string) Pred[E]

+ func (c StrCol[E]) ILike(pattern string) Pred[E]

+ func (c StrCol[E]) Like(pattern string) Pred[E]

+ type TableDef struct

+ Columns []ColumnDef

+ Indexes []IndexDef

+ Name string

+ func Tables() []TableDef

+ type Tx interface

+ Commit func(ctx context.Context) error

+ Rollback func(ctx context.Context) error

+ type UpdateBuilder struct

+ func Update[E any](db DB) UpdateBuilder[E]

+ func (q UpdateBuilder[E]) AllRows() UpdateBuilder[E]

+ func (q UpdateBuilder[E]) Exec(ctx context.Context) (int64, error)

+ func (q UpdateBuilder[E]) Named(name string) UpdateBuilder[E]

+ func (q UpdateBuilder[E]) Set(as ...Assign[E]) UpdateBuilder[E]

+ func (q UpdateBuilder[E]) ToSQL() (string, []any, error)

+ func (q UpdateBuilder[E]) Where(ps ...Pred[E]) UpdateBuilder[E]

v0.2.0

Jul 12, 2026

v0.1.0

Jul 12, 2026

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