sqlmesh.core.config.gateway

 1from __future__ import annotations
 2
 3import typing as t
 4
 5from sqlmesh.core import constants as c
 6from sqlmesh.core.config.base import BaseConfig
 7from sqlmesh.core.config.model import ModelDefaultsConfig
 8from sqlmesh.core.config.common import variables_validator
 9from sqlmesh.core.config.connection import (
10    SerializableConnectionConfig,
11    connection_config_validator,
12)
13from sqlmesh.core.config.scheduler import SchedulerConfig, scheduler_config_validator
14
15
16class GatewayConfig(BaseConfig):
17    """Gateway configuration defines how SQLMesh should connect to the data warehouse,
18    the state backend and the scheduler.
19
20    Args:
21        connection: Connection configuration for the data warehouse.
22        state_connection: Connection configuration for the state backend. If not provided,
23            the same connection as the data warehouse will be used.
24        test_connection: Connection configuration for running unit tests.
25        scheduler: The scheduler configuration.
26        state_schema: Schema name to use for the state tables. If None or empty string are provided
27            then no schema name is used and therefore the default schema defined for the connection will be used
28        variables: A dictionary of gateway-specific variables that can be used in models / macros. This overrides
29            root-level variables by key.
30    """
31
32    connection: t.Optional[SerializableConnectionConfig] = None
33    state_connection: t.Optional[SerializableConnectionConfig] = None
34    test_connection: t.Optional[SerializableConnectionConfig] = None
35    scheduler: t.Optional[SchedulerConfig] = None
36    state_schema: t.Optional[str] = c.SQLMESH
37    variables: t.Dict[str, t.Any] = {}
38    model_defaults: t.Optional[ModelDefaultsConfig] = None
39
40    _connection_config_validator = connection_config_validator
41    _scheduler_config_validator = scheduler_config_validator
42    _variables_validator = variables_validator