sqlmesh.core.config.model

 1from __future__ import annotations
 2
 3import typing as t
 4
 5from sqlglot import exp
 6from sqlmesh.core.dialect import parse_one, extract_func_call
 7from sqlmesh.core.config.base import BaseConfig
 8from sqlmesh.core.model.kind import (
 9    ModelKind,
10    OnDestructiveChange,
11    model_kind_validator,
12    on_destructive_change_validator,
13    on_additive_change_validator,
14    OnAdditiveChange,
15)
16from sqlmesh.core.model.meta import FunctionCall
17from sqlmesh.core.node import IntervalUnit, cron_tz_validator
18from sqlmesh.utils.date import TimeLike
19from sqlmesh.utils.pydantic import field_validator
20
21
22class ModelDefaultsConfig(BaseConfig):
23    """A config object for default values applied to model definitions.
24
25    Args:
26        kind: The model kind.
27        dialect: The SQL dialect that the model's query is written in.
28        cron: A cron string specifying how often the model should be refreshed, leveraging the
29            [croniter](https://github.com/kiorky/croniter) library.
30        cron_tz: The timezone for the cron expression, defaults to UTC. [IANA time zones](https://docs.python.org/3/library/zoneinfo.html).
31        owner: The owner of the model.
32        start: The earliest date that the model will be backfilled for. If this is None,
33            then the date is inferred by taking the most recent start date of its ancestors.
34            The start date can be a static datetime or a relative datetime like "1 year ago"
35        table_format: The table format used to manage the physical table files defined by `storage_format`, only applicable in certain engines.
36            (eg, 'iceberg', 'delta', 'hudi')
37        storage_format: The storage format used to store the physical table, only applicable in certain engines.
38            (eg. 'parquet', 'orc')
39        on_destructive_change: What should happen when a forward-only model requires a destructive schema change.
40        on_additive_change: What should happen when a forward-only model requires an additive schema change.
41        physical_properties: A key-value mapping of arbitrary properties that are applied to the model table / view in the physical layer.
42        virtual_properties: A key-value mapping of arbitrary properties that are applied to the model view in the virtual layer.
43        session_properties: A key-value mapping of properties specific to the target engine that are applied to the engine session.
44        audits: The audits to be applied globally to all models in the project.
45        optimize_query: Whether the SQL models should be optimized.
46        allow_partials: Whether the models can process partial (incomplete) data intervals.
47        enabled: Whether the models are enabled.
48        interval_unit: The temporal granularity of the models data intervals. By default computed from cron.
49        batch_concurrency: The maximum number of batches that can run concurrently for an incremental model.
50        pre_statements: The list of SQL statements that get executed before a model runs.
51        post_statements: The list of SQL statements that get executed before a model runs.
52        on_virtual_update: The list of SQL statements to be executed after the virtual update.
53
54    """
55
56    kind: t.Optional[ModelKind] = None
57    dialect: t.Optional[str] = None
58    cron: t.Optional[str] = None
59    cron_tz: t.Any = None
60    owner: t.Optional[str] = None
61    start: t.Optional[TimeLike] = None
62    table_format: t.Optional[str] = None
63    storage_format: t.Optional[str] = None
64    on_destructive_change: t.Optional[OnDestructiveChange] = None
65    on_additive_change: t.Optional[OnAdditiveChange] = None
66    physical_properties: t.Optional[t.Dict[str, t.Any]] = None
67    virtual_properties: t.Optional[t.Dict[str, t.Any]] = None
68    session_properties: t.Optional[t.Dict[str, t.Any]] = None
69    audits: t.Optional[t.List[FunctionCall]] = None
70    optimize_query: t.Optional[t.Union[str, bool]] = None
71    allow_partials: t.Optional[t.Union[str, bool]] = None
72    interval_unit: t.Optional[t.Union[str, IntervalUnit]] = None
73    enabled: t.Optional[t.Union[str, bool]] = None
74    formatting: t.Optional[t.Union[str, bool]] = None
75    batch_concurrency: t.Optional[int] = None
76    pre_statements: t.Optional[t.List[t.Union[str, exp.Expr]]] = None
77    post_statements: t.Optional[t.List[t.Union[str, exp.Expr]]] = None
78    on_virtual_update: t.Optional[t.List[t.Union[str, exp.Expr]]] = None
79
80    _model_kind_validator = model_kind_validator
81    _on_destructive_change_validator = on_destructive_change_validator
82    _on_additive_change_validator = on_additive_change_validator
83    _cron_tz_validator = cron_tz_validator
84
85    @field_validator("audits", mode="before")
86    def _audits_validator(cls, v: t.Any) -> t.Any:
87        if isinstance(v, list):
88            return [extract_func_call(parse_one(audit)) for audit in v]
89
90        return v