Guides
The guides cover the work that starts after your first successful query: building a complete application, testing database behavior, operating more than one database, and adding the guardrails that make a team’s setup predictable.
Use the API pages beginning with Models when you need a method or option. Use these guides when you need to decide how several pieces fit together.
Choose by the job
| If you need to... | Start here | What you will get |
|---|---|---|
| Build a complete application | Fullstack Tutorial | A realistic path from schema to routes, migrations, seeds, and tests |
| See a focused end-to-end recipe | Examples | Small application patterns you can adapt without reading every API page |
| Test database behavior with confidence | Testing | A test setup, isolation guidance, and checks for queries and persistence |
| Catch model mistakes while you code | Analyzer Plugin | Static feedback for common Ormed model and query issues |
| Store and compare dates correctly | Date and Time | Practical rules for UTC, local display, and database boundaries |
| Support more than one database | Multi-Database Support | Connection routing and tenant-aware patterns |
| Add logs, traces, or query visibility | Observability | Instrumentation points for understanding production behavior |
| Set conventions for a team | Best Practices | A checklist for maintainable models, queries, and application structure |
A practical path
- Start with the Fullstack Tutorial if you want to see the whole application shape. Choose Examples when you only need a focused pattern.
- Add Testing before the data layer becomes difficult to change. Make query behavior and persistence rules executable examples.
- Apply Best Practices and the Analyzer Plugin as your model count grows. These are most valuable when several people touch the same schema.
- Add Multi-Database Support, Observability, or Date and Time when the application has that operational need.
How to use the guides
The guides are intentionally scenario-led. They should help you make a change safely and point you to the API reference only when a detail needs more depth. If you are still deciding whether to use a generated model, a repository, or direct database access, start with Adopt Ormed in an Existing Project.