Reference¶
Contract and generated API for SQLRules 1.0.1.
When narrative docs and autodoc disagree, trust the installed package signatures and autodoc, then file an issue against the narrative page. Narrative docs explain why and when; autodoc is the parameter / return / exception contract.
Start with a guide¶
Goal |
Read first |
Then |
|---|---|---|
Compile constraints |
||
ORM / aliases |
||
Markers / dialects |
||
Public surface |
||
Plugins |
||
Terms |
— |
Application API (narrative)¶
SPEC — return shape, binding, unsupported policy
API — Application / Plugin / Internal tiers
IR_CONTRACT — frozen Plugin API v1 IR schema
CONSTRAINTS — operator → expression map
Plugin & dialect reference¶
Generated API¶
Application autodoc —
compile,where,Compiler, markersPlugin / IR autodoc — registry, IR types, plugin protocol
Import markers from sqlrules (re-exported) or sqlrules.markers.