drel

package module

Go to main page

Versions in this module

v0

v0.10.3

Oct 16, 2026

Changes in this version

type Tx

+ func (tx *Tx) Underlying() any

v0.10.2

Oct 16, 2026

v0.10.1

Sep 15, 2026

v0.10.0

Sep 15, 2026

Changes in this version

+ const DateLayout

+ type Date struct

+ func DateOf(t time.Time) Date

+ func NewDate(year int, month time.Month, day int) Date

+ func ParseDate(s string) (Date, error)

+ func Today() Date

+ func (d *Date) Scan(src any) error

+ func (d *Date) UnmarshalJSON(data []byte) error

+ func (d Date) AddDays(n int) Date

+ func (d Date) After(o Date) bool

+ func (d Date) Before(o Date) bool

+ func (d Date) Day() int

+ func (d Date) Equal(o Date) bool

+ func (d Date) IsZero() bool

+ func (d Date) MarshalJSON() ([]byte, error)

+ func (d Date) Month() time.Month

+ func (d Date) String() string

+ func (d Date) Time(loc *time.Location) time.Time

+ func (d Date) Value() (driver.Value, error)

+ func (d Date) Year() int

v0.9.0

Sep 14, 2026

Changes in this version

type Option

+ func WithSQLDB(db *sql.DB, dialectName string) Option

v0.8.1

Sep 14, 2026

v0.8.0

Sep 10, 2026

Changes in this version

type ModelMeta

+ KeyValues func(key any) []any

+ PKColumns []string

type ModelMetaBase

+ KeyValues func(key any) []any

+ PKColumns []string

v0.7.1

Sep 9, 2026

v0.7.0

Sep 9, 2026

Changes in this version

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

type Engine

+ func (e *Engine) ApplyMigrationsFS(ctx context.Context, fsys ...fs.FS) (int, error)

v0.6.0

Sep 8, 2026

Changes in this version

+ var ErrDuplicateMessage = errors.New("drel: the handler already processed this message")

+ var ErrNestedTxOptions = errors.New("drel: transaction options are not allowed on a nested WithTx call")

+ func ContextWithTx(ctx context.Context, tx *Tx) context.Context

+ func InboxSchema(table, dialect string) string

+ type ClaimedMessage struct

+ Attempts int

+ ID int64

+ PartitionKey string

+ Payload []byte

+ Type string

type Engine

+ func (e *Engine) WithTx(ctx context.Context, fn func(ctx context.Context) error, opts ...TxOption) error

+ type Inbox struct

+ func NewInbox(e *Engine, table string) *Inbox

+ func (i *Inbox) Claim(ctx context.Context, messageID, handler string) error

+ func (i *Inbox) Fail(ctx context.Context, messageID, handler string, cause error) error

+ func (i *Inbox) Purge(ctx context.Context, before time.Time) (int64, error)

type OutboxMessage

+ PartitionKey string

+ type Publisher interface

+ Publish func(ctx context.Context, msg ClaimedMessage) error

+ type PublisherFunc func(ctx context.Context, msg ClaimedMessage) error

+ func (f PublisherFunc) Publish(ctx context.Context, msg ClaimedMessage) error

+ type Relay struct

+ func NewRelay(e *Engine, table string, pub Publisher, opts ...RelayOption) *Relay

+ func (r *Relay) Run(ctx context.Context) error

+ func (r *Relay) RunOnce(ctx context.Context) (int, error)

+ type RelayOption func(*relayConfig)

+ func WithRelayBatchSize(n int) RelayOption

+ func WithRelayConcurrency(n int) RelayOption

+ func WithRelayLease(d time.Duration) RelayOption

+ func WithRelayMaxAttempts(n int) RelayOption

+ func WithRelayOnDead(fn func(ctx context.Context, msg ClaimedMessage, err error)) RelayOption

+ func WithRelayOnError(fn func(ctx context.Context, err error)) RelayOption

+ func WithRelayPollInterval(d time.Duration) RelayOption

+ func WithRelayWorkerID(id string) RelayOption

type Tx

+ func FromContext(ctx context.Context) (*Tx, bool)

+ func MustFromContext(ctx context.Context) *Tx

v0.5.0

Jun 15, 2026

Changes in this version

+ var ErrBatchNotExecuted = errors.New("drel: batch result read before Execute ran this query")

+ var ErrBatchPartial = errors.New("drel: one or more batched queries failed")

+ var ErrBulkUpdateRequiresFilter = fmt.Errorf(...)

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

+ var ErrInvalidPageSize = errors.New("drel: page size (Take/Limit) must be > 0")

+ var ErrOutboxAnonymousEvent = errors.New("drel: outbox event has no qualified type name (nil or anonymous type)")

+ var ErrRawArgMismatch = errors.New("drel: raw predicate placeholder/argument count mismatch")

+ var ErrUnknownProjectionColumn = errors.New("drel: projected column has no matching DTO field (db tag)")

+ func JSONEqual[T any](a, b T) bool

+ func NormalizeIntKey(v any) any

+ func NormalizeUUIDKey(v any) any

type AggExpr

+ func Count() AggExpr

+ func CountDistinct(col ColumnRef) AggExpr

+ func CountStar() AggExpr

+ type ComparableColumn struct

+ func NewComparableCol[T any](name string) ComparableColumn[T]

+ func (c ComparableColumn[T]) Asc() OrderExpr

+ func (c ComparableColumn[T]) Between(low, high T) Predicate

+ func (c ComparableColumn[T]) ColRef() ColumnRef

+ func (c ComparableColumn[T]) Desc() OrderExpr

+ func (c ComparableColumn[T]) Eq(v T) Predicate

+ func (c ComparableColumn[T]) GT(v T) Predicate

+ func (c ComparableColumn[T]) GTE(v T) Predicate

+ func (c ComparableColumn[T]) In(vs ...T) Predicate

+ func (c ComparableColumn[T]) IsNotNull() Predicate

+ func (c ComparableColumn[T]) IsNull() Predicate

+ func (c ComparableColumn[T]) LT(v T) Predicate

+ func (c ComparableColumn[T]) LTE(v T) Predicate

+ func (c ComparableColumn[T]) NEQ(v T) Predicate

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

+ func (c ComparableColumn[T]) NotIn(vs ...T) Predicate

type CursorPage

+ HasPrev bool

+ PreviousCursor string

type Engine

+ func (e *Engine) ApplyMigrations(ctx context.Context, dir string) (int, error)

+ func (e *Engine) DialectName() string

+ func (e *Engine) HealthCheck(ctx context.Context) error

+ func (e *Engine) Ping(ctx context.Context) error

+ func (e *Engine) Stats() PoolStats

+ func (e *Engine) TransactionWithRetry(ctx context.Context, fn func(tx *Tx) error, opts ...TxOption) error

type IncludableQuery

+ func (q *IncludableQuery[T]) Primary() *IncludableQuery[T]

+ type JSON struct

+ V *T

+ func (j JSON[T]) Scan(src any) error

+ func (j JSON[T]) Value() (driver.Value, error)

+ type JoinOn struct

type ModelMeta

+ NormalizeKey func(any) any

type ModelMetaBase

+ NormalizeKey func(any) any

type Option

+ func WithAfterCommitErrorSink(fn func(ctx context.Context, err error)) Option

+ func WithQueryTimeout(d time.Duration) Option

+ func WithSimpleProtocol() Option

type OrderExpr

+ func (o OrderExpr) NullsFirst() OrderExpr

+ func (o OrderExpr) NullsLast() OrderExpr

+ type PoolStats = driver.PoolStat

type Predicate

+ func RawErr(sql string, args ...any) (Predicate, error)

+ func True() Predicate

+ func WhereIf(cond bool, pred Predicate) Predicate

+ type QualifiedCol struct

+ func QualifiedColRef(table, column string) QualifiedCol

+ func (q QualifiedCol) EqCol(other QualifiedCol) JoinOn

+ func (q QualifiedCol) Qualified() string

+ func (q QualifiedCol) Ref() ColumnRef

type QueryBuilder

+ func (q *QueryBuilder[T]) AllRows() *QueryBuilder[T]

+ func (q *QueryBuilder[T]) Before(cursor string) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) Distinct() *QueryBuilder[T]

+ func (q *QueryBuilder[T]) InnerJoin(table string, on JoinOn) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) LeftJoin(table string, on JoinOn) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) Timeout(d time.Duration) *QueryBuilder[T]

type Repository

+ func (r *Repository[T]) AllRows() *QueryBuilder[T]

+ func (r *Repository[T]) Before(cursor string) *QueryBuilder[T]

+ func (r *Repository[T]) BulkInsertWithEvents(ctx context.Context, entities []*T) (int, error)

+ func (r *Repository[T]) Distinct() *QueryBuilder[T]

+ func (r *Repository[T]) InnerJoin(table string, on JoinOn) *QueryBuilder[T]

+ func (r *Repository[T]) LeftJoin(table string, on JoinOn) *QueryBuilder[T]

+ type RetryConfig struct

+ BaseDelay time.Duration

+ MaxAttempts int

+ MaxDelay time.Duration

+ type TimeColumn struct

+ func NewTimeCol(name string) TimeColumn

+ func (c TimeColumn) After(t time.Time) Predicate

+ func (c TimeColumn) Asc() OrderExpr

+ func (c TimeColumn) Before(t time.Time) Predicate

+ func (c TimeColumn) Between(low, high time.Time) Predicate

+ func (c TimeColumn) ColRef() ColumnRef

+ func (c TimeColumn) Desc() OrderExpr

+ func (c TimeColumn) Eq(v time.Time) Predicate

+ func (c TimeColumn) GT(v time.Time) Predicate

+ func (c TimeColumn) GTE(v time.Time) Predicate

+ func (c TimeColumn) In(vs ...time.Time) Predicate

+ func (c TimeColumn) IsNotNull() Predicate

+ func (c TimeColumn) IsNull() Predicate

+ func (c TimeColumn) LT(v time.Time) Predicate

+ func (c TimeColumn) LTE(v time.Time) Predicate

+ func (c TimeColumn) NEQ(v time.Time) Predicate

+ func (c TimeColumn) Name() string

+ func (c TimeColumn) NotIn(vs ...time.Time) Predicate

type Tx

+ func (tx *Tx) AdvisoryLock(ctx context.Context, key int64) error

+ func (tx *Tx) NewBatch() *Batch

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

+ func (tx *Tx) TryAdvisoryLock(ctx context.Context, key int64) (bool, error)

+ type TxIncludableQuery struct

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

+ func (q *TxIncludableQuery[T]) Find(ctx context.Context, id any) (*T, error)

+ func (q *TxIncludableQuery[T]) First(ctx context.Context) (*T, error)

+ func (q *TxIncludableQuery[T]) Include(rels ...IncludeSpec) *TxIncludableQuery[T]

+ func (q *TxIncludableQuery[T]) Limit(n int) *TxIncludableQuery[T]

+ func (q *TxIncludableQuery[T]) OrderBy(exprs ...OrderExpr) *TxIncludableQuery[T]

+ func (q *TxIncludableQuery[T]) Where(pred Predicate) *TxIncludableQuery[T]

type TxOption

+ func WithReadOnly() TxOption

+ func WithRetry(cfg RetryConfig) TxOption

type TxQueryBuilder

+ func (q *TxQueryBuilder[T]) Before(cursor string) *TxQueryBuilder[T]

+ func (q *TxQueryBuilder[T]) BulkDelete(ctx context.Context) (int, error)

+ func (q *TxQueryBuilder[T]) BulkUpdate(ctx context.Context, sets ...SetClause) (int, error)

type TxRepository

+ func (r *TxRepository[T]) BulkInsert(ctx context.Context, entities []*T) (int, error)

+ func (r *TxRepository[T]) BulkUpsert(ctx context.Context, entities []*T, opts ...UpsertOption) (int, error)

+ func (r *TxRepository[T]) Include(rels ...IncludeSpec) *TxIncludableQuery[T]

type UpsertOption

+ func DoNothing() UpsertOption

v0.4.0

Jun 3, 2026

Changes in this version

+ func SetKeyGenerator[T any](meta ModelMeta[T], gen func() any)

+ func SetKeyStrategy[T any](meta ModelMeta[T], s KeyStrategy)

+ func UUIDv7Key() any

+ type KeyStrategy uint8

+ const KeyAppAssigned

+ const KeyAutoIncrement

type Model

+ func (m *Model[K]) SetID(id K)

type ModelMeta

+ GenerateKey func() any

+ KeyIsZero func(*T) bool

+ KeyStrategy KeyStrategy

+ ScanGenerated func(*T, Row) error

+ SetKey func(*T, any)

type ModelMetaBase

+ GenerateKey func() any

+ KeyIsZero func(entity any) bool

+ KeyStrategy KeyStrategy

+ ScanGenerated func(entity any, row Row) error

+ SetKey func(entity any, key any)

type TxRepository

+ func Repo[T any](tx *Tx, meta ModelMeta[T]) *TxRepository[T]

v0.3.2

Jun 3, 2026

Changes in this version

+ var ErrCheckViolation = dberr.ErrCheckViolation

+ var ErrForeignKeyViolation = dberr.ErrForeignKeyViolation

+ var ErrNotNullViolation = dberr.ErrNotNullViolation

+ var ErrSerializationFailure = dberr.ErrSerializationFailure

+ var ErrUniqueViolation = dberr.ErrUniqueViolation

type Option

+ func WithConnMaxIdleTime(d time.Duration) Option

+ func WithConnMaxLifetime(d time.Duration) Option

+ func WithMaxConns(n int) Option

v0.3.1

Jun 3, 2026

v0.3.0

Jun 3, 2026

Changes in this version

+ var ErrCursorPaginationNeedsOrderBy = errors.New("drel: cursor pagination requires OrderBy")

+ var ErrInvalidCursor = errors.New("drel: invalid cursor")

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

+ var ErrPaginationNeedsLimit = errors.New("drel: pagination requires Take/Limit to set the page size")

+ func Aggregate[R any, T any](ctx context.Context, q *QueryBuilder[T], agg AggExpr) (R, error)

+ func GroupBy[R any, T any](ctx context.Context, q *QueryBuilder[T], groups []GroupSpec, aggs []AliasedAgg, ...) ([]*R, error)

+ func OutboxSchema(table, dialect string) string

+ func RawQueryRow[T any](ctx context.Context, e *Engine, sql string, args ...any) (*T, error)

+ func RawQuery[T any](ctx context.Context, e *Engine, sql string, args ...any) ([]*T, error)

+ func Select[R any, T any](ctx context.Context, q *QueryBuilder[T], cols ...ColumnRef) ([]*R, error)

+ type AggExpr struct

+ func Avg(col ColumnRef) AggExpr

+ func CountCol(col ColumnRef) AggExpr

+ func Max(col ColumnRef) AggExpr

+ func Min(col ColumnRef) AggExpr

+ func Sum(col ColumnRef) AggExpr

+ type AliasedAgg struct

+ func As(alias string, agg AggExpr) AliasedAgg

+ type Batch struct

+ func (b *Batch) Execute(ctx context.Context) error

+ type BatchResult struct

+ func BatchAll[T any](b *Batch, q *QueryBuilder[T]) *BatchResult[[]*T]

+ func BatchCount[T any](b *Batch, q *QueryBuilder[T]) *BatchResult[int]

+ func BatchFirst[T any](b *Batch, q *QueryBuilder[T]) *BatchResult[*T]

+ func (r *BatchResult[T]) Result() (T, error)

type BoolColumn

+ func (c BoolColumn) ColRef() ColumnRef

type Column

+ func (c Column[T]) ColRef() ColumnRef

+ type ColumnRef struct

+ func ColRef(name string) ColumnRef

+ func (c ColumnRef) Name() string

+ type CursorPage struct

+ HasMore bool

+ Items []*T

+ NextCursor string

type Engine

+ func (e *Engine) NewBatch() *Batch

+ func (e *Engine) NewUnitOfWork() *UnitOfWork

+ func (e *Engine) UseOutbox(table string, opts ...OutboxOption)

+ type EntityState int

+ type GroupByOpt func(*groupByConfig)

+ func Having(pred Predicate) GroupByOpt

+ type GroupSpec struct

+ func Group(col ColumnRef) GroupSpec

type IncludableQuery

+ func (q *IncludableQuery[T]) First(ctx context.Context) (*T, error)

+ func (q *IncludableQuery[T]) Include(rels ...IncludeSpec) *IncludableQuery[T]

+ func (q *IncludableQuery[T]) Limit(n int) *IncludableQuery[T]

+ func (q *IncludableQuery[T]) OrderBy(exprs ...OrderExpr) *IncludableQuery[T]

+ func (q *IncludableQuery[T]) Skip(n int) *IncludableQuery[T]

+ func (q *IncludableQuery[T]) Take(n int) *IncludableQuery[T]

+ func (q *IncludableQuery[T]) Unscoped() *IncludableQuery[T]

+ func (q *IncludableQuery[T]) Where(pred Predicate) *IncludableQuery[T]

+ func (q *IncludableQuery[T]) WithoutFilter(name string) *IncludableQuery[T]

type IncludeSpec

+ func (s IncludeSpec) Limit(n int) IncludeSpec

+ func (s IncludeSpec) OrderBy(exprs ...OrderExpr) IncludeSpec

+ func (s IncludeSpec) Then(children ...IncludeSpec) IncludeSpec

+ func (s IncludeSpec) Where(pred Predicate) IncludeSpec

+ func (s IncludeSpec) WithoutFilter(name string) IncludeSpec

+ type OffsetPage struct

+ HasMore bool

+ Items []*T

+ Page int

+ PageSize int

+ Total int

+ TotalPages int

type Option

+ func WithAuthToken(token string) Option

+ func WithDevMode() Option

+ func WithDialect(dia dialect.Dialect) Option

+ func WithDriver(drv driver.Driver) Option

+ func WithLogger(logger *slog.Logger) Option

+ func WithQueryLog(enabled bool) Option

+ func WithReadReplica(dsn string) Option

+ func WithSlowQueryThreshold(d time.Duration) Option

+ func WithTracer(tracer Tracer) Option

type OrderedColumn

+ func (c OrderedColumn[T]) ColRef() ColumnRef

+ type OutboxMessage struct

+ Payload any

+ Type string

+ type OutboxOption func(*outboxConfig)

+ func WithOutboxMapper(fn func(event any) (OutboxMessage, bool)) OutboxOption

type QueryBuilder

+ func (q *QueryBuilder[T]) After(cursor string) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) Page(ctx context.Context) (*CursorPage[T], error)

+ func (q *QueryBuilder[T]) PageOffset(ctx context.Context) (*OffsetPage[T], error)

+ func (q *QueryBuilder[T]) Primary() *QueryBuilder[T]

+ func (q *QueryBuilder[T]) Take(n int) *QueryBuilder[T]

type Repository

+ func (r *Repository[T]) After(cursor string) *QueryBuilder[T]

+ func (r *Repository[T]) Primary() *QueryBuilder[T]

+ func (r *Repository[T]) Skip(n int) *QueryBuilder[T]

+ func (r *Repository[T]) Take(n int) *QueryBuilder[T]

+ type Span interface

+ End func()

+ RecordError func(err error)

type StringColumn

+ func (c StringColumn) ColRef() ColumnRef

+ type Tracer interface

+ Start func(ctx context.Context, name string) (context.Context, Span)

type Tx

+ func (tx *Tx) Savepoint(ctx context.Context, name string, fn func(sp *Tx) error) error

type TxQueryBuilder

+ func (q *TxQueryBuilder[T]) After(cursor string) *TxQueryBuilder[T]

+ func (q *TxQueryBuilder[T]) AsNoTracking() *TxQueryBuilder[T]

+ func (q *TxQueryBuilder[T]) Page(ctx context.Context) (*CursorPage[T], error)

+ func (q *TxQueryBuilder[T]) PageOffset(ctx context.Context) (*OffsetPage[T], error)

+ func (q *TxQueryBuilder[T]) Take(n int) *TxQueryBuilder[T]

type TxRepository

+ func (r *TxRepository[T]) AsNoTracking() *TxQueryBuilder[T]

+ func (r *TxRepository[T]) Attach(entity *T, state EntityState)

+ func (r *TxRepository[T]) Detach(entity *T)

+ func (r *TxRepository[T]) OrderBy(exprs ...OrderExpr) *TxQueryBuilder[T]

+ type UnitOfWork struct

+ func (u *UnitOfWork) SaveChanges(ctx context.Context) (retErr error)

+ type UoWRepository struct

+ func NewUoWRepository[T any](uow *UnitOfWork, meta ModelMeta[T]) *UoWRepository[T]

+ func (r *UoWRepository[T]) Add(entity *T)

+ func (r *UoWRepository[T]) All(ctx context.Context) ([]*T, error)

+ func (r *UoWRepository[T]) AsNoTracking() *QueryBuilder[T]

+ func (r *UoWRepository[T]) Attach(entity *T, state EntityState)

+ func (r *UoWRepository[T]) Count(ctx context.Context) (int, error)

+ func (r *UoWRepository[T]) Detach(entity *T)

+ func (r *UoWRepository[T]) Exists(ctx context.Context) (bool, error)

+ func (r *UoWRepository[T]) Find(ctx context.Context, id any) (*T, error)

+ func (r *UoWRepository[T]) First(ctx context.Context) (*T, error)

+ func (r *UoWRepository[T]) HardRemove(entity *T) error

+ func (r *UoWRepository[T]) Include(rels ...IncludeSpec) *IncludableQuery[T]

+ func (r *UoWRepository[T]) OrderBy(exprs ...OrderExpr) *QueryBuilder[T]

+ func (r *UoWRepository[T]) Remove(entity *T) error

+ func (r *UoWRepository[T]) Unscoped() *QueryBuilder[T]

+ func (r *UoWRepository[T]) Where(pred Predicate) *QueryBuilder[T]

v0.1.0

May 11, 2026

Changes in this version

+ const StateAdded

+ const StateDeleted

+ const StateModified

+ const StateUnchanged

+ var ErrBulkDeleteRequiresFilter = fmt.Errorf(...)

+ var ErrConcurrencyConflict = errors.New("drel: concurrency conflict — entity was modified by another transaction")

+ var ErrEntityNotTracked = errors.New("drel: entity is not tracked")

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

+ var SoftDeleteFilter = NamedFilter

+ func ActorFromContext(ctx context.Context) string

+ func WithActor(ctx context.Context, actor string) context.Context

+ type AfterCommitHook func(ctx context.Context, events []any)

+ type Audit struct

+ func (a *Audit) AuditPtrs() (*string, *string)

+ func (a Audit) CreatedBy() string

+ func (a Audit) UpdatedBy() string

+ type BeforeCommitHook func(ctx context.Context, tx *Tx, events []any) error

+ type BoolColumn struct

+ func NewBoolCol(name string) BoolColumn

+ func (c BoolColumn) Asc() OrderExpr

+ func (c BoolColumn) Desc() OrderExpr

+ func (c BoolColumn) Eq(v bool) Predicate

+ func (c BoolColumn) IsFalse() Predicate

+ func (c BoolColumn) IsNotNull() Predicate

+ func (c BoolColumn) IsNull() Predicate

+ func (c BoolColumn) IsTrue() Predicate

+ func (c BoolColumn) NEQ(v bool) Predicate

+ func (c BoolColumn) Name() string

+ type Column struct

+ func NewCol[T any](name string) Column[T]

+ func (c Column[T]) Asc() OrderExpr

+ func (c Column[T]) Desc() OrderExpr

+ func (c Column[T]) Eq(v T) Predicate

+ func (c Column[T]) In(vs ...T) Predicate

+ func (c Column[T]) IsNotNull() Predicate

+ func (c Column[T]) IsNull() Predicate

+ func (c Column[T]) NEQ(v T) Predicate

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

+ func (c Column[T]) NotIn(vs ...T) Predicate

+ type Engine struct

+ func NewEngine(dsn string, opts ...Option) (*Engine, error)

+ func (e *Engine) Close()

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

+ func (e *Engine) OnAfterCommit(hook AfterCommitHook)

+ func (e *Engine) OnBeforeCommit(hook BeforeCommitHook)

+ func (e *Engine) OnQuery(hook QueryHook)

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

+ func (e *Engine) QueryRow(ctx context.Context, sql string, args ...any) Row

+ func (e *Engine) Transaction(ctx context.Context, fn func(tx *Tx) error, opts ...TxOption) (retErr error)

+ type EventRecorder interface

+ ClearEvents func()

+ PendingEvents func() []any

+ type FieldChange struct

+ Column string

+ Value any

+ type IncludableQuery struct

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

+ func (q *IncludableQuery[T]) Find(ctx context.Context, id any) (*T, error)

+ type IncludeSpec struct

+ func NewIncludeSpec(rel *RelationInfo) IncludeSpec

+ func (s IncludeSpec) Unscoped() IncludeSpec

+ type IsolationLevel int

+ const ReadCommitted

+ const RepeatableRead

+ const Serializable

+ type Model struct

+ func (m *Model[K]) ClearEvents()

+ func (m *Model[K]) PendingEvents() []any

+ func (m *Model[K]) RecordEvent(event any)

+ func (m *Model[K]) ScanPtrs() (*K, *time.Time, *time.Time)

+ func (m Model[K]) CreatedAt() time.Time

+ func (m Model[K]) ID() K

+ func (m Model[K]) UpdatedAt() time.Time

+ type ModelMeta struct

+ AuditSetCreate func(*T, string)

+ AuditSetUpdate func(*T, string)

+ ColumnValue func(*T, int) any

+ Columns []string

+ Diff func(*T, any) []FieldChange

+ Filters []NamedFilter

+ HasAudit bool

+ HasSoftDelete bool

+ HasVersioned bool

+ InsertColumns func(*T) ([]string, []any)

+ PKColumn string

+ PKValue func(*T) any

+ Scan func(Row) (*T, error)

+ ScanReturning func(*T, Row) error

+ SetVersion func(*T, int)

+ Snapshot func(*T) any

+ Table string

+ VersionValue func(*T) int

+ type ModelMetaBase struct

+ AuditSetCreate func(entity any, actor string)

+ AuditSetUpdate func(entity any, actor string)

+ ColumnValue func(entity any, colIdx int) any

+ Columns []string

+ Diff func(entity any, snapshot any) []FieldChange

+ Filters []NamedFilter

+ HasAudit bool

+ HasSoftDelete bool

+ HasVersioned bool

+ InsertColumns func(entity any) ([]string, []any)

+ PKColumn string

+ PKValue func(entity any) any

+ ScanReturning func(entity any, row Row) error

+ ScanRow func(Row) (any, error)

+ SetVersion func(entity any, v int)

+ Snapshot func(entity any) any

+ Table string

+ VersionValue func(entity any) int

+ func ToMetaBase[T any](meta *ModelMeta[T]) *ModelMetaBase

+ type MultiColumnMapper interface

+ DrelColumns func() []string

+ DrelScanMulti func(vals []any) error

+ DrelValues func() ([]any, error)

+ type NamedFilter struct

+ Clause ast.WhereClause

+ Name string

+ type Option func(*engineConfig)

+ func WithContext(ctx context.Context) Option

+ type OrderExpr struct

+ func (o OrderExpr) ToAST() ast.OrderByExpr

+ type OrderedColumn struct

+ func NewOrderedCol[T cmp.Ordered](name string) OrderedColumn[T]

+ func (c OrderedColumn[T]) Asc() OrderExpr

+ func (c OrderedColumn[T]) Between(low, high T) Predicate

+ func (c OrderedColumn[T]) Desc() OrderExpr

+ func (c OrderedColumn[T]) Eq(v T) Predicate

+ func (c OrderedColumn[T]) GT(v T) Predicate

+ func (c OrderedColumn[T]) GTE(v T) Predicate

+ func (c OrderedColumn[T]) In(vs ...T) Predicate

+ func (c OrderedColumn[T]) IsNotNull() Predicate

+ func (c OrderedColumn[T]) IsNull() Predicate

+ func (c OrderedColumn[T]) LT(v T) Predicate

+ func (c OrderedColumn[T]) LTE(v T) Predicate

+ func (c OrderedColumn[T]) NEQ(v T) Predicate

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

+ func (c OrderedColumn[T]) NotIn(vs ...T) Predicate

+ type Predicate struct

+ func And(preds ...Predicate) Predicate

+ func Not(pred Predicate) Predicate

+ func Or(preds ...Predicate) Predicate

+ func Raw(sql string, args ...any) Predicate

+ func (p Predicate) ToAST() ast.WhereClause

+ type QueryBuilder struct

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

+ func (q *QueryBuilder[T]) BulkDelete(ctx context.Context) (int, error)

+ func (q *QueryBuilder[T]) BulkUpdate(ctx context.Context, sets ...SetClause) (int, error)

+ func (q *QueryBuilder[T]) Count(ctx context.Context) (int, error)

+ func (q *QueryBuilder[T]) Exists(ctx context.Context) (bool, error)

+ func (q *QueryBuilder[T]) First(ctx context.Context) (*T, error)

+ func (q *QueryBuilder[T]) FirstOrNil(ctx context.Context) (*T, error)

+ func (q *QueryBuilder[T]) Limit(n int) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) OrderBy(exprs ...OrderExpr) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) Skip(n int) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) Unscoped() *QueryBuilder[T]

+ func (q *QueryBuilder[T]) Where(pred Predicate) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) WithoutFilter(name string) *QueryBuilder[T]

+ type QueryEvent struct

+ Args []any

+ Duration time.Duration

+ Err error

+ SQL string

+ type QueryHook func(ctx context.Context, event QueryEvent)

+ type RawExpr struct

+ SQL string

+ type Relation struct

+ func NewRelation[T any](name string) Relation[T]

+ func (r Relation[T]) Name() string

+ type RelationInfo struct

+ FKColumn string

+ FieldSetter func(parent any, related any)

+ JoinTable string

+ Name string

+ RefColumn string

+ RelatedMeta *ModelMetaBase

+ Type RelationType

+ type RelationType int

+ const BelongsTo

+ const HasMany

+ const HasOne

+ const ManyToMany

+ type Repository struct

+ func NewRepository[T any](engine *Engine, meta ModelMeta[T]) *Repository[T]

+ func (r *Repository[T]) All(ctx context.Context) ([]*T, error)

+ func (r *Repository[T]) BulkInsert(ctx context.Context, entities []*T) (int, error)

+ func (r *Repository[T]) BulkUpsert(ctx context.Context, entities []*T, opts ...UpsertOption) (int, error)

+ func (r *Repository[T]) Count(ctx context.Context) (int, error)

+ func (r *Repository[T]) Exists(ctx context.Context) (bool, error)

+ func (r *Repository[T]) Find(ctx context.Context, id any) (*T, error)

+ func (r *Repository[T]) First(ctx context.Context) (*T, error)

+ func (r *Repository[T]) FirstOrNil(ctx context.Context) (*T, error)

+ func (r *Repository[T]) Include(rels ...IncludeSpec) *IncludableQuery[T]

+ func (r *Repository[T]) Limit(n int) *QueryBuilder[T]

+ func (r *Repository[T]) OrderBy(exprs ...OrderExpr) *QueryBuilder[T]

+ func (r *Repository[T]) Unscoped() *QueryBuilder[T]

+ func (r *Repository[T]) Where(pred Predicate) *QueryBuilder[T]

+ func (r *Repository[T]) WithoutFilter(name string) *QueryBuilder[T]

+ type Row interface

+ Scan func(dest ...any) error

+ type Rows interface

+ Close func()

+ Err func() error

+ Next func() bool

+ Scan func(dest ...any) error

+ type SetClause struct

+ Column string

+ Value any

+ func Set[C interface{ ... }, V any](col C, value V) SetClause

+ type SoftDelete struct

+ func (s *SoftDelete) DeletedAtPtr() **time.Time

+ func (s SoftDelete) DeletedAt() *time.Time

+ func (s SoftDelete) IsDeleted() bool

+ type StringColumn struct

+ func NewStringCol(name string) StringColumn

+ func (c StringColumn) Asc() OrderExpr

+ func (c StringColumn) Contains(substr string) Predicate

+ func (c StringColumn) Desc() OrderExpr

+ func (c StringColumn) Eq(v string) Predicate

+ func (c StringColumn) GT(v string) Predicate

+ func (c StringColumn) GTE(v string) Predicate

+ func (c StringColumn) HasPrefix(prefix string) Predicate

+ func (c StringColumn) HasSuffix(suffix string) Predicate

+ func (c StringColumn) ILike(pattern string) Predicate

+ func (c StringColumn) In(vs ...string) Predicate

+ func (c StringColumn) IsNotNull() Predicate

+ func (c StringColumn) IsNull() Predicate

+ func (c StringColumn) LT(v string) Predicate

+ func (c StringColumn) LTE(v string) Predicate

+ func (c StringColumn) Like(pattern string) Predicate

+ func (c StringColumn) NEQ(v string) Predicate

+ func (c StringColumn) Name() string

+ func (c StringColumn) NotIn(vs ...string) Predicate

+ type Tx struct

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

+ func (tx *Tx) HardRemove(entity any) error

+ func (tx *Tx) QueryRow(ctx context.Context, sql string, args ...any) Row

+ func (tx *Tx) SaveChanges(ctx context.Context) error

+ type TxOption func(*txConfig)

+ func WithIsolation(level IsolationLevel) TxOption

+ type TxQueryBuilder struct

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

+ func (q *TxQueryBuilder[T]) Count(ctx context.Context) (int, error)

+ func (q *TxQueryBuilder[T]) Exists(ctx context.Context) (bool, error)

+ func (q *TxQueryBuilder[T]) First(ctx context.Context) (*T, error)

+ func (q *TxQueryBuilder[T]) FirstOrNil(ctx context.Context) (*T, error)

+ func (q *TxQueryBuilder[T]) Limit(n int) *TxQueryBuilder[T]

+ func (q *TxQueryBuilder[T]) OrderBy(exprs ...OrderExpr) *TxQueryBuilder[T]

+ func (q *TxQueryBuilder[T]) Skip(n int) *TxQueryBuilder[T]

+ func (q *TxQueryBuilder[T]) Unscoped() *TxQueryBuilder[T]

+ func (q *TxQueryBuilder[T]) Where(pred Predicate) *TxQueryBuilder[T]

+ func (q *TxQueryBuilder[T]) WithoutFilter(name string) *TxQueryBuilder[T]

+ type TxRepository struct

+ func NewTxRepository[T any](tx *Tx, meta ModelMeta[T]) *TxRepository[T]

+ func (r *TxRepository[T]) Add(entity *T)

+ func (r *TxRepository[T]) All(ctx context.Context) ([]*T, error)

+ func (r *TxRepository[T]) Find(ctx context.Context, id any) (*T, error)

+ func (r *TxRepository[T]) Remove(entity *T) error

+ func (r *TxRepository[T]) Unscoped() *TxQueryBuilder[T]

+ func (r *TxRepository[T]) Where(pred Predicate) *TxQueryBuilder[T]

+ func (r *TxRepository[T]) WithoutFilter(name string) *TxQueryBuilder[T]

+ type UpsertOption func(*upsertConfig)

+ func ConflictColumns[C interface{ ... }](cols ...C) UpsertOption

+ func UpdateOnConflict[C interface{ ... }](cols ...C) UpsertOption

+ type Versioned struct

+ func (v *Versioned) VersionPtr() *int

+ func (v Versioned) Version() int

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