config

relationalai

Load and manage PyRel configuration.

Most projects only need the create_config function:

• Call create_config() to auto-discover and load configuration (for example raiconfig.yaml), or set the RAI_CONFIG_FILE_PATH environment variable to point to a specific file.
• Or pass keyword arguments to build a configuration in code.

This package re-exports the most commonly used config and connection classes so you can import from this package instead of importing from submodules like config or connections.

Examples

To load a config from a file, create a raiconfig.yaml in your project:

default_connection: sf
connections:
    sf:
        type: snowflake
        authenticator: username_password
        account: my_account
        warehouse: my_warehouse
        user: my_user
        password: ${SNOWFLAKE_PASSWORD}

Then load it with create_config (searches upwards from the current working directory):

from relationalai.config import create_config

cfg = create_config()
session = cfg.get_session(name="sf")

Profiles let you define named overrides (for example, dev vs prod) on top of a shared base config. Select which overlay to apply with active_profile.

default_connection: sf
connections:
    sf:
        type: snowflake
        authenticator: username_password
        account: my_account
        warehouse: base_warehouse
        user: my_user
        password: ${SNOWFLAKE_PASSWORD}

profile:
    dev:
        connections:
            sf:
                warehouse: dev_warehouse
    prod:
        connections:
            sf:
                warehouse: prod_warehouse

active_profile: dev

When you load this config with create_config, the active_profile is applied on top of the base config so that Config.get_session creates a session using the overrides in the active profile.

You can also build a config programmatically by passing connection definitions as plain dictionaries. For example, to create a Snowflake connection config:

from relationalai.config import create_config

cfg = create_config(
    connections={
        "sf": {
            "type": "snowflake",
            "authenticator": "username_password",
            "account": "my_account",
            "warehouse": "my_warehouse",
            "user": "my_user",
            "password": "my_password",
        }
    }
)

Alternatively, you can instantiate connection config classes and use them to build the config:

from relationalai.config import create_config, UsernamePasswordAuth

cfg = create_config(
    connections={
        "sf": UsernamePasswordAuth(
            account="my_account",
            warehouse="my_warehouse",
            user="my_user",
            password="my_password",
        )
    }
)

See the config and connections submodules for more details on the available config and connection types.

Notes

• Set RAI_CONFIG_FILE_PATH to an absolute path to bypass auto-discovery entirely.
• If raiconfig.yaml/raiconfig.yml is not found, create_config falls back to other supported sources (Snowflake and DBT), converting them into the same validated config shape. See the create_config docs for details.

Attributes

Attributes exposed by this module.

EngineSize All supported reasoner size values. Re-exported from relationalai.config.config_reasoners_fields.

ConnectionConfig Top-level connection configuration type. Re-exported from relationalai.config.connections.

SnowflakeConnection Alias for SnowflakeConnectionBase. Re-exported from relationalai.config.connections.snowflake.

Functions

Functions exposed by this module.

create_config() Load configuration programmatically or from the highest-priority available config file source. Re-exported from relationalai.config.config.

Classes

Classes exposed by this module.

Config Represents a validated PyRel configuration. Re-exported from relationalai.config.config.

RAIConfig Load PyRel configuration from raiconfig.yaml / raiconfig.yml. Re-exported from relationalai.config.config.

ConfigFromDBT Load PyRel configuration from DBT's profiles.yml. Re-exported from relationalai.config.config.

ConfigFromSnowflake Load PyRel configuration from Snowflake's config.toml. Re-exported from relationalai.config.config.

DataConfig Configure data loading, streaming, and export behavior. Re-exported from relationalai.config.config_fields.

CompilerConfig Configure compiler behavior for query translation. Re-exported from relationalai.config.config_fields.

ModelConfig Configure model execution defaults. Re-exported from relationalai.config.config_fields.

DebugConfig Configure debug server and error-reporting behavior. Re-exported from relationalai.config.config_fields.

ExecutionConfig Configure execution middleware behavior. Re-exported from relationalai.config.config_fields.

JobsConfig Configure job execution behavior. Re-exported from relationalai.config.config_fields.

OutputsConfig Settings for individual outputs (tables and relations) that your model produces. Re-exported from relationalai.config.config_fields.

ReasonersConfig Configure defaults for the reasoners API. Re-exported from relationalai.config.config_reasoners_fields.

ReasonerConfig Common configuration fields for a reasoner. Re-exported from relationalai.config.config_reasoners_fields.

LogicReasonerConfig Configure rule-execution defaults for the logic reasoner. Re-exported from relationalai.config.config_reasoners_fields.

ReasonerLogicLqpConfig Configure LQP-specific behavior for the logic reasoner. Re-exported from relationalai.config.config_reasoners_fields.

UsernamePasswordAuth Configure Snowflake access using a username and password. Re-exported from relationalai.config.connections.snowflake.

UsernamePasswordMFAAuth Configure Snowflake access using a username/password and an MFA passcode. Re-exported from relationalai.config.connections.snowflake.

ExternalBrowserAuth Configure Snowflake access using browser-based sign-in. Re-exported from relationalai.config.connections.snowflake.

JWTAuth Configure Snowflake access using key-pair (JWT) authentication. Re-exported from relationalai.config.connections.snowflake.

OAuthAuth Configure Snowflake access using an OAuth access token. Re-exported from relationalai.config.connections.snowflake.

OAuthClientCredentialsAuth Configure Snowflake access using the OAuth Client Credentials flow. Re-exported from relationalai.config.connections.snowflake.

ProgrammaticAccessTokenAuth Configure Snowflake access using a Programmatic Access Token. Re-exported from relationalai.config.connections.snowflake.

ConfigError Represents a configuration error. Re-exported from relationalai.config.errors.exceptions.

ConfigFileNotFoundError Raised when no configuration file can be found. Re-exported from relationalai.config.errors.exceptions.

ConfigValidationError Raise when configuration data fails validation. Re-exported from relationalai.config.errors.exceptions.

ConfigFieldMissingError Raised when a required configuration field is missing. Re-exported from relationalai.config.errors.exceptions.

ConfigFieldTypeError Raised when a configuration field has an unexpected type. Re-exported from relationalai.config.errors.exceptions.

ConfigErrorContext Track where a configuration error occurred. Re-exported from relationalai.config.errors.context.

ConfigSourceType Identify where configuration data was loaded from. Re-exported from relationalai.config.errors.context.

Modules and Subpackages

Submodules and subpackages available under this namespace.

config Configuration loading and validation.

config_fields Common configuration sections for Config.

config_reasoners_fields Reasoner configuration sections for Config.

connections Connection configuration classes.

errors Exceptions and context helpers for configuration errors.