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.

Catalog is what you browse. MetaSchema is how HeavenBase explains structure.

​
1. Catalog — concrete objects

Catalog is the user-facing directory of concrete entity instances in a workspace. Query it before choosing a typed entity query when an agent or user only knows names, descriptions, tags, or broad object categories: 
rows = (
    ws.query(hb.Catalog)
    .where(hb.Catalog.target_entity == "product")
    .select("target_id", "target_entity", "name", "desc", "tags")
    .execute()
    .rows()
)

product = ws.get(rows[0]["target_id"], entity=rows[0]["target_entity"])
Catalog.object_id is the catalog row primary key. Catalog.target_id is the target object’s object_id, and Catalog.target_entity is the target entity type.

​
2. MetaSchema — workspace structure

MetaSchema tracks workspace rows, backend capability records, entity definitions, field rows, storage rows, and handler registry entries. It is queryable for debugging and agent introspection: 
fields = (
    ws.query(hb.MetaSchema)
    .where(hb.MetaSchema.subject_id == "product")
    .where(hb.MetaSchema.kind == "field")
    .select("field", "dtype", "desc", "backend", "strategy")
    .execute()
    .rows()
)
Use MetaSchema to learn structure and Catalog to discover concrete objects.

​
3. Capability index

hb.capabilities exposes selectable built-in and registered extension components without reading internal registries: 
hb.capabilities.logical_types()
hb.capabilities.strategies(hb.Vector)
hb.capabilities.backends(hb.Array, hb.SideTable, op="array_contains")
hb.capabilities.ops(hb.ShortText, hb.InlineColumn, backend="sqlite")
hb.capabilities.supports(hb.Vector, "near", "inmem", hb.VectorIndex)

​
Further Exploration

Related resources: