edb

package module

Go to main page

Versions in this module

v0

v0.2.2

May 13, 2024

Changes in this version

type Index

+ func (idx *Index) ParseNakedIndexKey(s string) (any, error)

+ func (idx *Index) ParseNakedIndexKeyVal(s string) (reflect.Value, error)

v0.2.1

May 7, 2024

Changes in this version

type RawCursor

+ TryRow func() (any, ValueMeta, error)

+ TryRowVal func() (reflect.Value, ValueMeta, error)

type RawIndexCursor

+ func (c *RawIndexCursor) TryRow() (any, ValueMeta, error)

+ func (c *RawIndexCursor) TryRowVal() (reflect.Value, ValueMeta, error)

type RawTableCursor

+ func (c *RawTableCursor) TryRow() (any, ValueMeta, error)

+ func (c *RawTableCursor) TryRowVal() (reflect.Value, ValueMeta, error)

type Tx

+ func (tx *Tx) TryGet(tbl *Table, key any) (any, ValueMeta, error)

+ func (tx *Tx) TryGetByKeyVal(tbl *Table, keyVal reflect.Value) (any, ValueMeta, error)

v0.2.0

Apr 29, 2024

Changes in this version

+ func LookupExists(txh Txish, idx *Index, indexKey any) bool

+ type Change struct

+ func (chg *Change) HasKey() bool

+ func (chg *Change) HasOldRow() bool

+ func (chg *Change) HasRow() bool

+ func (chg *Change) Key() any

+ func (chg *Change) KeyVal() reflect.Value

+ func (chg *Change) OldRow() any

+ func (chg *Change) OldRowVal() reflect.Value

+ func (chg *Change) Op() Op

+ func (chg *Change) RawKey() []byte

+ func (chg *Change) Row() any

+ func (chg *Change) RowVal() reflect.Value

+ func (chg *Change) Table() *Table

+ type ChangeFlags uint64

+ const ChangeFlagIncludeKey

+ const ChangeFlagIncludeMutableRow

+ const ChangeFlagIncludeOldRow

+ const ChangeFlagIncludeRow

+ const ChangeFlagNotify

+ func (v ChangeFlags) Contains(f ChangeFlags) bool

+ func (v ChangeFlags) ContainsAny(f ChangeFlags) bool

type Index

+ func (idx *Index) DecodeIndexKeyValInto(keyVal reflect.Value, tup tuple)

+ type IndexOpt int

+ const IndexOptSkipInitialFill

+ type Op int

+ const OpDelete

+ const OpNone

+ const OpPut

+ func (v Op) String() string

type RawCursor

+ RawRow func() []byte

type RawIndexCursor

+ func (c *RawIndexCursor) RawRow() []byte

type RawTableCursor

+ func (c *RawTableCursor) RawRow() []byte

type ScanOptions

+ func LowerBoundScan(lower any, includeEqual bool) ScanOptions

+ func UpperBoundScan(upper any, includeEqual bool) ScanOptions

type Table

+ func DefineTable[Row, Key any](scm *Schema, name string, f func(b *TableBuilder[Row, Key])) *Table

+ func (tbl *Table) DecodeKeyValInto(keyVal reflect.Value, rawKey []byte)

+ type TableBuilder struct

+ func (b *TableBuilder[Row, Key]) AddIndex(idx *Index)

+ func (b *TableBuilder[Row, Key]) Indexer(f func(row *Row, ib *IndexBuilder))

+ func (b *TableBuilder[Row, Key]) Migrate(f func(tx *Tx, row *Row, oldVer uint64))

+ func (b *TableBuilder[Row, Key]) SetSchemaVersion(ver uint64)

+ func (b *TableBuilder[Row, Key]) SuppressContentWhenLogging()

type Tx

+ func (tx *Tx) BeginVerbose()

+ func (tx *Tx) EndVerbose()

+ func (tx *Tx) LookupExists(idx *Index, indexKeyVal reflect.Value) bool

v0.1.6

Jan 17, 2024

Changes in this version

+ const ScanMethodRange

+ var ReaderCount atomic.Int64

+ var WriterCount atomic.Int64

+ func AllLimited[Row any](c Cursor[Row], limit int) []*Row

+ func Count(c RawCursor) int

+ func GetByKeyRaw[Row any](txh Txish, keyRaw []byte) *Row

type Cursor

+ func ExactTableScan[Row any](txh Txish, value any) Cursor[Row]

+ func RangeIndexScan[Row any](txh Txish, idx *Index, lowerValue, upperValue any, lowerInc, upperInc bool) Cursor[Row]

+ func RangeTableScan[Row any](txh Txish, lowerValue, upperValue any, lowerInc, upperInc bool) Cursor[Row]

+ func ReverseRangeIndexScan[Row any](txh Txish, idx *Index, lowerValue, upperValue any, lowerInc, upperInc bool) Cursor[Row]

+ func ReverseRangeTableScan[Row any](txh Txish, lowerValue, upperValue any, lowerInc, upperInc bool) Cursor[Row]

+ func (c Cursor[Row]) Raw() RawCursor

type DB

+ PendingWriterCount atomic.Int64

+ ReadCount atomic.Uint64

+ ReaderCount atomic.Int64

+ WriteCount atomic.Uint64

+ WriterCount atomic.Int64

+ func (db *DB) DescribeOpenTxns() string

+ func (db *DB) Size() int64

type Index

+ func (idx *Index) DecodeIndexKeyVal(tup tuple) reflect.Value

+ func (idx *Index) Table() *Table

type Options

+ MmapSize int

+ NoPersistentFreeList bool

type RawIndexCursor

+ func (c *RawIndexCursor) IndexKey() any

type ScanOptions

+ LowerInc bool

+ Upper reflect.Value

+ UpperInc bool

+ func RangeScan(lower, upper any, lowerInc, upperInc bool) ScanOptions

+ func RangeScanVal(lower, upper reflect.Value, lowerInc, upperInc bool) ScanOptions

type Table

+ func (tbl *Table) AddIndex(idx *Index) *Table

+ func (tbl *Table) EncodeKeyVal(keyVal reflect.Value) []byte

+ func (tbl *Table) IndexNamed(name string) *Index

type Tx

+ func (tx *Tx) ExistsByKeyRaw(tbl *Table, keyRaw []byte) bool

+ func (tx *Tx) GetByKeyRaw(tbl *Table, keyRaw []byte) (any, ValueMeta)

v0.1.5

Jul 12, 2023

Changes in this version

type Cursor

+ func ReverseExactIndexScan(txh Txish, idx *Index, indexValue any) Cursor[Row]

+ func ReversePrefixIndexScan(txh Txish, idx *Index, els int, indexValue any) Cursor[Row]

v0.1.4

Jun 28, 2023

Changes in this version

+ const SuppressContentWhenLogging

type Cursor

+ func FullReverseTableScan(txh Txish) Cursor[Row]

type Tx

+ func (tx *Tx) OnChange(f func(tbl *Table, key any))

+ func (tx *Tx) UnsafeDeleteByKeyRawSkippingIndex(tbl *Table, keyRaw []byte) bool

v0.1.3

May 28, 2023

Changes in this version

type Schema

+ Name string

+ func (scm *Schema) Include(peer *Schema)

v0.1.2

May 20, 2023

Changes in this version

type ScanOptions

+ func (so ScanOptions) LogString() string

type Schema

+ func (scm *Schema) TableByRow(row any) *Table

+ func (scm *Schema) TableByRowType(rt reflect.Type) *Table

type Table

+ func (tbl *Table) RowHasZeroKey(row any) bool

+ func (tbl *Table) RowValHasZeroKey(rowVal reflect.Value) bool

type Tx

+ func (tx *Tx) DB() *DB

+ func (tx *Tx) Schema() *Schema

v0.1.1

May 15, 2023

Changes in this version

+ func Filter(c Cursor[Row], f func(*Row) bool) []*Row

+ func First(c Cursor[Row]) *Row

+ func Select(c Cursor[Row], f func(*Row) bool) *Row

type Cursor

+ func FullTableScan(txh Txish) Cursor[Row]

v0.1.0

Apr 5, 2023

Changes in this version

+ const DumpAll

+ const DumpIndexRows

+ const DumpIndices

+ const DumpRows

+ const DumpStats

+ const DumpTableHeaders

+ const JSON

+ const MsgPack

+ const ScanMethodExact

+ const ScanMethodFull

+ var Break = errors.New("break")

+ func All(c Cursor[Row]) []*Row

+ func AllKeys(c RawCursor) []Key

+ func AllRawKeys(c RawCursor) [][]byte

+ func AllTableRows(txh Txish) []*Row

+ func AllUntypedKeys(c RawCursor) []any

+ func CountAll(txh Txish, tbl *Table) int

+ func DeleteAll(c RawCursor) int

+ func DeleteByKey(txh Txish, key any) bool

+ func DeleteRow(txh Txish, row *Row) bool

+ func Exists(txh Txish, key any) bool

+ func Get(txh Txish, key any) *Row

+ func Lookup(txh Txish, idx *Index, indexKey any) *Row

+ func LookupKey(txh Txish, idx *Index, indexKey any) (Key, bool)

+ func Memo(txish Txish, key string, f func() (T, error)) (T, error)

+ func Proto() any

+ func Put(txh Txish, row any)

+ func Reload(txh Txish, row *Row) *Row

+ func SGet(txh Txish, sk *SKey, v *T) bool

+ func SGetRaw(txh Txish, sk *SKey) []byte

+ func SPut(txh Txish, sk *SKey, v *T)

+ func SPutRaw(txh Txish, sk *SKey, raw []byte)

+ type Cursor struct

+ func ExactIndexScan(txh Txish, idx *Index, indexValue any) Cursor[Row]

+ func FullIndexScan(txh Txish, idx *Index) Cursor[Row]

+ func IndexScan(txh Txish, idx *Index, opt ScanOptions) Cursor[Row]

+ func PrefixIndexScan(txh Txish, idx *Index, els int, indexValue any) Cursor[Row]

+ func TableScan(txh Txish, opt ScanOptions) Cursor[Row]

+ func (c Cursor[Row]) Key() any

+ func (c Cursor[Row]) Meta() ValueMeta

+ func (c Cursor[Row]) Next() bool

+ func (c Cursor[Row]) Row() *Row

+ func (c Cursor[Row]) RowVal() (reflect.Value, ValueMeta)

+ type DB struct

+ func Open(path string, schema *Schema, opt Options) (*DB, error)

+ func (db *DB) BeginRead() *Tx

+ func (db *DB) BeginUpdate() *Tx

+ func (db *DB) Bolt() *bbolt.DB

+ func (db *DB) Close()

+ func (db *DB) Read(f func(tx *Tx))

+ func (db *DB) ReadErr(f func(tx *Tx) error) error

+ func (db *DB) Tx(writable bool, f func(tx *Tx) error) error

+ func (db *DB) Write(f func(tx *Tx))

+ type DataError struct

+ Data []byte

+ Err error

+ Msg string

+ Off int

+ func (e *DataError) Error() string

+ func (e *DataError) Unwrap() error

+ type DumpFlags uint64

+ func (f DumpFlags) Contains(v DumpFlags) bool

+ type FlatMarshaler interface

+ MarshalFlat func(buf []byte) []byte

+ type FlatMarshallable interface

+ type FlatUnmarshaler interface

+ UnmarshalFlat func(buf []byte) error

+ type Index struct

+ func AddIndex(name string) *Index

+ func (idx *Index) FullName() string

+ func (idx *Index) ShortName() string

+ func (idx *Index) Unique() *Index

+ type IndexBuilder struct

+ func (b *IndexBuilder) Add(idx *Index, value any) *IndexRow

+ type IndexRow struct

+ Index *Index

+ IndexOrd uint64

+ KeyBuf []byte

+ KeyRaw []byte

+ ValueBuf []byte

+ ValueRaw []byte

+ type KVMap struct

+ func AddKVMap(scm *Schema, name string) *KVMap

+ type Options struct

+ IsTesting bool

+ Logf func(format string, args ...any)

+ Verbose bool

+ type RawCursor interface

+ Key func() any

+ Meta func() ValueMeta

+ Next func() bool

+ RawKey func() []byte

+ Row func() (any, ValueMeta)

+ RowVal func() (reflect.Value, ValueMeta)

+ Table func() *Table

+ Tx func() *Tx

+ type RawIndexCursor struct

+ func (c *RawIndexCursor) Key() any

+ func (c *RawIndexCursor) Meta() ValueMeta

+ func (c *RawIndexCursor) Next() bool

+ func (c *RawIndexCursor) RawKey() []byte

+ func (c *RawIndexCursor) Row() (any, ValueMeta)

+ func (c *RawIndexCursor) RowVal() (reflect.Value, ValueMeta)

+ func (c *RawIndexCursor) Table() *Table

+ func (c *RawIndexCursor) Tx() *Tx

+ type RawTableCursor struct

+ func (c *RawTableCursor) Key() any

+ func (c *RawTableCursor) Meta() ValueMeta

+ func (c *RawTableCursor) Next() bool

+ func (c *RawTableCursor) RawKey() []byte

+ func (c *RawTableCursor) Row() (any, ValueMeta)

+ func (c *RawTableCursor) RowVal() (reflect.Value, ValueMeta)

+ func (c *RawTableCursor) Table() *Table

+ func (c *RawTableCursor) Tx() *Tx

+ type SKey struct

+ func AddSingletonKey(mp *KVMap, key string) *SKey

+ func (sk *SKey) Raw() []byte

+ func (sk *SKey) String() string

+ type ScanMethod int

+ type ScanOptions struct

+ Els int

+ Lower reflect.Value

+ Method ScanMethod

+ Reverse bool

+ func ExactScan(v any) ScanOptions

+ func ExactScanVal(val reflect.Value) ScanOptions

+ func FullScan() ScanOptions

+ func (so ScanOptions) Prefix(els int) ScanOptions

+ func (so ScanOptions) Reversed() ScanOptions

+ type Schema struct

+ func NewSchema(opt SchemaOpts) *Schema

+ func (scm *Schema) TableNamed(name string) *Table

+ func (scm *Schema) Tables() []*Table

+ type SchemaOpts struct

+ type Table struct

+ func AddTable(scm *Schema, name string, latestSchemaVer uint64, ...) *Table

+ func (tbl *Table) DecodeKeyVal(buf []byte) reflect.Value

+ func (tbl *Table) EncodeKey(key any) []byte

+ func (tbl *Table) KeyString(key any) string

+ func (tbl *Table) KeyType() reflect.Type

+ func (tbl *Table) Name() string

+ func (tbl *Table) NewRow() any

+ func (tbl *Table) NewRowVal() reflect.Value

+ func (tbl *Table) ParseKey(s string) (any, error)

+ func (tbl *Table) ParseKeyVal(s string) (reflect.Value, error)

+ func (tbl *Table) RawKeyString(keyRaw []byte) string

+ func (tbl *Table) RowKey(row any) any

+ func (tbl *Table) RowKeyVal(rowVal reflect.Value) reflect.Value

+ func (tbl *Table) SetRowKey(row, key any)

+ func (tbl *Table) SetRowKeyVal(rowVal, keyVal reflect.Value)

+ type TableError struct

+ Err error

+ Index *Index

+ Key []byte

+ Msg string

+ Table *Table

+ func (e *TableError) Error() string

+ func (e *TableError) Unwrap() error

+ type TableStats struct

+ DataAlloc int

+ DataSize int

+ IndexAlloc int

+ IndexRows int

+ IndexSize int

+ Rows int

+ func (ts *TableStats) TotalAlloc() int

+ func (ts *TableStats) TotalSize() int

+ type Tx struct

+ func (tx *Tx) Close()

+ func (tx *Tx) Commit() error

+ func (tx *Tx) CommitDespiteError()

+ func (tx *Tx) DBTx() *Tx

+ func (tx *Tx) DeleteByKey(tbl *Table, key any) bool

+ func (tx *Tx) DeleteByKeyRaw(tbl *Table, keyRaw []byte) bool

+ func (tx *Tx) DeleteByKeyVal(tbl *Table, keyVal reflect.Value) bool

+ func (tx *Tx) Dump(f DumpFlags) string

+ func (tx *Tx) Exists(tbl *Table, key any) bool

+ func (tx *Tx) Get(tbl *Table, key any) (any, ValueMeta)

+ func (tx *Tx) GetByKeyVal(tbl *Table, keyVal reflect.Value) (any, ValueMeta)

+ func (tx *Tx) GetMemo(key string) (any, bool)

+ func (tx *Tx) GetMeta(tbl *Table, key any) ValueMeta

+ func (tx *Tx) GetMetaByKeyVal(tbl *Table, keyVal reflect.Value) ValueMeta

+ func (tx *Tx) IndexScan(idx *Index, opt ScanOptions) *RawIndexCursor

+ func (tx *Tx) IsWritable() bool

+ func (tx *Tx) Lookup(idx *Index, indexKey any) any

+ func (tx *Tx) LookupKey(idx *Index, indexKey any) any

+ func (tx *Tx) LookupKeyVal(idx *Index, indexKeyVal reflect.Value) reflect.Value

+ func (tx *Tx) LookupVal(idx *Index, indexKeyVal reflect.Value) (reflect.Value, ValueMeta)

+ func (tx *Tx) Memo(key string, f func() (any, error)) (any, error)

+ func (tx *Tx) Put(tbl *Table, row any) ValueMeta

+ func (tx *Tx) PutVal(tbl *Table, rowVal reflect.Value) ValueMeta

+ func (tx *Tx) Reindex(tbl *Table, idx *Index)

+ func (tx *Tx) TableScan(tbl *Table, opt ScanOptions) *RawTableCursor

+ func (tx *Tx) TableStats(tbl *Table) TableStats

+ type Txish interface

+ DBTx func() *Tx

+ type ValueMeta struct

+ ModCount uint64

+ SchemaVer uint64

+ func (vm ValueMeta) Exists() bool

+ func (vm ValueMeta) IsMissing() bool

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