sqlmesh.core.config.plan
1from __future__ import annotations 2 3from sqlmesh.core.config.base import BaseConfig 4from sqlmesh.core.config.categorizer import CategorizerConfig 5 6 7class PlanConfig(BaseConfig): 8 """Configuration for a plan. 9 10 Args: 11 forward_only: Whether the plan should be forward-only. 12 auto_categorize_changes: Whether SQLMesh should attempt to automatically categorize model changes (breaking / non-breaking) 13 during plan creation. 14 include_unmodified: Whether to include unmodified models in the target development environment. 15 enable_preview: Whether to enable preview for forward-only models in development environments. 16 no_diff: Hide text differences for changed models. 17 no_prompts: Whether to disable interactive prompts for the backfill time range. Please note that 18 auto_apply: Whether to automatically apply the new plan after creation. 19 use_finalized_state: Whether to compare against the latest finalized environment state, or to use 20 whatever state the target environment is currently in. 21 """ 22 23 forward_only: bool = False 24 auto_categorize_changes: CategorizerConfig = CategorizerConfig() 25 include_unmodified: bool = False 26 enable_preview: bool = False 27 no_diff: bool = False 28 no_prompts: bool = False 29 auto_apply: bool = False 30 use_finalized_state: bool = False
8class PlanConfig(BaseConfig): 9 """Configuration for a plan. 10 11 Args: 12 forward_only: Whether the plan should be forward-only. 13 auto_categorize_changes: Whether SQLMesh should attempt to automatically categorize model changes (breaking / non-breaking) 14 during plan creation. 15 include_unmodified: Whether to include unmodified models in the target development environment. 16 enable_preview: Whether to enable preview for forward-only models in development environments. 17 no_diff: Hide text differences for changed models. 18 no_prompts: Whether to disable interactive prompts for the backfill time range. Please note that 19 auto_apply: Whether to automatically apply the new plan after creation. 20 use_finalized_state: Whether to compare against the latest finalized environment state, or to use 21 whatever state the target environment is currently in. 22 """ 23 24 forward_only: bool = False 25 auto_categorize_changes: CategorizerConfig = CategorizerConfig() 26 include_unmodified: bool = False 27 enable_preview: bool = False 28 no_diff: bool = False 29 no_prompts: bool = False 30 auto_apply: bool = False 31 use_finalized_state: bool = False
Configuration for a plan.
Arguments:
- forward_only: Whether the plan should be forward-only.
- auto_categorize_changes: Whether SQLMesh should attempt to automatically categorize model changes (breaking / non-breaking) during plan creation.
- include_unmodified: Whether to include unmodified models in the target development environment.
- enable_preview: Whether to enable preview for forward-only models in development environments.
- no_diff: Hide text differences for changed models.
- no_prompts: Whether to disable interactive prompts for the backfill time range. Please note that
- auto_apply: Whether to automatically apply the new plan after creation.
- use_finalized_state: Whether to compare against the latest finalized environment state, or to use whatever state the target environment is currently in.
Inherited Members
- pydantic.main.BaseModel
- BaseModel
- model_extra
- model_fields_set
- model_construct
- model_copy
- model_dump
- model_dump_json
- model_json_schema
- model_parametrized_name
- model_rebuild
- model_validate
- model_validate_json
- model_validate_strings
- parse_file
- from_orm
- construct
- schema
- schema_json
- validate
- update_forward_refs