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

Getting started

SPEC · CONSTRAINTS

ORM / aliases

ORM / column_map

Troubleshooting

Markers / dialects

Markers

DIALECT_SUPPORT

Public surface

API

Application autodoc

Plugins

PLUGIN_SYSTEM

Plugin autodoc · IR_CONTRACT

Terms

Glossary

Application API (narrative)

Plugin & dialect reference

Generated API

Import markers from sqlrules (re-exported) or sqlrules.markers.

Architecture (explanation)