ModelConfig

relationalai.config.config_fields

Configure model execution defaults.

This controls a few cross-cutting behaviors for running a Model, including whether missing properties may be created implicitly and (for SQL execution) the schema used to install model-generated views and tables.

Examples

Minimal YAML (in raiconfig.yaml):

default_connection: sf
connections:
    sf:
        type: snowflake
        # ...
model:
    schema: analytics
    implicit_properties: false

Configure model settings using a dict:

>>> from relationalai.config import create_config
>>> cfg = create_config(
...     model={"schema": "analytics", "implicit_properties": False},
... )

Configure model settings using an explicit ModelConfig instance:

>>> from relationalai.config import create_config, ModelConfig
>>> cfg = create_config(
...     model=ModelConfig(schema_="analytics", implicit_properties=False),
... )

Attributes

.keep

ModelConfig.keep: bool

Keep the model after execution.

.isolated

ModelConfig.isolated: bool

Run the model in isolated mode.

.nowait_durable

ModelConfig.nowait_durable: bool

Do not wait for durable operations.

.schema_

ModelConfig.schema_: (str, optional)

Install schema for model-generated SQL views and tables (config key is schema).

.implicit_properties

ModelConfig.implicit_properties: bool

Allow undeclared properties to be created on first access (when True).

Inheritance Hierarchy

Referenced By

RelationalAI Documentation
├──  Build With RelationalAI
│   └──  Understand how PyRel works > Build a semantic model
│       └──  Define base facts
└──  Release Notes
    └──  Python API Release Notes
        └──  What’s New in Version 1.0.5
            └──  Bug Fixes