Skip to content

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 create_config
cfg = create_config(
data={"wait_for_stream_sync": False, "download_url_type": "external"},
)

Configure data settings using an explicit DataConfig instance:

from relationalai.config import create_config, DataConfig
cfg = create_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.

.poll_timeout_mins

DataConfig.poll_timeout_mins: (int, optional)

Overall client-side timeout in minutes for readiness polling (engine provisioning, use_index, query). None (default) polls indefinitely.

.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

DataConfigpydantic.BaseModel