Documentation
¶
Overview ¶
Package kv provides a key-value database that can be used to store and retrieve data.
The key-value database is backed by BoltDB, and is shared between all VUs. It is persisted to disk, so data stored in the database will be available across test runs.
The database is opened when the first KV instance is created, and closed when the last KV instance is closed.
Index ¶
- Constants
- Variables
- type Error
- type ErrorName
- type KV
- func (k *KV) Clear() *goja.Promise
- func (k *KV) Close() error
- func (k *KV) Delete(key goja.Value) *goja.Promise
- func (k *KV) Get(key goja.Value) *goja.Promise
- func (k *KV) List(options goja.Value) *goja.Promise
- func (k *KV) Set(key goja.Value, value goja.Value) *goja.Promise
- func (k *KV) Size() *goja.Promise
- type ListEntry
- type ListOptions
- type ModuleInstance
- type RootModule
Constants ¶
const ( // DatabaseNotOpenError is emitted when the database is accessed before it is opened // or after it is closed. DatabaseNotOpenError ErrorName = "DatabaseNotOpenError" // DatabaseAlreadyOpenError is emitted when the database is opened more than once. DatabaseAlreadyOpenError = "DatabaseAlreadyOpenError" // BucketNotFoundError is emitted when the bucket is not found in the database. BucketNotFoundError = "BucketNotFoundError" // BucketExistsError is emitted when the bucket already exists in the database. BucketExistsError = "BucketExistsError" // KeyNotFoundError is emitted when the key is not found in the bucket. KeyNotFoundError = "KeyNotFoundError" // KeyRequiredError is emitted when inserting an empty key. KeyRequiredError = "KeyRequiredError" // KeyTooLargeError is emitted when the key is too large. KeyTooLargeError = "KeyTooLargeError" // ValueTooLargeError is emitted when the value is too large. ValueTooLargeError = "ValueTooLargeError" )
const ( // DefaultKvPath is the default path to the KV store DefaultKvPath = ".k6.kv" // DefaultKvBucket is the default bucket name for the KV store DefaultKvBucket = "k6" )
Variables ¶
var ErrStop = errors.New("stop")
ErrStop is used to stop a BoltDB iteration.
Functions ¶
This section is empty.
Types ¶
type Error ¶
type Error struct {
// Name contains one of the strings associated with an error name.
Name ErrorName `json:"name"`
// Message represents message or description associated with the given error name.
Message string `json:"message"`
}
Error represents a custom error emitted by the kv module
type KV ¶
type KV struct {
// contains filtered or unexported fields
}
KV is a key-value database that can be used to store and retrieve data.
Keys are always strings, and values can be any JSON-serializable value. Keys are ordered lexicographically. Keys are unique within a database, and the last value set for a given key is the one that is returned when reading the key.
func (*KV) List ¶
List returns all the key-value pairs in the store.
The returned list is ordered lexicographically by key. The returned list is limited to 1000 entries by default. The returned list can be limited to a maximum number of entries by passing a limit option. The returned list can be limited to keys that start with a given prefix by passing a prefix option. See ListOptions for more details
type ListOptions ¶
type ListOptions struct {
// Prefix is used to select all the keys that start
// with the given prefix.
Prefix string `json:"prefix"`
// Limit is the maximum number of entries to return.
Limit int64 `json:"limit"`
// contains filtered or unexported fields
}
ListOptions are the options that can be passed to KV.List().
func ImportListOptions ¶
func ImportListOptions(rt *goja.Runtime, options goja.Value) ListOptions
ImportListOptions instantiates a ListOptions from a goja.Value.
type ModuleInstance ¶
type ModuleInstance struct {
// contains filtered or unexported fields
}
ModuleInstance represents an instance of the JS module.
func (*ModuleInstance) Exports ¶
func (mi *ModuleInstance) Exports() modules.Exports
Exports implements the modules.Instance interface and returns the exports of the JS module.
func (*ModuleInstance) NewKV ¶
func (mi *ModuleInstance) NewKV(_ goja.ConstructorCall) *goja.Object
NewKV implements the modules.Instance interface and returns a new KV instance.
func (*ModuleInstance) OpenKv ¶
func (mi *ModuleInstance) OpenKv() *goja.Object
OpenKv opens the KV store and returns a KV instance.
type RootModule ¶
type RootModule struct {
// contains filtered or unexported fields
}
RootModule is the global module instance that will create Client instances for each VU.
func (*RootModule) NewModuleInstance ¶
func (rm *RootModule) NewModuleInstance(vu modules.VU) modules.Instance
NewModuleInstance implements the modules.Module interface and returns a new instance for each VU.
Source Files