Skip to main content

Documentation Index

Fetch the complete documentation index at: https://ahvn.top/llms.txt

Use this file to discover all available pages before exploring further.

One workspace, many backends, one query surface.

​
1. What a workspace is

A HeavenBase workspace groups together:
  • registered entity schemas
  • configured backend instances
  • field-level route declarations
  • the internal MetaSchema for bookkeeping
Every operation — write, find, update, delete — happens within a workspace.

​
2. Configuration

import heavenbase as hb

ws = hb.HeavenBase(
    "my-workspace",
    backends={
        "main": {"backend_type": "sqlite", "path": "data.db"},
        "vec":  {"backend_type": "inmem"},
    }
)

​
3. Registering entities

ws.register(MyEntity)
Or pass entities at construction: 
ws = hb.HeavenBase("ws", backends={...}, entities=[MyEntity])

​
4. Catalog

hb.catalog.logical_types()                   # all logical type options
hb.catalog.backends(hb.Vector)               # backends that can store Vector
hb.catalog.strategies(hb.Vector)             # strategies for Vector fields
hb.catalog.ops(hb.ShortText, hb.InlineColumn, backend="sqlite")

​
Further Exploration

Related resources: