Welcome to KelDB documentation!

KelDB is an asynchronous hierarchical key-value database built around a tree of nodes with pluggable storage backends.

Getting Started

• Quickstart
  • Installation
  • Basic Usage
  • What this does
• Working with Nodes
  • What is a Node?
  • Creating Nodes
  • Setting Values
  • Reading Values
  • Listing Subnodes
  • Deleting Nodes
  • Lock Tutorial
• Creating a Custom Hook
  • Why Hooks exist
  • Basic structure
  • Using your hook
• Best Practices
  • Use small, focused nodes
  • Prefer structured paths
  • Be careful with locks
  • Back up your data!

API Reference

• KelDB
  • KelDB
  • Node
• KelDB Hooks
  • FileStoreHook
  • Hook
  • MemoryStoreHook
• KelDB Locks
  • BasicLockSystem
  • DummyLock
  • DummyLockSystem
  • LockSystem
  • SingleLockSystem