Document serai-db with bounds and intent

This commit is contained in:
Luke Parker
2024-12-26 02:32:14 -05:00
parent 9c92709e62
commit 1d50792eed
5 changed files with 220 additions and 195 deletions

8
common/db/README.md Normal file
View File

@@ -0,0 +1,8 @@
# Serai DB
An inefficient, minimal abstraction around databases.
The abstraction offers `get`, `put`, and `del` with helper functions and macros
built on top. Database iteration is not offered, forcing the caller to manually
implement indexing schemes. This ensures wide compatibility across abstracted
databases.