den

package module

Go to main page

Versions in this module

v0

v0.11.2

May 3, 2026

Changes in this version

+ type SeekableStorage interface

+ OpenSeekable func(ctx context.Context, a document.Attachment) (io.ReadSeekCloser, error)

v0.11.1

May 3, 2026

Changes in this version

+ var ErrUnsupportedScheme = errors.New("den: unsupported database scheme")

v0.11.0

Apr 27, 2026

Changes in this version

+ const FieldCreatedAt

+ const FieldDeleteReason

+ const FieldDeletedAt

+ const FieldDeletedBy

+ const FieldID

+ const FieldRev

+ const FieldUpdatedAt

+ var ErrIncompatibleOptions = errors.New("den: incompatible options combined")

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

+ var ErrIncompatibleScope = errors.New("den: option not compatible with the provided scope")

+ var ErrMultipleMatches = errors.New("den: more than one document matched")

+ func BackLinksField[H any, T any](ctx context.Context, s Scope, targetID string, opts ...CRUDOption) ([]*H, error)

+ func FetchLinkField[T any](ctx context.Context, s Scope, link *Link[T]) error

+ func FindOneAndUpsert[T any](ctx context.Context, s Scope, defaults *T, fields SetFields, ...) (*T, bool, error)

+ func FindOrCreate[T any](ctx context.Context, s Scope, defaults *T, conditions []where.Condition, ...) (*T, bool, error)

+ func Save[T any](ctx context.Context, s Scope, document *T, opts ...CRUDOption) error

+ func UpdateMany[T any](ctx context.Context, s Scope, conditions []where.Condition, fields SetFields) (int64, error)

+ type AfterSoftDeleter interface

+ AfterSoftDelete func(ctx context.Context) error

+ type BeforeSoftDeleter interface

+ BeforeSoftDelete func(ctx context.Context) error

type CRUDOption

+ func ContinueOnError() CRUDOption

+ func IncludeDeleted() CRUDOption

+ func MaxRecordedFailures(n int) CRUDOption

+ func PreValidate() CRUDOption

+ func SoftDeleteBy(actor string) CRUDOption

+ func SoftDeleteReason(reason string) CRUDOption

+ func WithoutFetchLinks() CRUDOption

type CollectionMeta

+ HasChangeTracking bool

+ HasRevision bool

+ type DanglingLinkError struct

+ Collection string

+ ID string

+ func (e *DanglingLinkError) Error() string

+ func (e *DanglingLinkError) Unwrap() error

+ type FTSSearcher interface

+ Search func(ctx context.Context, collection string, query string, q *Query) (Iterator, error)

type GroupByBuilder

+ func (gb GroupByBuilder[T]) OrderByAgg(op AggregateOp, field string, dir SortDirection) GroupByBuilder[T]

type GroupByRow

+ Keys []string

+ type GroupBySortEntry struct

+ Dir SortDirection

+ Field string

+ Op AggregateOp

+ type InsertFailure struct

+ Err error

+ Index int

+ type InsertManyError struct

+ Failures []InsertFailure

+ TotalFailures int

+ Truncated bool

+ func (e *InsertManyError) Error() string

+ func (e *InsertManyError) Unwrap() []error

type Query

+ GroupBySort []GroupBySortEntry

type QuerySet

+ func (qs QuerySet[T]) WithoutFetchLinks() QuerySet[T]

v0.10.1

Apr 19, 2026

v0.10.0

Apr 19, 2026

v0.9.1

Apr 19, 2026

v0.9.0

Apr 19, 2026

Changes in this version

type DB

+ func (db *DB) Storage() Storage

type Option

+ func WithStorage(s Storage) Option

+ type Storage interface

+ Delete func(ctx context.Context, a document.Attachment) error

+ Open func(ctx context.Context, a document.Attachment) (io.ReadCloser, error)

+ Store func(ctx context.Context, r io.Reader, ext, mime string) (document.Attachment, error)

+ URL func(a document.Attachment) string

v0.8.0

Apr 18, 2026

Changes in this version

+ var ErrDeadlock = errors.New("den: deadlock detected")

+ var ErrFTSNotSupported = errors.New("den: backend does not support full-text search")

+ var ErrLockRequiresTransaction = errors.New("den: ForUpdate requires a transaction scope (*Tx)")

+ var ErrLocked = errors.New("den: row is locked by another transaction")

+ var ErrSerialization = errors.New("den: serialization failure")

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

+ func LockByID[T any](ctx context.Context, tx *Tx, id string, opts ...LockOption) (*T, error)

+ func Revert[T any](db *DB, doc *T) error

type Backend

+ ListRecordedIndexes func(ctx context.Context, collection string) ([]RecordedIndex, error)

type CollectionMeta

+ HasSoftDelete bool

+ type DropStaleOption func(*dropStaleConfig)

+ func DryRun() DropStaleOption

+ type DropStaleResult struct

+ Dropped []StaleIndex

+ Kept []StaleIndex

+ func DropStaleIndexes(ctx context.Context, db *DB, opts ...DropStaleOption) (DropStaleResult, error)

+ type LockMode int

+ const LockDefault

+ const LockNoWait

+ const LockSkipLocked

+ type LockOption func(*lockConfig)

+ func NoWait() LockOption

+ func SkipLocked() LockOption

type Option

+ func WithTagValidator(fn func(any) error) Option

+ func WithTypes(types ...any) Option

type Query

+ Lock *LockMode

type QuerySet

+ func (qs QuerySet[T]) ForUpdate(opts ...LockOption) QuerySet[T]

+ type RecordedIndex struct

+ Fields []string

+ Name string

+ Unique bool

+ type Scope interface

+ type StaleIndex struct

+ Collection string

+ Fields []string

+ Name string

+ Unique bool

type Transaction

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

+ GetForUpdate func(ctx context.Context, collection, id string, mode LockMode) ([]byte, error)

type Tx

+ func (t *Tx) Transaction() Transaction

v0.7.0

Apr 15, 2026

Changes in this version

type AggregateOp

+ const OpCount

type Backend

+ GroupBy func(ctx context.Context, collection string, groupField string, aggs []GroupByAgg, ...) ([]GroupByRow, error)

+ type GroupByAgg struct

+ Field string

+ Op AggregateOp

+ type GroupByRow struct

+ Key string

+ Values []float64

type ReadWriter

+ GroupBy func(ctx context.Context, collection string, groupField string, aggs []GroupByAgg, ...) ([]GroupByRow, error)

v0.6.0

Apr 8, 2026

v0.5.0

Apr 6, 2026

v0.4.2

Apr 6, 2026

v0.4.1

Apr 5, 2026

v0.4.0

Apr 5, 2026

Changes in this version

+ func NewID() string

v0.3.0

Apr 5, 2026

v0.2.1

Apr 5, 2026

v0.2.0

Apr 5, 2026

Changes in this version

+ func RegisterBackend(scheme string, opener func(dsn string) (Backend, error))

type DB

+ func OpenURL(dsn string, opts ...Option) (*DB, error)

v0.1.0

Apr 4, 2026

Changes in this version

+ var ErrDuplicate = errors.New("den: duplicate key")

+ var ErrMigrationFailed = errors.New("den: migration failed")

+ var ErrNoSnapshot = errors.New("den: no snapshot — document was never loaded from database")

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

+ var ErrNotRegistered = errors.New("den: document type not registered")

+ var ErrRevisionConflict = errors.New("den: revision conflict")

+ var ErrTransactionFailed = errors.New("den: transaction failed")

+ var ErrValidation = errors.New("den: validation failed")

+ func BackLinks[T any](ctx context.Context, db *DB, linkField string, targetID string) ([]*T, error)

+ func Collections(db *DB) []string

+ func DeleteMany[T any](ctx context.Context, db *DB, conditions []where.Condition, opts ...CRUDOption) (int64, error)

+ func Delete[T any](ctx context.Context, db *DB, document *T, opts ...CRUDOption) error

+ func FetchAllLinks[T any](ctx context.Context, db *DB, doc *T) error

+ func FetchLink[T any](ctx context.Context, db *DB, doc *T, fieldName string) error

+ func FindByID[T any](ctx context.Context, db *DB, id string) (*T, error)

+ func FindByIDs[T any](ctx context.Context, db *DB, ids []string) ([]*T, error)

+ func FindOneAndUpdate[T any](ctx context.Context, db *DB, fields SetFields, conditions ...where.Condition) (*T, error)

+ func GetChanges[T any](db *DB, doc *T) (map[string]FieldChange, error)

+ func HardDelete[T any](ctx context.Context, db *DB, document *T, opts ...CRUDOption) error

+ func InsertMany[T any](ctx context.Context, db *DB, documents []*T) error

+ func Insert[T any](ctx context.Context, db *DB, document *T, opts ...CRUDOption) error

+ func IsChanged[T any](db *DB, doc *T) (bool, error)

+ func Refresh[T any](ctx context.Context, db *DB, document *T) error

+ func Register(ctx context.Context, db *DB, types ...any) error

+ func Rollback[T any](db *DB, doc *T) error

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

+ func TxDelete[T any](tx *Tx, document *T, opts ...CRUDOption) error

+ func TxFindByID[T any](tx *Tx, id string) (*T, error)

+ func TxGet(tx *Tx, collection, id string) ([]byte, error)

+ func TxInsert[T any](tx *Tx, document *T, opts ...CRUDOption) error

+ func TxPut(tx *Tx, collection, id string, data []byte) error

+ func TxUpdate[T any](tx *Tx, document *T, opts ...CRUDOption) error

+ func Update[T any](ctx context.Context, db *DB, document *T, opts ...CRUDOption) error

+ type AfterDeleter interface

+ AfterDelete func(ctx context.Context) error

+ type AfterInserter interface

+ AfterInsert func(ctx context.Context) error

+ type AfterSaver interface

+ AfterSave func(ctx context.Context) error

+ type AfterUpdater interface

+ AfterUpdate func(ctx context.Context) error

+ type AggregateOp string

+ const OpAvg

+ const OpMax

+ const OpMin

+ const OpSum

+ type Backend interface

+ Aggregate func(ctx context.Context, collection string, op AggregateOp, field string, q *Query) (*float64, error)

+ Begin func(ctx context.Context, writable bool) (Transaction, error)

+ Close func() error

+ Count func(ctx context.Context, collection string, q *Query) (int64, error)

+ Delete func(ctx context.Context, collection, id string) error

+ DropCollection func(ctx context.Context, name string) error

+ DropIndex func(ctx context.Context, collection string, name string) error

+ Encoder func() Encoder

+ EnsureCollection func(ctx context.Context, name string, meta CollectionMeta) error

+ EnsureIndex func(ctx context.Context, collection string, idx IndexDefinition) error

+ Exists func(ctx context.Context, collection string, q *Query) (bool, error)

+ Get func(ctx context.Context, collection, id string) ([]byte, error)

+ Ping func(ctx context.Context) error

+ Put func(ctx context.Context, collection, id string, data []byte) error

+ Query func(ctx context.Context, collection string, q *Query) (Iterator, error)

+ type BeforeDeleter interface

+ BeforeDelete func(ctx context.Context) error

+ type BeforeInserter interface

+ BeforeInsert func(ctx context.Context) error

+ type BeforeSaver interface

+ BeforeSave func(ctx context.Context) error

+ type BeforeUpdater interface

+ BeforeUpdate func(ctx context.Context) error

+ type CRUDOption func(*crudOpts)

+ func IgnoreRevision() CRUDOption

+ func WithLinkRule(rule LinkRule) CRUDOption

+ type CollectionMeta struct

+ Fields []FieldMeta

+ HasSoftBase bool

+ Indexes []IndexDefinition

+ Name string

+ func Meta[T any](db *DB) (CollectionMeta, error)

+ type DB struct

+ func Open(backend Backend, opts ...Option) (*DB, error)

+ func (db *DB) Backend() Backend

+ func (db *DB) Close() error

+ func (db *DB) Ping(ctx context.Context) error

+ func (db *DB) SetTagValidator(fn func(any) error)

+ type DenSettable interface

+ DenSettings func() Settings

+ type Encoder interface

+ Decode func(data []byte, v any) error

+ Encode func(v any) ([]byte, error)

+ type FTSProvider interface

+ EnsureFTS func(ctx context.Context, collection string, fields []string) error

+ Search func(ctx context.Context, collection string, query string, q *Query) (Iterator, error)

+ type FieldChange struct

+ After any

+ Before any

+ type FieldMeta struct

+ FTS bool

+ GoName string

+ Indexed bool

+ IsPointer bool

+ Name string

+ Type string

+ Unique bool

+ type GroupByBuilder struct

+ func (gb GroupByBuilder[T]) Into(target any) error

+ type IndexDefinition struct

+ Fields []string

+ Name string

+ Unique bool

+ type Iterator interface

+ Bytes func() []byte

+ Close func() error

+ Err func() error

+ ID func() string

+ Next func() bool

+ type Link struct

+ ID string

+ Loaded bool

+ Value *T

+ func NewLink[T any](doc *T) Link[T]

+ func (l *Link[T]) UnmarshalJSON(data []byte) error

+ func (l Link[T]) IsLoaded() bool

+ func (l Link[T]) MarshalJSON() ([]byte, error)

+ type LinkRule int

+ const LinkDelete

+ const LinkIgnore

+ const LinkWrite

+ type Option func(*DB)

+ type Query struct

+ AfterID string

+ BeforeID string

+ Collection string

+ Conditions []where.Condition

+ LimitN int

+ SkipN int

+ SortFields []SortEntry

+ type QuerySet struct

+ func NewQuery[T any](ctx context.Context, db *DB, conditions ...where.Condition) QuerySet[T]

+ func (qs QuerySet[T]) After(id string) QuerySet[T]

+ func (qs QuerySet[T]) All() ([]*T, error)

+ func (qs QuerySet[T]) AllWithCount() ([]*T, int64, error)

+ func (qs QuerySet[T]) Avg(field string) (float64, error)

+ func (qs QuerySet[T]) Before(id string) QuerySet[T]

+ func (qs QuerySet[T]) Count() (int64, error)

+ func (qs QuerySet[T]) Exists() (bool, error)

+ func (qs QuerySet[T]) First() (*T, error)

+ func (qs QuerySet[T]) GroupBy(field string) GroupByBuilder[T]

+ func (qs QuerySet[T]) IncludeDeleted() QuerySet[T]

+ func (qs QuerySet[T]) Iter() iter.Seq2[*T, error]

+ func (qs QuerySet[T]) Limit(n int) QuerySet[T]

+ func (qs QuerySet[T]) Max(field string) (float64, error)

+ func (qs QuerySet[T]) Min(field string) (float64, error)

+ func (qs QuerySet[T]) Project(target any) error

+ func (qs QuerySet[T]) Search(queryText string) ([]*T, error)

+ func (qs QuerySet[T]) Skip(n int) QuerySet[T]

+ func (qs QuerySet[T]) Sort(field string, dir SortDirection) QuerySet[T]

+ func (qs QuerySet[T]) Sum(field string) (float64, error)

+ func (qs QuerySet[T]) Update(fields SetFields) (int64, error)

+ func (qs QuerySet[T]) Where(conditions ...where.Condition) QuerySet[T]

+ func (qs QuerySet[T]) WithFetchLinks() QuerySet[T]

+ func (qs QuerySet[T]) WithNestingDepth(depth int) QuerySet[T]

+ type ReadWriter interface

+ Aggregate func(ctx context.Context, collection string, op AggregateOp, field string, q *Query) (*float64, error)

+ Count func(ctx context.Context, collection string, q *Query) (int64, error)

+ Delete func(ctx context.Context, collection, id string) error

+ Exists func(ctx context.Context, collection string, q *Query) (bool, error)

+ Get func(ctx context.Context, collection, id string) ([]byte, error)

+ Put func(ctx context.Context, collection, id string, data []byte) error

+ Query func(ctx context.Context, collection string, q *Query) (Iterator, error)

+ type SetFields map[string]any

+ type Settings struct

+ CacheCapacity int

+ CacheExpiration time.Duration

+ CollectionName string

+ Indexes []IndexDefinition

+ NestingDepthPerField map[string]int

+ OmitEmpty bool

+ UseCache bool

+ UseRevision bool

+ type SortDirection int

+ const Asc

+ const Desc

+ type SortEntry struct

+ Dir SortDirection

+ Field string

+ type Transaction interface

+ Commit func() error

+ Rollback func() error

+ type Tx struct

+ type Validator interface

+ Validate func() error

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