| title | Learning GraphQL ORM |
|---|---|
| kind | reference |
| status | active |
| owner | workspace-maintainers |
| last_reviewed | 2026-08-12 |
| review_by | 2027-02-01 |
| supersedes |
Start with the SQLite GraphQL quickstart. It is the canonical runnable example in this repository: it creates a managed SQLite schema, inserts data through generated repository helpers, exposes generated GraphQL roots over HTTP, and verifies the query in a smoke test.
The quickstart is the only complete, HTTP-serving onboarding application. The other examples are focused, runnable programs that demonstrate one contract; they are not substitutes for a production-ready host.
| Example | Scope | Run it |
|---|---|---|
sqlite_quickstart |
Complete onboarding: managed SQLite schema, seed data, generated GraphQL roots, and local Axum HTTP server | cargo run -p graphql-orm --example sqlite_quickstart |
mssql_readonly |
Focused: compile the read-only SQL Server entity and schema shape; it does not connect to a database | cargo run -p graphql-orm --no-default-features --features mssql --example mssql_readonly |
operation_assurance |
Focused: generate and audit operation-assurance metadata; it does not run a request-serving schema | cargo run -p graphql-orm --example operation_assurance |
router_descriptor |
Focused: export generated operation metadata as a router-protocol descriptor | cargo run -p graphql-orm --features router-protocol --example router_descriptor |
programmatic_router |
Focused: construct and print a development router configuration; it does not start the router | cargo run -p graphql-orm-router --example programmatic_router |
handwritten_descriptor |
Focused: emit a project-neutral router-protocol descriptor from handwritten declarations | cargo run -p graphql-orm-router-protocol --example handwritten_descriptor |
For an example-backed full-stack service, begin with the quickstart and then follow its security note before adapting the transport or authorization model.
After it runs, continue according to the application you are building:
- Use entities and relations to expand the data model.
- Use schema management before evolving a managed database or adopting an existing one.
- Use backend features when selecting SQLite, PostgreSQL, or the read-only SQL Server integration.
- Use the how-to index for a task-oriented path into security, storage, backup, AI, and Federation router documentation.
The quickstart is a local demonstration, not a production security template.