Skip to content

Fix: Warn instead of fail on incompatible incremental strategy for dbt models with a unique key #5166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
izeigerman merged 1 commit into from
Aug 14, 2025
Merged

Fix: Warn instead of fail on incompatible incremental strategy for dbt models with a unique key #5166

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions sqlmesh/dbt/model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -293,10 +293,11 @@ def model_kind(self, context: DbtContext) -> ModelKind:
self.incremental_strategy
and strategy not in INCREMENTAL_BY_UNIQUE_KEY_STRATEGIES
):
raise ConfigError(
f"{self.canonical_name(context)}: SQLMesh incremental by unique key strategy is not compatible with '{strategy}'"
f" incremental strategy. Supported strategies include {collection_to_str(INCREMENTAL_BY_UNIQUE_KEY_STRATEGIES)}."
get_console().log_warning(
f"Unique key is not compatible with '{strategy}' incremental strategy in model '{self.canonical_name(context)}'. "
f"Supported strategies include {collection_to_str(INCREMENTAL_BY_UNIQUE_KEY_STRATEGIES)}. Falling back to 'merge' strategy."
)
strategy = "merge"

if self.incremental_predicates:
dialect = self.dialect(context)
Expand Down
29 changes: 10 additions & 19 deletions tests/dbt/test_transformation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,16 @@ def test_model_kind():
auto_restatement_cron="0 0 * * *",
)

# Test incompatibile incremental strategies
for incremental_strategy in ("delete+insert", "insert_overwrite", "append"):
assert ModelConfig(
materialized=Materialization.INCREMENTAL,
unique_key=["bar"],
incremental_strategy=incremental_strategy,
).model_kind(context) == IncrementalByUniqueKeyKind(
unique_key=["bar"], dialect="duckdb", forward_only=True, disable_restatement=False
)

assert ModelConfig(
materialized=Materialization.INCREMENTAL, time_column="foo", incremental_strategy="merge"
).model_kind(context) == IncrementalByTimeRangeKind(
Expand Down Expand Up @@ -372,25 +382,6 @@ def test_model_kind():
== ManagedKind()
)

with pytest.raises(ConfigError):
ModelConfig(
materialized=Materialization.INCREMENTAL,
unique_key=["bar"],
incremental_strategy="delete+insert",
).model_kind(context)
with pytest.raises(ConfigError):
ModelConfig(
materialized=Materialization.INCREMENTAL,
unique_key=["bar"],
incremental_strategy="insert_overwrite",
).model_kind(context)
with pytest.raises(ConfigError):
ModelConfig(
materialized=Materialization.INCREMENTAL,
unique_key=["bar"],
incremental_strategy="append",
).model_kind(context)


def test_model_kind_snapshot_bigquery():
context = DbtContext()
Expand Down