Complete technical reference for Harper v5. Each section covers a core feature or subsystem — configuration options, APIs, and operational details.
For concept introductions, tutorials, and guides, see the Learn section.
Sections
Data & Application
| Section | Description |
|---|
| Database | Schema system, storage, indexing, transactions, and the database JS API |
| Resources | Custom resource classes, the Resource API, and query optimization |
| Components | Applications, extensions, the Plugin API, and the JS environment |
Access & Security
| Section | Description |
|---|
| REST | Auto-REST interface, querying, content types, headers, WebSockets, and SSE |
| HTTP | HTTP server configuration, TLS, and the server API |
| Security | Authentication mechanisms, certificates, and CORS/SSL configuration |
| Users & Roles | RBAC, roles configuration, and user management operations |
Setup & Operation
| Section | Description |
|---|
| CLI | All CLI commands, Operations API commands, and authentication |
| Configuration | harperdb-config.yaml options and configuration operations |
| Operations API | Full index of all Operations API operations |
Features
| Section | Description |
|---|
| Logging | Log configuration, the logger API, and log management operations |
| Analytics | Resource and storage analytics, system tables |
| MQTT | MQTT broker configuration and usage |
| Static Files | Static file serving via the static plugin |
| Environment Variables | Environment variable loading via the loadEnv plugin |
| Replication | Native replication, clustering, and sharding |
| GraphQL Querying | Experimental GraphQL support |
| Studio | Local Studio UI configuration and access |
| Fastify Routes | Fastify route definitions (discouraged in favor of components) |
Legacy
| Section | Description |
|---|
| Harper Cloud | Legacy Harper Cloud documentation — see Fabric for current cloud hosting |
| Custom Functions | Deprecated predecessor to Components |