Edit on GitHub

sqlmesh.core.config.categorizer

 1from __future__ import annotations
 2
 3from enum import Enum
 4
 5from sqlmesh.core.config.base import BaseConfig
 6
 7
 8class AutoCategorizationMode(Enum):
 9    FULL = "full"
10    """Full-auto mode in which the categorizer falls back to the most conservative choice (breaking)."""
11
12    SEMI = "semi"
13    """Semi-auto mode in which a user is promted to provide a category in case when the categorizer
14    failed to determine it automatically.
15    """
16
17    OFF = "off"
18    """Disables automatic categorization."""
19
20
21class CategorizerConfig(BaseConfig):
22    """Configuration for the automatic categorizer of snapshot changes.
23
24    Args:
25        external: the auto categorization mode for External models.
26        python: the auto categorization mode for Python models.
27        sql: the auto categorization mode for SQL models.
28        seed: the auto categorization mode for Seed models.
29    """
30
31    external: AutoCategorizationMode = AutoCategorizationMode.FULL
32    python: AutoCategorizationMode = AutoCategorizationMode.OFF
33    sql: AutoCategorizationMode = AutoCategorizationMode.FULL
34    seed: AutoCategorizationMode = AutoCategorizationMode.FULL
35
36    @classmethod
37    def all_off(cls) -> CategorizerConfig:
38        return cls(
39            external=AutoCategorizationMode.OFF,
40            python=AutoCategorizationMode.OFF,
41            sql=AutoCategorizationMode.OFF,
42            seed=AutoCategorizationMode.OFF,
43        )
44
45    @classmethod
46    def all_semi(cls) -> CategorizerConfig:
47        return cls(
48            external=AutoCategorizationMode.SEMI,
49            python=AutoCategorizationMode.SEMI,
50            sql=AutoCategorizationMode.SEMI,
51            seed=AutoCategorizationMode.SEMI,
52        )
53
54    @classmethod
55    def all_full(cls) -> CategorizerConfig:
56        return cls(
57            external=AutoCategorizationMode.FULL,
58            python=AutoCategorizationMode.FULL,
59            sql=AutoCategorizationMode.FULL,
60            seed=AutoCategorizationMode.FULL,
61        )
class AutoCategorizationMode(enum.Enum):
 9class AutoCategorizationMode(Enum):
10    FULL = "full"
11    """Full-auto mode in which the categorizer falls back to the most conservative choice (breaking)."""
12
13    SEMI = "semi"
14    """Semi-auto mode in which a user is promted to provide a category in case when the categorizer
15    failed to determine it automatically.
16    """
17
18    OFF = "off"
19    """Disables automatic categorization."""

An enumeration.

FULL = <AutoCategorizationMode.FULL: 'full'>

Full-auto mode in which the categorizer falls back to the most conservative choice (breaking).

SEMI = <AutoCategorizationMode.SEMI: 'semi'>

Semi-auto mode in which a user is promted to provide a category in case when the categorizer failed to determine it automatically.

Disables automatic categorization.

Inherited Members
enum.Enum
name
value
class CategorizerConfig(sqlmesh.core.config.base.BaseConfig):
22class CategorizerConfig(BaseConfig):
23    """Configuration for the automatic categorizer of snapshot changes.
24
25    Args:
26        external: the auto categorization mode for External models.
27        python: the auto categorization mode for Python models.
28        sql: the auto categorization mode for SQL models.
29        seed: the auto categorization mode for Seed models.
30    """
31
32    external: AutoCategorizationMode = AutoCategorizationMode.FULL
33    python: AutoCategorizationMode = AutoCategorizationMode.OFF
34    sql: AutoCategorizationMode = AutoCategorizationMode.FULL
35    seed: AutoCategorizationMode = AutoCategorizationMode.FULL
36
37    @classmethod
38    def all_off(cls) -> CategorizerConfig:
39        return cls(
40            external=AutoCategorizationMode.OFF,
41            python=AutoCategorizationMode.OFF,
42            sql=AutoCategorizationMode.OFF,
43            seed=AutoCategorizationMode.OFF,
44        )
45
46    @classmethod
47    def all_semi(cls) -> CategorizerConfig:
48        return cls(
49            external=AutoCategorizationMode.SEMI,
50            python=AutoCategorizationMode.SEMI,
51            sql=AutoCategorizationMode.SEMI,
52            seed=AutoCategorizationMode.SEMI,
53        )
54
55    @classmethod
56    def all_full(cls) -> CategorizerConfig:
57        return cls(
58            external=AutoCategorizationMode.FULL,
59            python=AutoCategorizationMode.FULL,
60            sql=AutoCategorizationMode.FULL,
61            seed=AutoCategorizationMode.FULL,
62        )

Configuration for the automatic categorizer of snapshot changes.

Arguments:
  • external: the auto categorization mode for External models.
  • python: the auto categorization mode for Python models.
  • sql: the auto categorization mode for SQL models.
  • seed: the auto categorization mode for Seed models.
@classmethod
def all_off(cls) -> sqlmesh.core.config.categorizer.CategorizerConfig:
37    @classmethod
38    def all_off(cls) -> CategorizerConfig:
39        return cls(
40            external=AutoCategorizationMode.OFF,
41            python=AutoCategorizationMode.OFF,
42            sql=AutoCategorizationMode.OFF,
43            seed=AutoCategorizationMode.OFF,
44        )
@classmethod
def all_semi(cls) -> sqlmesh.core.config.categorizer.CategorizerConfig:
46    @classmethod
47    def all_semi(cls) -> CategorizerConfig:
48        return cls(
49            external=AutoCategorizationMode.SEMI,
50            python=AutoCategorizationMode.SEMI,
51            sql=AutoCategorizationMode.SEMI,
52            seed=AutoCategorizationMode.SEMI,
53        )
@classmethod
def all_full(cls) -> sqlmesh.core.config.categorizer.CategorizerConfig:
55    @classmethod
56    def all_full(cls) -> CategorizerConfig:
57        return cls(
58            external=AutoCategorizationMode.FULL,
59            python=AutoCategorizationMode.FULL,
60            sql=AutoCategorizationMode.FULL,
61            seed=AutoCategorizationMode.FULL,
62        )
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
sqlmesh.core.config.base.BaseConfig
update_with
model_post_init
sqlmesh.utils.pydantic.PydanticModel
dict
json
copy
parse_obj
parse_raw
missing_required_fields
extra_fields
all_fields
all_field_infos
required_fields