Documentation
product Pre-releaseunwritten sections are marked
Documentation
The pages below are written and current, including the complete shipped API surface. The rest is the planned shape of the documentation set, published so you can see exactly what will exist — and exactly what doesn’t yet. A stub is always marked as one.
Written
Introduction
What OrdinateDB is, who it is for, and the five-minute mental model.
A PI engineer's guide to OrdinateDB
Concept-by-concept mapping from the PI System, and the deliberate differences.
Symbol library
The ISA-101 industrial symbol set OrdinateDB's model-driven displays are built from.
API reference
Every shipped REST operation, authentication and wire conventions, streaming, gRPC ingest, and OpenAPI.
Planned
Getting startedFrom empty box to first live trend.
4 pages plannedConceptsThe ideas everything else is built from.
7 pages plannedIngestionGetting data in, and never losing it.
5 pages plannedModellingTemplates and the model-driven everything.
6 pages plannedQueryingReading data back, honestly.
5 pages plannedCalculationsDerived data, deterministic by construction.
5 pages plannedVisualisationHonest rendering on wall, desktop and handheld.
5 pages plannedHuman-origin dataManual values, treated as first-class and marked as human.
4 pages plannedNotificationsTelling humans, without crying wolf.
3 pages plannedAdministrationRunning the system as configuration, not folklore.
6 pages plannedOperationsSizing, watching and fixing a running instance.
4 pages plannedReferenceTables you look up mid-task.
4 pages plannedSpecsThe interrogated design documents the system is built from.
1 page planned