-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
42 additions
and
40 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# MapStore | ||
|
||
<!-- toc --> | ||
|
||
- [Implementations](#implementations) | ||
* [SimpleMap](#simplemap) | ||
* [BadgerV4](#badgerv4) | ||
|
||
<!-- tocstop --> | ||
|
||
The `MapStore` is a simple interface used by the SM(S)T to store, delete and | ||
retrieve key-value pairs. It is intentionally simple and minimalistic so as to | ||
enable different key-value engines to implement and back the trie database. | ||
|
||
See: [the interface](../kvstore/interfaces.go) for a more detailed description | ||
of the simple interface required by the SM(S)T. | ||
|
||
## Implementations | ||
|
||
### SimpleMap | ||
|
||
`simplemap` is a simple kv-store shipped with the SM(S)T. The SMT library that | ||
can be used without it as long as the selected node store adheres to the | ||
`Mapstore` interface. | ||
|
||
This library is recommended for development, testing and exploration purposes. | ||
|
||
This library **SHOULD NOT** be used in production. | ||
|
||
See [simplemap.go](../kvstore/simplemap/simplemap.go) for more details. | ||
|
||
### BadgerV4 | ||
|
||
This library provides a wrapper around [dgraph-io/badger][badgerv4] to adhere | ||
to the `MapStore` interface. See the [full documentation](./badger-store.md) | ||
for additional functionality and implementation details. | ||
|
||
See: [badger](../kvstore/badger/) for more details on the implementation of | ||
this submodule. | ||
|
||
[badgerv4]: https://github.com/dgraph-io/badger |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters