Ctrl K
Develop with NornicDB
Use NornicDB as a managed Go library, integrate through a server protocol, or extend the existing storage and query APIs.
Build an application
- Embed in Go: dependency selection, opening/querying/closing a DB, ownership, transactions, and process-wide settings.
- Canonical API reference: supported Go interfaces and protocol contracts.
- Transactions: visibility, conflicts, commit outcomes, and driver examples.
- Multiple databases: namespace and routing boundaries.
- Plugins and APOC capabilities: supported extension points.
Integrate below the DB API
Lower-level callers own more of the lifecycle. Read the applicable contract before reaching into storage or constructing an executor:
| Integration | Contract |
|---|---|
| Query classification/preparation | Preparation context, source stages, statement API migration. |
| Stored entities | Bulk reads, read delivery, transaction deletion. |
| Indexes | Full-text Go API, index publication, cancellation. |
| Catalogs/functions/plugins | Catalog contexts, function context, plugin metadata. |
| Background and accepted work | Work lifetime, snapshot/replay completion, replicated commits. |
Operate an embedded store
Read durability, backup/restore, memory accounting, and low-memory mode. A library call does not install HTTP authorization, container limits, or an application shutdown policy.
Contribute to NornicDB
The contribution guide covers repository setup, branch policy, validation, and PR evidence. Use local build setup, coding conventions, and testing for contributor details.