git.tcp.direct/tcp.direct/database
import "git.tcp.direct/tcp.direct/database"
[!WARNING]
This package is pre-v1 and the API is NOT stable!
var ErrKeyNotFound = errors.New("key not found")
type Filer interface {
// Backend returns the underlying key/value store.
Backend() any
// Has should return true if the given key has an associated value.
Has(key []byte) bool
// Get should retrieve the byte slice corresponding to the given key, and any associated errors upon failure.
Get(key []byte) ([]byte, error)
// Put should insert the value data in a way that is associated and can be retrieved by the given key data.
Put(key []byte, value []byte) error
// Delete should delete the key and the value associated with the given key, and return an error upon failure.
Delete(key []byte) error
// Close should safely end any Filer operations of the given dataStore and close any relevant handlers.
Close() error
// Sync should take any volatile data and solidify it somehow if relevant. (ram to disk in most cases)
Sync() error
Keys() [][]byte
Len() int
}
Filer is is a way to implement any generic key/value store. These functions should be plug and play with most of the popular key/value store golang libraries.
NOTE: Many key/value golang libraries will already implement this interface already. This exists for more potential granular control in the case that they don't. Otherwise you'd have to build a wrapper around an existing key/value store to satisfy an overencompassing interface.
type Keeper interface {
// Path should return the base path where all stores should be stored under. (likely as subdirectories)
Path() string
// Init should initialize our Filer at the given path, to be referenced and called by dataStore.
Init(name string, options ...any) error
// With provides access to the given dataStore by providing a pointer to the related Filer.
With(name string) Filer
// WithNew should initialize a new Filer at the given path and return a pointer to it.
WithNew(name string, options ...any) Filer
// Destroy should remove the Filer by the given name.
// It is up to the implementation to decide if the data should be removed or not.
Destroy(name string) error
Discover() ([]string, error)
AllStores() map[string]Filer
// BackupAll should create a backup of all [Filer] instances in the [Keeper].
BackupAll(archivePath string) (models.Backup, error)
// RestoreAll should restore all [Filer] instances from the given archive.
RestoreAll(archivePath string) error
Meta() models.Metadata
Close(name string) error
CloseAll() error
SyncAll() error
SyncAndCloseAll() error
}
Keeper will be in charge of the more meta operations involving Filers. This includes operations like initialization, syncing to disk if applicable, and backing up.
- When opening a folder of Filers, it should be able to discover and initialize all of them.
- Additionally, it should be able to confirm the type of the underlying key/value store.
type KeeperCreator func(path string) (Keeper, error)
type MockFiler struct {
}
func (m *MockFiler) Backend() any
func (m *MockFiler) Close() error
func (m *MockFiler) Delete(key []byte) error
func (m *MockFiler) Get(key []byte) ([]byte, error)
func (m *MockFiler) Has(key []byte) bool
func (m *MockFiler) Keys() [][]byte
func (m *MockFiler) Len() int
func (m *MockFiler) Put(key []byte, value []byte) error
func (m *MockFiler) Sync() error
type MockKeeper struct {
}
func NewMockKeeper(name string) *MockKeeper
func (m *MockKeeper) AllStores() map[string]Filer
func (m *MockKeeper) BackupAll(archivePath string) (models.Backup, error)
func (m *MockKeeper) Close(name string) error
func (m *MockKeeper) CloseAll() error
func (m *MockKeeper) Destroy(name string) error
func (m *MockKeeper) Discover() ([]string, error)
func (m *MockKeeper) Init(name string, options ...any) error
func (m *MockKeeper) Meta() models.Metadata
func (m *MockKeeper) Path() string
func (m *MockKeeper) RestoreAll(archivePath string) error
func (m *MockKeeper) SyncAll() error
func (m *MockKeeper) SyncAndCloseAll() error
func (m *MockKeeper) With(name string) Filer
func (m *MockKeeper) WithNew(name string, options ...any) Filer
type Searcher interface {
// PrefixScan must retrieve all keys in the datastore and stream them to the given channel.
PrefixScan(prefix string) (<-chan kv.KeyValue, chan error)
// Search must be able to search through the value contents of our database and stream the results to the given channel.
Search(query string) (<-chan kv.KeyValue, chan error)
// ValueExists searches for an exact match of the given value and returns the key that contains it.
ValueExists(value []byte) (key []byte, ok bool)
}
Searcher must be able to search through our datastore(s) with strings.
type Store interface {
Filer
Searcher
}
Store is an implementation of a Filer and a Searcher.
FAQs
Unknown package
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.