r3

Sep 20, 2026

Changes in this version

+ var ErrUpsertIncrementConflict = errors.New("r3: upsert column is both overwritten and incremented")

+ var ErrUpsertIncrementNotSupported = errors.New("r3: upsert increment not supported by this backend")

type UpsertOption

+ func IncrementOnConflict(fields ...*FieldSpec) UpsertOption

type UpsertSpec

+ IncrementFields Fields

+ func (s UpsertSpec) Validate() error

Aug 16, 2026

Changes in this version

+ var ErrProjectionConflict = errors.New("query sets both Fields and ExcludeFields")

type Fields

+ func Exclude(fields ...string) Fields

+ func Include(fields ...string) Fields

type Query

+ ExcludeFields Fields

+ func (q Query) ValidateProjection() error

+ func (q Query) ValidateProjectionAgainst(known []string) error

Aug 5, 2026

Changes in this version

type RelationOption

+ func RelationWhere(column, value string) RelationOption

type RelationSpec

+ WhereColumn string

+ WhereValue string

Jul 21, 2026

Changes in this version

+ var ErrBucketNotSupported = errors.New("r3: time-bucket group key not supported by this backend")

+ var ErrInvalidBucket = errors.New("r3: invalid time-bucket group key")

+ func TruncateToBucket(t time.Time, u BucketUnit) time.Time

+ type BucketSpec struct

+ Alias string

+ Field *FieldSpec

+ Unit BucketUnit

+ func Bucket(field string, unit BucketUnit, alias string) *BucketSpec

+ func (b *BucketSpec) Clone() *BucketSpec

+ type BucketUnit int8

+ const BucketDay

+ const BucketHour

+ const BucketMonth

+ const BucketWeek

+ const BucketYear

+ func (u BucketUnit) String() string

+ func (u BucketUnit) Valid() bool

+ type Buckets []*BucketSpec

+ func (bs Buckets) Clone() Buckets

type Query

+ Buckets Buckets

Jul 19, 2026

Changes in this version

+ func EvalTimeOfDayBetween(t time.Time, value any) (bool, error)

+ func EvalWeekdayIn(t time.Time, value any) (bool, error)

+ func TimeOfDayBounds(value any) (int, int, error)

+ func WeekdaysValue(value any) ([]time.Weekday, error)

type FilterOperatorSpec

+ const OperatorTimeOfDayBetween

+ const OperatorWeekdayIn

type FilterSpec

+ func TimeOfDayBetween(field string, loMin, hiMin int) *FilterSpec

+ func WeekdayIn(field string, days ...time.Weekday) *FilterSpec

Jul 19, 2026

Changes in this version

type PaginationSpec

+ Offset maybe.Int

+ func NewOffsetPagination(offset int, limit ...int) *PaginationSpec

+ func (p *PaginationSpec) GetOffset() (int, bool)

Jul 13, 2026

Changes in this version

type Codec

+ func LookupCodec(name string) (Codec, bool)

Jul 9, 2026

Changes in this version

+ func DecodeAggregateCodecs(s Schema, q Query, rows []AggregateRow) error

Jul 9, 2026

Changes in this version

+ var ErrCodecNotSupported = errors.New("r3: value codec not supported by this backend")

+ var ErrUnknownCodec = errors.New("r3: unknown codec")

+ func RegisterCodec(name string, c Codec)

+ func RequireCodecSupport(s Schema, backend string)

type Attribute

+ Codec Codec

+ type Codec interface

+ Decode func(stored any, target reflect.Type) (any, error)

+ Encode func(goValue any) (any, error)

+ Stored func() DataType

type CursorValues

+ func EncodeCursorCodecs(s Schema, values CursorValues) (CursorValues, error)

type Filters

+ func EncodeFilterCodecs(s Schema, filters Filters) (Filters, error)

Jul 9, 2026

Changes in this version

+ var ErrRelationAggregateNotSupported = errors.New("relation aggregation not supported by this repository")

type AggregateRow

+ func AggregateThroughRelation[T any, ID comparable](ctx context.Context, repo Querier[T, ID], relation string, qarg ...Query) ([]AggregateRow, error)

type FilterSpec

+ RelationNegate bool

+ func HasNo(relation string, inner ...*FilterSpec) *FilterSpec

type Option

+ func WithRelations(rels ...RelationSpec) Option

type Options

+ Relations []RelationSpec

+ type RelationAggregator interface

+ AggregateThroughRelation func(ctx context.Context, relation string, qarg ...Query) ([]AggregateRow, error)

+ type RelationKind uint8

+ const RelationBelongsTo

+ const RelationHasMany

+ const RelationManyToMany

+ func (k RelationKind) String() string

+ type RelationOption func(*RelationSpec)

+ func RelationTargetPK(column string) RelationOption

+ func RelationTargetSoftDelete(column string) RelationOption

+ type RelationSpec struct

+ FKColumn string

+ JoinTable string

+ Kind RelationKind

+ Name string

+ RefColumn string

+ TargetPK string

+ TargetSoftDeleteColumn string

+ TargetTable string

+ func BelongsToRelation(name, targetTable, fkColumn string, opts ...RelationOption) RelationSpec

+ func HasManyRelation(name, targetTable, fkColumn string, opts ...RelationOption) RelationSpec

+ func ManyToManyRelation(name, joinTable, fkColumn, refColumn, targetTable string, ...) RelationSpec

Jul 8, 2026

Changes in this version

+ var ErrBulkPatchNotSupported = errors.New("r3: bulk patch not supported")

+ var ErrUpsertNotSupported = errors.New("r3: upsert not supported")

+ func PatchWhereOf[T any, ID comparable](ctx context.Context, repo Commander[T, ID], filters Filters, entity T, ...) (int64, error)

+ func UpsertOf[T any, ID comparable](ctx context.Context, repo Commander[T, ID], entity T, opts ...UpsertOption) (T, error)

+ type BulkPatcher interface

+ PatchWhere func(ctx context.Context, filters Filters, entity T, fields Fields) (int64, error)

+ type UpsertOption func(*UpsertSpec)

+ func OnConflict(cols ...string) UpsertOption

+ func UpdateOnConflict(fields ...*FieldSpec) UpsertOption

+ type UpsertSpec struct

+ ConflictColumns []string

+ UpdateFields Fields

+ func NewUpsertSpec(opts ...UpsertOption) UpsertSpec

+ type Upserter interface

+ Upsert func(ctx context.Context, entity T, opts ...UpsertOption) (T, error)

Jul 8, 2026

Changes in this version

+ var ErrAggregateNotSupported = errors.New("r3: aggregate not supported")

+ var ErrInvalidAggregate = errors.New("r3: invalid aggregate query")

+ type AggregateFunc int8

+ const AggregateAvg

+ const AggregateCount

+ const AggregateCountDistinct

+ const AggregateMax

+ const AggregateMin

+ const AggregateSum

+ func (f AggregateFunc) String() string

+ type AggregateRow map[string]any

+ func AggregateOf[T any, ID comparable](ctx context.Context, repo Querier[T, ID], qarg ...Query) ([]AggregateRow, error)

+ func (r AggregateRow) Bool(key string) (bool, bool)

+ func (r AggregateRow) Float64(key string) (float64, bool)

+ func (r AggregateRow) Int64(key string) (int64, bool)

+ func (r AggregateRow) String(key string) (string, bool)

+ func (r AggregateRow) Time(key string) (time.Time, bool)

+ func (r AggregateRow) Value(key string) any

+ type AggregateSpec struct

+ Alias string

+ Field *FieldSpec

+ Func AggregateFunc

+ func AggAvg(field, alias string) *AggregateSpec

+ func AggCount(alias string) *AggregateSpec

+ func AggCountDistinct(field, alias string) *AggregateSpec

+ func AggMax(field, alias string) *AggregateSpec

+ func AggMin(field, alias string) *AggregateSpec

+ func AggSum(field, alias string) *AggregateSpec

+ func (a *AggregateSpec) Clone() *AggregateSpec

+ type Aggregates []*AggregateSpec

+ func (as Aggregates) Clone() Aggregates

+ type Aggregator interface

+ Aggregate func(ctx context.Context, qarg ...Query) ([]AggregateRow, error)

type Fields

+ func GroupBy(fields ...string) Fields

type Query

+ Aggregates Aggregates

+ GroupBy Fields

+ Having Filters

+ func (q Query) AggregateSorts() Sorts

type Schema

+ func (s Schema) ValidateAggregateQuery(q Query) error

Jul 6, 2026

Changes in this version

+ func GetLocale(ctx context.Context) string

+ func WithLocale(ctx context.Context, locale string) context.Context

Jun 26, 2026

Changes in this version

+ const PageSizeDefault

+ var ErrCursorRequiresSort = errors.New("cursor pagination requires at least one sort column")

+ var ErrFieldNotFilterable = errors.New("field is not filterable")

+ var ErrFieldNotQueryable = errors.New("field is not queryable")

+ var ErrFieldNotSortable = errors.New("field is not sortable")

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

+ var ErrInvalidIdentifier = errors.New("invalid identifier")

+ var ErrInvalidPatchField = errors.New("invalid patch field")

+ var ErrNoPatchFields = errors.New("patch requires at least one field")

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

+ var ErrTransactionsNotSupported = errors.New("r3: transactions not supported by this repository")

+ var ErrUnknownField = errors.New("unknown field")

+ var SystemActor = Actor

+ func As[C any, T any, ID comparable](repo CRUD[T, ID]) (C, bool)

+ func EncodeCursor(cv CursorValues) (string, error)

+ func ExtractBetweenBounds(value any) (any, any, error)

+ func FieldsToStrings(fields Fields) []string

+ func FinalizeCountCursor[T any](entities []T) ([]T, int64)

+ func FinalizeCount[T any](entities []T, paginatedCount int64, isPaginated bool) ([]T, int64)

+ func InTx[T any, ID comparable](ctx context.Context, repo CRUD[T, ID], fn func(tx CRUD[T, ID]) error) error

+ func SupportsTx[T any, ID comparable](repo CRUD[T, ID]) bool

+ func ValidateIdentifier(s string) error

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

+ func WithoutWriteGuard(ctx context.Context) context.Context

+ func WriteGuardBypassed(ctx context.Context) bool

+ type Actor struct

+ Claims any

+ ID string

+ Type string

+ func GetActor(ctx context.Context) Actor

+ type Attribute struct

+ Caps Capability

+ Computed bool

+ Enum []string

+ Name string

+ Ops []FilterOperatorSpec

+ Relation *RelationRef

+ Type DataType

+ func (a Attribute) Has(c Capability) bool

+ type CRUD interface

+ func SystemWriter[T any, ID comparable](repo CRUD[T, ID]) CRUD[T, ID]

+ type Capability uint8

+ const Creatable

+ const Filterable

+ const Mutable

+ const Queryable

+ const Sortable

+ type Commander interface

+ Create func(context.Context, T) (T, error)

+ Delete func(context.Context, ID) error

+ Patch func(context.Context, T, Fields) (T, error)

+ Update func(context.Context, T) (T, error)

+ type Config struct

+ Defaults DefaultsConfig

+ Naming NamingConfig

+ func DefaultConfig() Config

+ type CursorDirection int8

+ const CursorBackward

+ const CursorForward

+ func (d CursorDirection) String() string

+ type CursorSpec struct

+ After string

+ Before string

+ Limit int

+ func NewCursorAfter(after string, limit int) *CursorSpec

+ func NewCursorBefore(before string, limit int) *CursorSpec

+ func NewCursorFirst(limit int) *CursorSpec

+ func (c *CursorSpec) Clone() *CursorSpec

+ func (c *CursorSpec) Direction() CursorDirection

+ func (c *CursorSpec) GetLimit() int

+ func (c *CursorSpec) MergeWith(other *CursorSpec) *CursorSpec

+ func (c *CursorSpec) String() string

+ func (c *CursorSpec) Token() string

+ type CursorValues map[string]any

+ func DecodeCursor(token string) (CursorValues, error)

+ type DataType string

+ const TypeBool

+ const TypeEnum

+ const TypeFloat

+ const TypeInt

+ const TypeJSON

+ const TypeRel

+ const TypeString

+ const TypeTime

+ type Defaults struct

+ GetQuery Query

+ ListQuery Query

+ func NewDefaults() Defaults

+ type DefaultsConfig struct

+ PageSize int

+ Unpaginated bool

+ type DefaultsManager struct

+ func NewDefaultsManager() DefaultsManager

+ func NewDefaultsManagerWithConfig(cfg Config) DefaultsManager

+ func (dm *DefaultsManager) GetDefaultGetQuery() Query

+ func (dm *DefaultsManager) GetDefaultListQuery() Query

+ func (dm *DefaultsManager) MergeGetQuery(qarg ...Query) Query

+ func (dm *DefaultsManager) MergeListQuery(qarg ...Query) Query

+ func (dm *DefaultsManager) SetDefaultGetQuery(q Query)

+ func (dm *DefaultsManager) SetDefaultListQuery(q Query)

+ type FieldSpec string

+ func NewFieldSpec(s string) *FieldSpec

+ func (f *FieldSpec) Clone() *FieldSpec

+ func (f *FieldSpec) String() string

+ type Fields []*FieldSpec

+ func (fs *Fields) Dedupe()

+ func (fs Fields) Clone() Fields

+ func (fs Fields) MergeWith(other Fields) Fields

+ type FilterOperatorSpec int8

+ const OperatorBetween

+ const OperatorBetweenEx

+ const OperatorBetweenExInc

+ const OperatorBetweenIncEx

+ const OperatorEq

+ const OperatorExists

+ const OperatorGt

+ const OperatorGte

+ const OperatorILike

+ const OperatorIn

+ const OperatorLike

+ const OperatorLt

+ const OperatorLte

+ const OperatorNe

+ const OperatorNotIn

+ const OperatorNotLike

+ const OperatorUnspecified

+ func (op *FilterOperatorSpec) String() string

+ type FilterSpec struct

+ And Filters

+ Field *FieldSpec

+ Operator FilterOperatorSpec

+ Or Filters

+ Relation string

+ RelationFilter Filters

+ Value any

+ func And(filters ...*FilterSpec) *FilterSpec

+ func Between(field string, lo, hi any) *FilterSpec

+ func Eq(field string, value any) *FilterSpec

+ func Exists(field string, value any) *FilterSpec

+ func F(field *FieldSpec, value any) *FilterSpec

+ func FILike(field *FieldSpec, value any) *FilterSpec

+ func FLike(field *FieldSpec, value any) *FilterSpec

+ func Fop(field *FieldSpec, operator FilterOperatorSpec, value any) *FilterSpec

+ func Gt(field string, value any) *FilterSpec

+ func Gte(field string, value any) *FilterSpec

+ func Has(relation string, inner ...*FilterSpec) *FilterSpec

+ func ILike(field string, value any) *FilterSpec

+ func In(field string, value any) *FilterSpec

+ func Like(field string, value any) *FilterSpec

+ func Lt(field string, value any) *FilterSpec

+ func Lte(field string, value any) *FilterSpec

+ func Ne(field string, value any) *FilterSpec

+ func NewFilterSpec(field *FieldSpec, operator FilterOperatorSpec, value any) *FilterSpec

+ func NewFilterSpecAndGroup(filters ...*FilterSpec) *FilterSpec

+ func NewFilterSpecOrGroup(filters ...*FilterSpec) *FilterSpec

+ func NotIn(field string, value any) *FilterSpec

+ func NotLike(field string, value any) *FilterSpec

+ func Or(filters ...*FilterSpec) *FilterSpec

+ func (f *FilterSpec) Clone() *FilterSpec

+ func (f *FilterSpec) String() string

+ type Filters []*FilterSpec

+ func (fs Filters) Clone() Filters

+ func (fs Filters) MergeWith(other Filters) Filters

+ type JSONColumn struct

+ Val T

+ func NewJSONColumn[T any](v T) JSONColumn[T]

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

+ func (j *JSONColumn[T]) UnmarshalJSON(data []byte) error

+ func (j JSONColumn[T]) MarshalJSON() ([]byte, error)

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

+ type NamingConfig struct

+ CreatedAtField string

+ DeletedAtField string

+ UpdatedAtField string

+ type Option func(*Options)

+ func WithConfig(cfg Config) Option

+ type Options struct

+ Config Config

+ func DefaultOptions() Options

+ func ResolveOptions(opts ...Option) Options

+ type PaginationSpec struct

+ PageNum maybe.Int

+ PageSize maybe.Int

+ func DefaultPagination() *PaginationSpec

+ func NewPaginationSpec(pageNum int, pageSize ...int) *PaginationSpec

+ func NewPaginationSpecWithSize(pageSize int) *PaginationSpec

+ func NoPagination() *PaginationSpec

+ func Unpaginated() *PaginationSpec

+ func (p *PaginationSpec) Clone() *PaginationSpec

+ func (p *PaginationSpec) GetPageNum() int

+ func (p *PaginationSpec) GetPageSize() int

+ func (p *PaginationSpec) IsPaginated() bool

+ func (p *PaginationSpec) MergeWith(other *PaginationSpec) *PaginationSpec

+ func (p *PaginationSpec) String() string

+ func (p *PaginationSpec) ToLimitOffset() (int, int)

+ type PreloadSpec struct

+ Name string

+ func NewPreloadSpec(name string) *PreloadSpec

+ func (t *PreloadSpec) Clone() *PreloadSpec

+ func (t *PreloadSpec) GetName() string

+ func (t *PreloadSpec) String() string

+ type Preloads []*PreloadSpec

+ func (preloads *Preloads) Dedupe()

+ func (preloads Preloads) Clone() Preloads

+ func (preloads Preloads) MergeWith(other Preloads) Preloads

+ type Querier interface

+ Count func(context.Context, ...Query) (int64, error)

+ Get func(context.Context, ID, ...Query) (T, error)

+ List func(context.Context, ...Query) ([]T, int64, error)

+ type Query struct

+ Cursor *CursorSpec

+ Fields Fields

+ Filters Filters

+ IncludeTrashed maybe.Bool

+ Pagination *PaginationSpec

+ Preloads Preloads

+ Sorts Sorts

+ func DefaultQuery() Query

+ func NewQuery() Query

+ func (q Query) Clone() Query

+ func (q Query) MergeWith(other Query) Query

+ type RelationRef struct

+ Kind string

+ Label string

+ Target string

+ type Rewrapper interface

+ Rewrap func(inner CRUD[T, ID]) CRUD[T, ID]

+ type Schema struct

+ func SchemaOf[T any](opts ...SchemaOption) Schema

+ func (s Schema) Attributes() []Attribute

+ func (s Schema) Filterable(name string) bool

+ func (s Schema) IsZero() bool

+ func (s Schema) Lookup(name string) (Attribute, bool)

+ func (s Schema) Queryable(name string) bool

+ func (s Schema) Sortable(name string) bool

+ func (s Schema) ValidateQuery(q Query) error

+ func (s Schema) With(overrides ...Attribute) Schema

+ func (s Schema) Writable(name string, op WriteOp) bool

+ type SchemaOption func(*schemaConfig)

+ func WithSchemaNaming(n NamingConfig) SchemaOption

+ type SortDirection int8

+ const SortDirectionAsc

+ const SortDirectionDesc

+ const SortDirectionUnspecified

+ func (s SortDirection) String() string

+ type SortNullsPosition int8

+ const NullsPositionFirst

+ const NullsPositionLast

+ const NullsPositionNotSpecified

+ func (s SortNullsPosition) String() string

+ type SortSpec struct

+ Column *FieldSpec

+ Direction SortDirection

+ NullsPosition SortNullsPosition

+ func NewSortAscSpec(col *FieldSpec) *SortSpec

+ func NewSortDescSpec(col *FieldSpec) *SortSpec

+ func NewSortSpec(col *FieldSpec, direction SortDirection, nullsPositionArg ...SortNullsPosition) *SortSpec

+ func (s *SortSpec) Clone() *SortSpec

+ func (s *SortSpec) GetCriteria() *FieldSpec

+ func (s *SortSpec) GetDirection() SortDirection

+ func (s *SortSpec) String() string

+ type Sorts []*SortSpec

+ func (sorts Sorts) Clone() Sorts

+ func (sorts Sorts) MergeWith(other Sorts) Sorts

+ type Transactor interface

+ BeginTx func(ctx context.Context) (TxCRUD[T, ID], error)

+ type TxCRUD interface

+ Commit func() error

+ Rollback func() error

+ func BeginTxChain[T any, ID comparable](ctx context.Context, repo CRUD[T, ID]) (TxCRUD[T, ID], error)

+ type Unwrapper interface

+ Unwrap func() CRUD[T, ID]

+ type WriteOp uint8

+ const WriteOpCreate

+ const WriteOpMutate