Internal API

The modules documented here are primarily useful for people who are:

• Developing plugins or custom rules that interact with SQLFluff at a deeper level.
• Contributing to the SQLFluff codebase itself.

As these docs cover less frequently accessed internals, not all modules are fully documented here. Reading this alongside the docstrings and comments directly in the SQLFluff codebase on GitHub is recommended.

Modules

Module	Description
Configuration & FluffConfig	FluffConfig class and config loading functions used by the Python API.
Functional Traversal API	Higher-level API for navigating parse trees in rules.
Reflow API	Centralised utilities for whitespace and layout rules.
Rules Base API	BaseRule, LintResult, LintFix, RuleContext, and crawlers.