CompilerConfig

relationalai.config.config_fields

Configure compiler behavior for query translation.

This controls client-side compilation defaults such as strictness, output formatting, and a few experimental optimization flags.

Examples

Minimal YAML (in raiconfig.yaml):

default_connection: sf
connections:
    sf:
        type: snowflake
        # ...
compiler:
    strict: true
    soft_type_errors: true

Configure compiler settings using a dict:

from relationalai.config import create_config

cfg = create_config(
    compiler={"dry_run": True, "strict": True, "soft_type_errors": True},
)

Configure compiler settings using an explicit CompilerConfig instance:

from relationalai.config import create_config, CompilerConfig

cfg = create_config(
    compiler=CompilerConfig(dry_run=True, strict=True, soft_type_errors=True),
)

Attributes

.dry_run

CompilerConfig.dry_run: bool

Run compilation in dry-run mode.

.strict

CompilerConfig.strict: bool

Enable strict validation mode.

.soft_type_errors

CompilerConfig.soft_type_errors: bool

Treat type errors as warnings instead of failures.

.require_mode

CompilerConfig.require_mode: {'ignore', 'report'}

How to handle require constraints. "ignore" silently skips them; "report" surfaces violations as diagnostics.

Inheritance Hierarchy

Referenced By

RelationalAI Documentation
└──  Build With RelationalAI
    └──  Understand how PyRel works > Configure PyRel
        └──  Configure compilation behavior
            ├──  Enable or disable dry-run mode
            └──  Enable or disable soft type errors