dal

Sep 2, 2024

Changes in this version

+ type MultiInserter interface

+ InsertMulti func(ctx context.Context, records []Record, opts ...InsertOption) error

Sep 11, 2023

Changes in this version

type KeyOption

+ func WithIntID(id int) KeyOption

+ func WithKeyID(id T) KeyOption

Sep 4, 2023

Changes in this version

+ type DB interface

+ Adapter func() Adapter

+ ID func() string

Sep 4, 2023

Changes in this version

+ type Adapter interface

+ Name func() string

+ Version func() string

+ func NewAdapter(name, version string) Adapter

+ type Connection interface

+ Close func(ctx context.Context) error

type Database

+ Adapter func() Adapter

Aug 22, 2023

Changes in this version

type Database

+ Close func() error

Aug 21, 2023

Changes in this version

+ func SelectAll(reader Reader, getItem func(r Record) T, options ...ReaderOption) (items []T, err error)

+ func WithLimit(limit int) func(ro *readerOptions)

+ func WithOffset(offset int) func(ro *readerOptions)

+ type ReaderOption = func(ro *readerOptions)

+ type ReaderOptions interface

+ Limit func() int

+ Offset func() int

Aug 20, 2023

Changes in this version

+ func WithAfterLoad(hook RecordDataHook) func(rd *recordData)

+ func WithBeforeSave(hook RecordDataHook) func(rd *recordData)

+ type DataWrapper interface

+ Data func() any

+ type RecordDataOption = func(rd *recordData)

Aug 19, 2023

Changes in this version

+ var DefaultRandomStringIDLength = 16

+ var ErrExceedsMaxNumberOfAttempts = fmt.Errorf("exceeds max number of attempts")

+ func Prefix(prefix string) func(options *randomStringOptions)

+ func RandomLength(length int) func(options *randomStringOptions)

type RandomStringOptions

+ Length func() int

Aug 18, 2023

Changes in this version

+ var ErrReaderClosed = errors.New("reader closed")

+ var ErrReaderNotStarted = errors.New("reader not started")

type Reader

+ func NewRecordsReader(records []Record) Reader

Aug 18, 2023

Changes in this version

+ type EmptyReader struct

+ func (e EmptyReader) Close() error

+ func (e EmptyReader) Cursor() (string, error)

+ func (e EmptyReader) Next() (Record, error)

+ type RecordsReader struct

+ func (r *RecordsReader) Close() error

+ func (r *RecordsReader) Cursor() (string, error)

+ func (r *RecordsReader) Next() (record Record, err error)

Aug 18, 2023

Changes in this version

type Key

+ func NewKeyWithOptions(collection string, options ...KeyOption) (key *Key, err error)

+ func NewKeyWithParentAndID(parent *Key, collection string, id T) (key *Key)

May 9, 2023

Changes in this version

+ type Deleter interface

+ Delete func(ctx context.Context, key *Key) error

+ type Getter interface

+ Get func(ctx context.Context, record Record) error

+ type Inserter interface

+ Insert func(c context.Context, record Record, opts ...InsertOption) error

+ type MultiDeleter interface

+ DeleteMulti func(ctx context.Context, keys []*Key) error

+ type MultiGetter interface

+ GetMulti func(ctx context.Context, records []Record) error

+ type MultiSetter interface

+ SetMulti func(ctx context.Context, records []Record) error

+ type MultiUpdater interface

+ UpdateMulti func(c context.Context, keys []*Key, updates []Update, ...) error

+ type Setter interface

+ Set func(ctx context.Context, record Record) error

+ type Updater interface

+ Update func(ctx context.Context, key *Key, updates []Update, preconditions ...Precondition) error

Apr 21, 2023

Changes in this version

type Reader

+ Close func() error

Apr 21, 2023

Changes in this version

type OrderExpression

+ Expression func() Expression

Apr 20, 2023

Changes in this version

+ func EscapeID(id string) string

Apr 20, 2023

Changes in this version

+ type Cursor string

type Query

+ StartFrom func() Cursor

type QueryBuilder

+ StartFrom func(cursor Cursor) QueryBuilder

Apr 20, 2023

Changes in this version

+ func RequiresEscaping(s string) bool

type CollectionRef

+ func NewCollectionRef(name string, alias string, parent *Key) CollectionRef

Apr 20, 2023

Changes in this version

type CollectionRef

+ Alias string

+ func (v CollectionRef) String() string

type QueryBuilder

+ Limit func(int) QueryBuilder

+ Offset func(int) QueryBuilder

Apr 19, 2023

Changes in this version

+ type Constant struct

+ Value any

+ func (v Constant) Equal(b Constant) bool

+ func (v Constant) String() string

+ type GroupCondition struct

+ func (v GroupCondition) Conditions() []Condition

+ func (v GroupCondition) Operator() Operator

+ func (v GroupCondition) String() string

Apr 19, 2023

Changes in this version

+ func SelectAllIDs(reader Reader, limit int) (ids []T, err error)

+ type QueryExecutor interface

+ QueryAllRecords func(ctx context.Context, query Query) (records []Record, err error)

+ QueryReader func(c context.Context, query Query) (Reader, error)

+ func NewQueryExecutor(getReader ReaderProvider) QueryExecutor

+ type ReaderProvider = func(c context.Context, query Query) (reader Reader, err error)

type Record

+ func SelectAllRecords(reader Reader, limit int) (records []Record, err error)

Apr 19, 2023

Changes in this version

+ var ErrNotImplementedYet = errors.New("not implemented yet")

Apr 19, 2023

Changes in this version

+ type QueryBuilder interface

+ OrderBy func(expressions ...OrderExpression) QueryBuilder

+ SelectInto func(func() Record) Query

+ SelectKeysOnly func(idKind reflect.Kind) Query

+ Where func(conditions ...Condition) QueryBuilder

+ WhereField func(name string, operator Operator, v any) QueryBuilder

type Selector

+ func NewSelector(getReader func(c context.Context, query Query) (Reader, error)) Selector

+ Select func(c context.Context, query Query) (Reader, error)

+ SelectAll func(ctx context.Context, query Query) ([]Record, error)

+ SelectAllIDs func(c context.Context, query Query) (ids []any, err error)

+ SelectAllInt64IDs func(ctx context.Context, query Query) ([]int64, error)

+ SelectAllIntIDs func(ctx context.Context, query Query) ([]int, error)

+ SelectAllStrIDs func(ctx context.Context, query Query) ([]string, error)

Apr 19, 2023

Changes in this version

type Preconditions

+ LastUpdateTime func() time.Time

Apr 15, 2023

Changes in this version

+ var ErrHookFailed = errors.New("hook(s) failed")

+ func BeforeSave(c context.Context, db Database, record Record) error

+ type ClientInfo interface

+ Driver func() string

+ Version func() string

+ func NewClientInfo(driver, version string) ClientInfo

type Database

+ Client func() ClientInfo

+ ID func() string

type ReadwriteTransaction

+ ID func() string

+ type RecordDataHook = func(c context.Context, db Database, key *Key, data any) (err error)

+ type RecordHook = func(c context.Context, record Record) error

+ type ValidatableRecord interface

+ Validate func() error

Apr 14, 2023

Changes in this version

type ReadSession

+ SelectAllInt64IDs func(ctx context.Context, query Query) ([]int64, error)

+ SelectAllIntIDs func(ctx context.Context, query Query) ([]int, error)

+ SelectAllStrIDs func(ctx context.Context, query Query) ([]string, error)

Apr 14, 2023

Changes in this version

+ type Data = any

+ type RecordAfterLoadHook interface

+ AfterLoad func(c context.Context, key *Key) (err error)

+ type RecordBeforeSaveHook interface

+ BeforeSave func(c context.Context, key *Key) (err error)

+ type RecordData interface

+ DTO func() any

+ func MakeRecordData(data T) RecordData

+ func MakeRecordDataWithCallbacks(data T, beforeSave RecordEvent, afterLoad RecordEvent) RecordData

+ type RecordEvent = func(c context.Context, key *Key, data Data) error

Apr 14, 2023

Changes in this version

+ const AVERAGE

+ const COUNT

+ const MAX

+ const MIN

+ const SUM

+ func IsGroupOperator(o Operator) bool

+ type Column struct

+ Alias string

+ Expression Expression

+ func AverageAs(expression Expression, alias string) Column

+ func CountAs(expression Expression, alias string) Column

+ func MaxAs(expression Expression, alias string) Column

+ func MinAs(expression Expression, alias string) Column

+ func SumAs(expression Expression, alias string) Column

+ func (v Column) String() string

+ type Comparison struct

+ Left Expression

+ Operator Operator

+ Right Expression

+ func NewComparison(left Expression, o Operator, right Expression) Comparison

+ func (v Comparison) Equal(b Comparison) bool

+ func (v Comparison) String() string

+ type Condition interface

+ func WhereField(name string, operator Operator, v any) Condition

+ type Expression interface

+ func ID(name string, value any) Expression

+ func String(v string) Expression

+ type FieldRef struct

+ IsID bool

+ Name string

+ func Field(name string) FieldRef

+ func (f FieldRef) Equal(b FieldRef) bool

+ func (f FieldRef) EqualTo(v any) Condition

+ func (f FieldRef) String() string

type Key

+ IDKind reflect.Kind

+ func NewIncompleteKey(collection string, idKind reflect.Kind, parent *Key) *Key

+ type Operator string

+ const And

+ const Equal

+ const GreaterOrEqual

+ const GreaterThen

+ const In

+ const LessOrEqual

+ const LessThen

+ const Or

+ type OrderExpression interface

+ Descending func() bool

+ func Ascending(expression Expression) OrderExpression

+ func AscendingField(name string) OrderExpression

+ func Descending(expression Expression) OrderExpression

+ func DescendingField(name string) OrderExpression

+ type Query struct

+ Columns []Column

+ From *CollectionRef

+ GroupBy []Expression

+ IDKind reflect.Kind

+ Into func() Record

+ Limit int

+ Offset int

+ OrderBy []OrderExpression

+ StartCursor string

+ Where Condition

+ func (q Query) And(conditions ...Condition) Query

+ func (q Query) Or(conditions ...Condition) Query

+ func (q Query) String() string

type ReadSession

+ SelectAll func(ctx context.Context, query Query) ([]Record, error)

+ SelectAllIDs func(ctx context.Context, query Query) ([]any, error)

type Reader

+ Cursor func() (string, error)

type Record

+ func NewRecordWithIncompleteKey(collection string, idKind reflect.Kind, data any) Record

+ type Selector interface

+ OrderBy func(expressions ...OrderExpression) Selector

+ SelectInto func(func() Record) Query

+ SelectKeysOnly func(idKind reflect.Kind) Query

+ Where func(conditions ...Condition) Selector

+ WhereField func(name string, operator Operator, v any) Selector

+ func From(collection string, conditions ...Condition) Selector

+ type SingleSource interface

+ Where func(conditions ...Condition) Selector

Apr 10, 2023

Changes in this version

+ func EqualKeys(k1 *Key, k2 *Key) bool

type Changes

+ func (changes *Changes) Records() (records []Record)

type Key

+ func (k *Key) Equal(key *Key) bool

Apr 4, 2023

Changes in this version

+ const DeleteField

+ const ServerTimestamp

+ var ErrDoesNotExist = errors.New("does not exist")

+ var ErrNoMoreRecords = errors.New("no more errors")

+ var ErrNotSupported = errors.New("not supported")

+ var ErrRecordNotFound = errors.New("record not found")

+ var NoError = errors.New("no error")

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

+ func InsertWithRandomID(c context.Context, r Record, generateID IDGenerator, attempts int, ...) error

+ func IsNotFound(err error) bool

+ func NewContextWithTransaction(nonTransactionalContext context.Context, tx Transaction) context.Context

+ func NewErrNotFoundByKey(key *Key, cause error) error

+ func NewRollbackError(rollbackError, originalError error) error

+ func WithExistsPrecondition() func(preconditions *preConditions)

+ func WithLastUpdateTimePrecondition(t time.Time) func(preconditions *preConditions)

+ func WithPrefix(prefix string) func(options *randomStringOptions)

+ type Changes struct

+ func (changes *Changes) FlagAsChanged(record Record)

+ func (changes Changes) EntityHolders() (entityHolders []Record)

+ func (changes Changes) HasChanges() bool

+ func (changes Changes) IsChanged(entityHolder Record) bool

+ type CollectionRef struct

+ Name string

+ Parent *Key

+ func (v CollectionRef) Path() string

+ type Database interface

+ type ErrDuplicateUser struct

+ DuplicateUserIDs []int64

+ SearchCriteria string

+ func (err ErrDuplicateUser) Error() string

+ type ErrNotFoundByKey interface

+ Cause func() error

+ Key func() Key

+ type FieldPath []string

+ type FieldVal struct

+ Name string

+ Value interface{}

+ func (v FieldVal) Validate() error

+ type IDGenerator = func(ctx context.Context, record Record) error

+ type InsertOption func(options *insertOptions)

+ type InsertOptions interface

+ IDGenerator func() IDGenerator

+ func NewInsertOptions(opts ...InsertOption) InsertOptions

+ type Key struct

+ ID interface{}

+ func NewKey(collection string, options ...KeyOption) (key *Key)

+ func NewKeyWithFields(collection string, fields ...FieldVal) *Key

+ func NewKeyWithID(collection string, id T, options ...KeyOption) (key *Key)

+ func (k *Key) Collection() string

+ func (k *Key) CollectionPath() string

+ func (k *Key) Level() int

+ func (k *Key) Parent() *Key

+ func (k *Key) String() string

+ func (k *Key) Validate() error

+ type KeyOption = func(*Key)

+ func WithFields(fields []FieldVal) KeyOption

+ func WithID(id T) KeyOption

+ func WithIDGenerator(g IDGenerator) KeyOption

+ func WithParent(collection string, id interface{}, options ...KeyOption) KeyOption

+ func WithParentKey(parent *Key) KeyOption

+ func WithRandomStringID(length int, options ...randomStringOption) KeyOption

+ func WithStringID(id string) KeyOption

+ type Precondition = func(preconditions *preConditions)

+ type Preconditions interface

+ Exists func() bool

+ func GetPreconditions(items ...Precondition) Preconditions

+ type ROTxWorker = func(ctx context.Context, tx ReadTransaction) error

+ type RWTxWorker = func(ctx context.Context, tx ReadwriteTransaction) error

+ type RandomStringOptions interface

+ Prefix func() string

+ type ReadSession interface

+ Get func(ctx context.Context, record Record) error

+ GetMulti func(ctx context.Context, records []Record) error

+ Select func(ctx context.Context, query Select) (Reader, error)

+ type ReadTransaction interface

+ type ReadTransactionCoordinator interface

+ RunReadonlyTransaction func(ctx context.Context, f ROTxWorker, options ...TransactionOption) error

+ type Reader interface

+ Next func() (Record, error)

+ type ReadwriteSession interface

+ type ReadwriteTransaction interface

+ type ReadwriteTransactionCoordinator interface

+ RunReadwriteTransaction func(ctx context.Context, f RWTxWorker, options ...TransactionOption) error

+ type Record interface

+ Data func() interface{}

+ Error func() error

+ Exists func() bool

+ HasChanged func() bool

+ Key func() *Key

+ MarkAsChanged func()

+ SetError func(err error)

+ func NewRecord(key *Key) Record

+ func NewRecordWithData(key *Key, data interface{}) Record

+ func NewRecordWithoutKey(data interface{}) Record

+ func ReadAll(_ context.Context, reader Reader, limit int) (records []Record, err error)

+ type Select struct

+ Columns []query.Column

+ From *CollectionRef

+ GroupBy []query.Expression

+ Into func() interface{}

+ Limit int

+ OrderBy []query.Expression

+ Where query.Condition

+ func (q Select) And(conditions ...query.Condition) Select

+ func (q Select) Or(conditions ...query.Condition) Select

+ func (q Select) String() string

+ type Transaction interface

+ Options func() TransactionOptions

+ func GetTransaction(ctx context.Context) Transaction

+ type TransactionCoordinator interface

+ type TransactionOption func(options *txOptions)

+ func TxWithAttempts(attempts int) TransactionOption

+ func TxWithCrossGroup() TransactionOption

+ func TxWithIsolationLevel(isolationLevel TxIsolationLevel) TransactionOption

+ func TxWithReadonly() TransactionOption

+ type TransactionOptions interface

+ Attempts func() int

+ IsCrossGroup func() bool

+ IsReadonly func() bool

+ IsolationLevel func() TxIsolationLevel

+ func NewTransactionOptions(opts ...TransactionOption) TransactionOptions

+ type Transform interface

+ Name func() string

+ Value func() interface{}

+ func ArrayUnion(elems ...interface{}) Transform

+ func Increment(v int) Transform

+ func IsTransform(v interface{}) (t Transform, ok bool)

+ type TxIsolationLevel int

+ const TxChaos

+ const TxReadCommitted

+ const TxReadUncommitted

+ const TxRepeatableRead

+ const TxSerializable

+ const TxSnapshot

+ const TxUnspecified

+ type Update struct

+ Field string

+ FieldPath FieldPath

+ Value interface{}

+ func (v Update) Validate() error

+ type WriteSession interface

+ Delete func(ctx context.Context, key *Key) error

+ DeleteMulti func(ctx context.Context, keys []*Key) error

+ Insert func(c context.Context, record Record, opts ...InsertOption) error

+ Set func(ctx context.Context, record Record) error

+ SetMulti func(ctx context.Context, records []Record) error

+ Update func(ctx context.Context, key *Key, updates []Update, preconditions ...Precondition) error

+ UpdateMulti func(c context.Context, keys []*Key, updates []Update, ...) error