This is an automated email from the ASF dual-hosted git repository.
toulmean pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-tuweni.git
The following commit(s) were added to refs/heads/main by this push:
new 28e32cfdf Add docs for kv module
new 1fe589d71 Merge pull request #508 from atoulme/add_kv_docs
28e32cfdf is described below
commit 28e32cfdf416c6e1cda42a7a67479557b7221710
Author: Antoine Toulme <anto...@lunar-ocean.com>
AuthorDate: Sun Jan 29 22:50:37 2023 -0800
Add docs for kv module
---
kv/README.md | 18 ++++++++++++++++++
1 file changed, 18 insertions(+)
diff --git a/kv/README.md b/kv/README.md
index 9affda652..5c8825356 100644
--- a/kv/README.md
+++ b/kv/README.md
@@ -17,5 +17,23 @@ specific language governing permissions and limitations
under the License.
| Stability | [stable] |
| Component Type | [library] |
+This library implements key/value stores backed by different persistence
mechanisms.
+
+| Description | In memory
| No external dependencies | Class
|
+|------------------------------------------------------------------|-----------|--------------------------|------------------------------------------------------------------------------------------------------------------------------|
+| JPA-backed key value store |
| |
[EntityManagerKeyValueStore](https://tuweni.apache.org/docs/org.apache.tuweni.kv/-entity-manager-key-value-store/index.html)
|
+| A key-value store backed by [Infinispan](https://infinispan.org) |
| |
[InfinispanKeyValueStore](https://tuweni.apache.org/docs/org.apache.tuweni.kv/-infinispan-key-value-store/index.html)
|
+| A key-value store backed by LevelDB |
| X |
[LevelDBKeyValueStore](https://tuweni.apache.org/docs/org.apache.tuweni.kv/-level-d-b-key-value-store/index.html)
|
+| A key-value store backed by a MapDB instance | X
| X |
[MapDBKeyValueStore](https://tuweni.apache.org/docs/org.apache.tuweni.kv/-map-d-b-key-value-store/index.html)
|
+| A key-value store backed by an in-memory Map | X
| X |
[MapKeyValueStore](https://tuweni.apache.org/docs/org.apache.tuweni.kv/-map-key-value-store/index.html)
|
+| A store used as a proxy for another store |
| |
[ProxyKeyValueStore](https://tuweni.apache.org/docs/org.apache.tuweni.kv/-proxy-key-value-store/index.html)
|
+| A key-value store backed by Redis |
| |
[RedisKeyValueStore](https://tuweni.apache.org/docs/org.apache.tuweni.kv/-redis-key-value-store/index.html)
|
+| A key-value store backed by RocksDB |
| X |
[RocksDBKeyValueStore](https://tuweni.apache.org/docs/org.apache.tuweni.kv/-rocks-d-b-key-value-store/index.html)
|
+| A key-value store backed by a relational database. |
| |
[SQLKeyValueStore](https://tuweni.apache.org/docs/org.apache.tuweni.kv/-s-q-l-key-value-store/index.html)
|
+
+The stores all implement
[KeyValueStore](https://tuweni.apache.org/docs/org.apache.tuweni.kv/-key-value-store/index.html)
so they can be used interchangeably in applications.
+
+The interface offers both coroutine-friendly methods (`getAsync`, `putAsync`)
and asynchronous methods returning
[`AsyncResult`](https://tuweni.apache.org/docs/org.apache.tuweni.concurrent/-async-result/index.html)
or
[`AsyncCompletion`](https://tuweni.apache.org/docs/org.apache.tuweni.concurrent/-async-completion/index.html)
objects.
+
[stable]:https://github.com/apache/incubator-tuweni/tree/main/docs/index.md#stable
[library]:https://github.com/apache/incubator-tuweni/tree/main/docs/index.md#library
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@tuweni.apache.org
For additional commands, e-mail: commits-h...@tuweni.apache.org
