DataConfig

relationalai.config.config_fields

Configure data loading, streaming, and export behavior.

This controls client-side defaults used by helpers that load data, wait for streams to synchronize, and download exported results.

Examples

Minimal YAML (in raiconfig.yaml):

default_connection: sf
connections:
    sf:
        type: snowflake
        # ...
data:
    wait_for_stream_sync: false
    download_url_type: external

Configure data settings using a dict:

>>> from relationalai.config import Config
>>> cfg = Config(
...     data={"wait_for_stream_sync": False, "download_url_type": "external"},
... )

Configure data settings using an explicit DataConfig instance:

>>> from relationalai.config import Config, DataConfig
>>> cfg = Config(
...     data=DataConfig(wait_for_stream_sync=False, download_url_type="external"),
... )

Attributes

.wait_for_stream_sync

DataConfig.wait_for_stream_sync: bool

Wait for stream synchronization before processing.

.ensure_change_tracking

DataConfig.ensure_change_tracking: bool

Enable change tracking for data modifications.

.data_freshness_mins

DataConfig.data_freshness_mins: (int, optional)

Data freshness timeout in minutes.

.query_timeout_mins

DataConfig.query_timeout_mins: (int, optional)

Query timeout in minutes.

.download_url_type

DataConfig.download_url_type: ({'internal', 'external'}, optional)

Type of download URL used for data exports.

.check_column_types

DataConfig.check_column_types: bool

Check column types during data loading.

Inheritance Hierarchy

Referenced By

RelationalAI Documentation
└──  Build With RelationalAI
    └──  Understand how PyRel works > Configure PyRel
        └──  Configure execution behavior
            ├──  Set the query timeout
            ├──  Enable or disable stream synchronization before query execution
            ├──  Set the data freshness threshold for stream synchronization
            ├──  Enable or disable automatic enablement of change tracking on Snowflake tables
            ├──  Enable or disable column type checking during stream synchronization
            └──  Set the data export URL type (internal vs external)