package
0.9.1
Repository: https://github.com/aperturerobotics/cayley.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
Package b implements a B+tree.
No description provided by the author
No description provided by the author

# Functions

ApplyIteratorOptions applies all iterator options.
ByName returns a registered database driver by it's name.
Each is a helper to enumerate all key-value pairs with a specific prefix.
GetBatch is an implementation of Tx.GetBatch for databases that has no native implementation for it.
KeyEscape converts kv.Key to a flat Key.
KeyUnescape converts flat Key into kv.Key.
List enumerates all globally registered database drivers.
Register globally registers a database driver.
Seek the iterator to a given key.
Update is a helper to open a read-write transaction and update the database.
Upgrade upgrades flat KV to hierarchical KV.
UpgradeOpenPath automatically upgrades flat KV to hierarchical KV on open.
View is a helper to open a read-only transaction to read the database.

# Variables

ErrConflict is returned when write operation performed be current transaction cannot be committed because of another concurrent write.
ErrNotFound is returned then a key was not found in the database.
ErrReadOnly is returned when write operation is performed on read-only database or transaction.

# Structs

Pair is a key-value pair.
Registration is an information about the database driver.

# Interfaces

No description provided by the author
Iterator is an iterator over hierarchical key-value store.
IteratorOption is an additional option that affects iterator behaviour.
KV is an interface for flat key-value databases.
PrefixIterator is an Iterator optimization to support WithPrefix option.
No description provided by the author
Tx is a transaction over flat key-value store.

# Type aliases

IteratorOptionFunc is a function type that implements IteratorOption.
Key is a flat binary key used in a database.
OpenPathFunc is a function for opening a database given a path.
Value is a binary value stored in a database.