| title | GraphQL ORM documentation index |
|---|---|
| kind | reference |
| status | active |
| owner | workspace-maintainers |
| last_reviewed | 2026-08-16 |
| review_by | 2027-02-01 |
| supersedes |
Choose the route that matches what you are trying to do. The learning and how-to paths are for application developers; architecture, decisions, operations, and plans preserve the deeper contracts and maintainer record.
Build and query a small local service first.
- SQLite GraphQL quickstart — managed schema, seed data, generated roots, Axum transport, and a smoke test.
- Learn index — the recommended sequence and example inventory.
Follow a focused task rather than reading reference material end-to-end.
- How-to index
- Choose backend features
- Manage a schema
- Model entities and relations
- Use SQL Server safely
- Configure PostgreSQL and RLS
Start with the graphql-orm reference for
core runtime mechanics and configuration. Use the macro and attribute
reference for the accepted
derive and schema_roots! syntax. The reference index
also links generated inventories and component-local contract documentation.
Architecture explains durable boundaries and trade-offs:
- System context and package boundaries
- Portable persistence
- Authentication and authorization
- Operation assurance
- Schema modules and fenced leases
- Storage and backup boundaries
Each package owns its local contract documentation:
graphql-ormgraphql-orm-macrosgraphql-orm-operation-cataloggraphql-orm-storagegraphql-orm-backupgraphql-orm-ai- AI capability discovery and execution
graphql-orm-ai-tool-profilesgraphql-orm-router-protocolgraphql-orm-router
The generated workspace package inventory is the canonical version and dependency overview.
- Development — local setup, testing, and GraphQL workflow.
- Operations — repeatable operational and release guidance.
- Decisions — accepted durable rationale.
- Plans — active outcomes and bounded backlog.
- Investigations — retained evidence and conclusions.
- Archive — superseded history, not current guidance.
One active canonical document owns each topic. The lifecycle, metadata, and exceptions are defined by ADR-0001.