Reference¶

Use this section when you already know the basic dORM workflow and need to understand a contract, a boundary, or a behavior that must remain consistent when the engine changes.

The reference is organized by decision rather than by package:

When you need to...	Read
Understand how annotations become storage operations	Architecture and boundaries
Check what application code may import and extend	Public surface
Understand generated files and types	Generated output contract
Implement or review an engine	Framework contracts
Compare backend behavior before choosing an engine	Engine and platform support
Classify failures across providers	Portable errors
Review primary-to-replica behavior	Synchronization protocol
Estimate where an operation can do more work	Execution and performance model
Check a term used by more than one section	Glossary
Check current version and compatibility status	Release status

How this section relates to the rest of the docs¶

• Operations explains how to perform a task in an application.
• Model anatomy explains the generated pieces in learning order.
• Annotations explains how to declare models.
• Engines explains how to configure a concrete backend.
• Developer guide explains how to contribute to or implement engines.
• This section records the contracts and decisions that connect those guides.

Use the generated API documentation on pub.dev for the exhaustive list of public members and signatures. Use this repository reference for behavior, invariants, compatibility, and engine differences that a generated member reference cannot explain.

Reading guarantees¶

A statement in this section is a framework guarantee only when it is described as part of a framework contract. Engine-specific tables and notes describe the current implementation and tested behavior of that engine. They do not make a promise about another backend.

When the repository does not establish a compatibility fact, the documentation must say so explicitly rather than turning an inference into a guarantee.