sqlmesh.core.config.plan

 1from __future__ import annotations
 2
 3import typing as t
 4
 5from sqlmesh.core.config.base import BaseConfig
 6from sqlmesh.core.config.categorizer import CategorizerConfig
 7
 8
 9class PlanConfig(BaseConfig):
10    """Configuration for a plan.
11
12    Args:
13        forward_only: Whether the plan should be forward-only.
14        auto_categorize_changes: Whether SQLMesh should attempt to automatically categorize model changes (breaking / non-breaking)
15            during plan creation.
16        include_unmodified: Whether to include unmodified models in the target development environment.
17        enable_preview: Whether to enable preview for forward-only models in development environments.
18        no_diff: Hide text differences for changed models.
19        no_prompts: Whether to disable interactive prompts for the backfill time range.
20        auto_apply: Whether to automatically apply the new plan after creation.
21        use_finalized_state: Whether to compare against the latest finalized environment state, or to use
22            whatever state the target environment is currently in.
23        always_recreate_environment: Whether to always recreate the target environment from the `create_from` environment.
24    """
25
26    forward_only: bool = False
27    auto_categorize_changes: CategorizerConfig = CategorizerConfig()
28    include_unmodified: bool = False
29    enable_preview: t.Optional[bool] = None
30    no_diff: bool = False
31    no_prompts: bool = True
32    auto_apply: bool = False
33    use_finalized_state: bool = False
34    always_recreate_environment: bool = False