- Imports:
- interface
wrpc:keyvalue/store@0.2.0-draft - interface
wrpc:keyvalue/atomics@0.2.0-draft - interface
wrpc:keyvalue/batch@0.2.0-draft
- interface
- Exports:
- interface
wrpc:keyvalue/watcher@0.2.0-draft
- interface
A keyvalue interface that provides eventually consistent key-value operations.
Each of these operations acts on a single key-value pair.
The value in the key-value pair is defined as a u8 byte array and the intention is that it is
the common denominator for all data types defined by different key-value stores to handle data,
ensuring compatibility between different key-value stores. Note: the clients will be expecting
serialization/deserialization overhead to be handled by the key-value store. The value could be
a serialized object from JSON, HTML or vendor-specific data types like AWS S3 objects.
Data consistency in a key value store refers to the guarantee that once a write operation completes, all subsequent read operations will return the value that was written.
Any implementation of this interface must have enough consistency to guarantee "reading your writes." In particular, this means that the client should never get a value that is older than the one it wrote, but it MAY get a newer value if one was written around the same time. These guarantees only apply to the same client (which will likely be provided by the host or an external capability of some kind). In this context a "client" is referring to the caller or guest that is consuming this interface. Once a write request is committed by a specific client, all subsequent read requests by the same client will reflect that write or any subsequent writes. Another client running in a different context may or may not immediately see the result due to the replication lag. As an example of all of this, if a value at a given key is A, and the client writes B, then immediately reads, it should get B. If something else writes C in quick succession, then the client may get C. However, a client running in a separate context may still see A or B
The set of errors which may be raised by functions in this package
-
The host does not recognize the store identifier requested.
-
The requesting component does not have access to the specified store (which may or may not exist).
-
Some implementation-specific error has occurred (e.g. I/O)
A response to a list-keys operation.
-
The list of keys returned by the query.
-
The continuation token to use to fetch the next page of keys. If this is `null`, then there are no more keys to fetch.
A bucket is a collection of key-value pairs. Each key-value pair is stored as a entry in the bucket, and the bucket itself acts as a collection of all these entries.
It is worth noting that the exact terminology for bucket in key-value stores can very depending on the specific implementation. For example:
- Amazon DynamoDB calls a collection of key-value pairs a table
- Redis has hashes, sets, and sorted sets as different types of collections
- Cassandra calls a collection of key-value pairs a column family
- MongoDB calls a collection of key-value pairs a collection
- Riak calls a collection of key-value pairs a bucket
- Memcached calls a collection of key-value pairs a slab
- Azure Cosmos DB calls a collection of key-value pairs a container
In this interface, we use the term bucket to refer to a collection of key-value pairs
Get the value associated with the specified key
The value is returned as an option. If the key-value pair exists in the
store, it returns Ok(value). If the key does not exist in the
store, it returns Ok(none).
If any other error occurs, it returns an Err(error).
- result<option<list<
u8>>,error>
Set the value associated with the key in the store. If the key already exists in the store, it overwrites the value.
If the key does not exist in the store, it creates a new key-value pair.
If any other error occurs, it returns an Err(error).
- result<_,
error>
Delete the key-value pair associated with the key in the store.
If the key does not exist in the store, it does nothing.
If any other error occurs, it returns an Err(error).
- result<_,
error>
Check if the key exists in the store.
If the key exists in the store, it returns Ok(true). If the key does
not exist in the store, it returns Ok(false).
If any other error occurs, it returns an Err(error).
- result<
bool,error>
Get all the keys in the store with an optional cursor (for use in pagination). It
returns a list of keys. Please note that for most KeyValue implementations, this is a
can be a very expensive operation and so it should be used judiciously. Implementations
can return any number of keys in a single response, but they should never attempt to
send more data than is reasonable (i.e. on a small edge device, this may only be a few
KB, while on a large machine this could be several MB). Any response should also return
a cursor that can be used to fetch the next page of keys. See the key-response record
for more information.
Note that the keys are not guaranteed to be returned in any particular order.
If the store is empty, it returns an empty list.
MAY show an out-of-date list of keys if there are concurrent writes to the store.
If any error occurs, it returns an Err(error).
- result<
key-response,error>
A keyvalue interface that provides atomic operations.
Atomic operations are single, indivisible operations. When a fault causes an atomic operation to fail, it will appear to the invoker of the atomic operation that the action either completed successfully or did nothing at all.
Please note that this interface is bare functions that take a reference to a bucket. This is to
get around the current lack of a way to "extend" a resource with additional methods inside of
wit. Future version of the interface will instead extend these methods on the base bucket
resource.
----
Atomically increment the value associated with the key in the store by the given delta. It returns the new value.
If the key does not exist in the store, it creates a new key-value pair with the value set to the given delta.
If any other error occurs, it returns an Err(error).
- result<
u64,error>
A keyvalue interface that provides batch operations.
A batch operation is an operation that operates on multiple keys at once.
Batch operations are useful for reducing network round-trip time. For example, if you want to get the values associated with 100 keys, you can either do 100 get operations or you can do 1 batch get operation. The batch operation is faster because it only needs to make 1 network call instead of 100.
A batch operation does not guarantee atomicity, meaning that if the batch operation fails, some of the keys may have been modified and some may not.
This interface does has the same consistency guarantees as the store interface, meaning that
you should be able to "read your writes."
Please note that this interface is bare functions that take a reference to a bucket. This is to
get around the current lack of a way to "extend" a resource with additional methods inside of
wit. Future version of the interface will instead extend these methods on the base bucket
resource.
----
Get the key-value pairs associated with the keys in the store. It returns a list of key-value pairs.
If any of the keys do not exist in the store, it returns a none value for that pair in the
list.
MAY show an out-of-date value if there are concurrent writes to the store.
If any other error occurs, it returns an Err(error).
- result<list<option<(
string, list<u8>)>>,error>
Set the values associated with the keys in the store. If the key already exists in the store, it overwrites the value.
Note that the key-value pairs are not guaranteed to be set in the order they are provided.
If any of the keys do not exist in the store, it creates a new key-value pair.
If any other error occurs, it returns an Err(error). When an error occurs, it does not
rollback the key-value pairs that were already set. Thus, this batch operation does not
guarantee atomicity, implying that some key-value pairs could be set while others might
fail.
Other concurrent operations may also be able to see the partial results.
- result<_,
error>
Delete the key-value pairs associated with the keys in the store.
Note that the key-value pairs are not guaranteed to be deleted in the order they are provided.
If any of the keys do not exist in the store, it skips the key.
If any other error occurs, it returns an Err(error). When an error occurs, it does not
rollback the key-value pairs that were already deleted. Thus, this batch operation does not
guarantee atomicity, implying that some key-value pairs could be deleted while others might
fail.
Other concurrent operations may also be able to see the partial results.
- result<_,
error>
A keyvalue interface that provides handle-watch operations.
Handle the set event for the given bucket and key. It includes a reference to the bucket
that can be used to interact with the store.
Handle the delete event for the given bucket and key. It includes a reference to the
bucket that can be used to interact with the store.