Files
windmill/docs/ducklake-materialization.md
T
Ruben Fiszel 43044c2e28 feat(pipelines): wm_partition macro for grain-agnostic partition filters (#9950)
* wip: partial work before earlyoom-recovery relaunch

* fix(pipelines): scaffold the strftime {partition} filter idiom (frontend-only)

The DuckDB materialize scaffold and the AI pipeline prompt now teach the
grain-agnostic `WHERE strftime(<ts_col>, '<fmt>') = {partition}` filter instead
of the naive `= TIMESTAMP {partition}` cast. `{partition}` substitutes to the
partition IDENTITY string (`2026-07-05T23`, `2026-W27`, `2026-07`), which is not
a valid DuckDB TIMESTAMP literal for any non-daily grain — so the naive form
raises a `Conversion Error` for hourly/weekly/monthly (only daily parses).

Adds a frontend unit test asserting the hourly scaffold emits the strftime
idiom (`%Y-%m-%dT%H`) for every grain and never scaffolds the naive TIMESTAMP
cast as executable SQL.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* fix(pipelines): scope strftime partition idiom to time grains

Review nit: `dynamic` partitioning's identity is a caller-supplied key, not a
timestamp, so `strftime` doesn't apply. Scope the scaffold + AI prompt claim to
time grains and add a `dynamic` example that filters on the user's own key.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* feat(pipelines): wm_partition macro for grain-agnostic partition filters

The materialize runtime now injects a `wm_partition(ts)` temp macro as the first
setup statement of a time-partitioned script, so filtering the source to the
active slice is one grain-agnostic line — `WHERE wm_partition(<ts_col>) =
{partition}` — instead of a hand-written `strftime` format the author must keep
in lockstep with the resolver, or the `= TIMESTAMP {partition}` cast that only
parses for daily and Conversion-Errors for hourly/weekly/monthly.

The macro's format comes from `PartitionKind::default_time_format` in
windmill-parser, the same source the EE resolver reads to stamp the `{partition}`
identity, so the two can't drift. `dynamic` partitions get no macro (their
identity is a caller-supplied key → `WHERE <key_col> = {partition}`).

Replaces the earlier 9-line strftime comment block in the scaffold with the
single macro line; AI pipeline prompt and design doc updated to match.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* test(pipelines): verify wm_partition strftime parity vs chrono through real DuckDB

Runs the bundled DuckDB engine in-memory and asserts strftime renders every
grain format (daily/hourly/weekly `%G-W%V`/monthly) byte-for-byte identically to
chrono — the engine the resolver uses to stamp the `{partition}` identity —
across ISO-week year boundaries (2027-01-01 → 2026-W53 etc.). Also proves the
injected `wm_partition` macro buckets the whole slice and that the naive
`TIMESTAMP '<weekly|monthly identity>'` cast Conversion-Errors.

Closes the one cross-engine assumption the pure-Rust/frontend tests couldn't
reach (flagged by CI review for weekly ISO-week rendering).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* chore: update ee-repo-ref to 0de2412ff0734b11e12ba378c9bcc373ff9ae800

This commit updates the EE repository reference after PR #649 was merged in windmill-ee-private.

Previous ee-repo-ref: ad6c6685689d7741058e7d2c9ecbe95d982e6268

New ee-repo-ref: 0de2412ff0734b11e12ba378c9bcc373ff9ae800

Automated by sync-ee-ref workflow.

* fix(pipelines): classify CREATE TEMP MACRO as a DuckDB prepare-path setup statement

The FFI prepare/diagnostics pass only EXECUTES statements recognized by
is_setup_statement (ATTACH/USE/INSTALL/…); everything else is merely prepared.
`CREATE [OR REPLACE] TEMP MACRO` wasn't recognized, so on a `-- prepare` run of a
partitioned materialize the injected `wm_partition` macro was never created on
the connection, and the later generated `CREATE TABLE … SELECT … WHERE
wm_partition(...)` failed to bind ("function does not exist"). The same latent
gap affected the workspace-macro splicer, which injects TEMP MACRO blocks too.

Classify CREATE [OR REPLACE] TEMP|TEMPORARY MACRO as setup so it's executed
before dependent blocks and excluded from the PrepareQueryResult count
(persistent CREATE MACRO stays a user statement). Adds a prepare-path test that
fails without the fix.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: windmill-internal-app[bot] <windmill-internal-app[bot]@users.noreply.github.com>
2026-07-06 10:26:53 +02:00

36 KiB
Raw Blame History

DuckLake-native materialization

Design sketch for "managed, versioned, incremental" assets built on the DuckLake substrate. This is a companion to pipelines-vs-dbt.md and extends its Path C (hybrid, partition-first) recommendation. For the extract-load side that feeds these materializations, see §"Ingestion (EL)" at the end of this doc (user-facing guide: windmilldocs core_concepts/63_pipelines → "Ingestion (EL)"). The new contribution here is leveraging DuckLake's snapshot/time-travel layer, which the earlier doc's incremental deep-dive did not use. The annotation grammar is reconciled with that doc — // partitioned + // unique_key + // append stay canonical; nothing here forks a competing vocabulary.

The core reframe

dbt had to build a materialization engine (compile SQL → CREATE TABLE AS / incremental MERGE / SCD2 snapshots) because the warehouse gives it nothing but raw SQL over a mutable table. DuckLake hands us, at the storage layer, the four things that engine exists to provide:

Capability Source
ACID multi-statement transactions DuckLake
A snapshot per commit + time-travel (AT (VERSION => n) / AT (TIMESTAMP => ...)) DuckLake
Physical partitioning + pruning (ALTER TABLE … SET PARTITIONED BY (…)) DuckLake
Schema evolution tracked in the catalog DB DuckLake

Windmill already attaches DuckLake fully — see transform_attach_ducklake (backend/windmill-worker/src/duckdb_executor.rs:661), which rewrites a user's ATTACH 'ducklake://name' AS dl into the real ATTACH 'ducklake:postgres:…' AS dl (DATA_PATH 's3://…', OVERRIDE_DATA_PATH TRUE, AUTOMATIC_MIGRATION TRUE) at duckdb_executor.rs:730. But today every write is a destructive overwrite and all four capabilities above are thrown away — snapshots are never surfaced, partitioning is purely an orchestration concept disconnected from the physical layout.

So the materialization engine we need is a thin layer — a write-strategy wrapper + snapshot capture — not a dbt rebuild. This is exactly the "buy A's 80% without B's dialect-rewriting tax" tradeoff pipelines-vs-dbt.md argued for; DuckLake is what makes the remaining 20% (versioning, reproducible reads, materialization history) nearly free instead of a second project.

Annotation grammar (final)

One self-documenting line; managed-by-default. Strategy options live on the materialize line (they have no meaning without it), while // partitioned stays separate because it is cross-cutting (cascade + scheduling + materialize).

// materialize ducklake://analytics/orders_daily              → managed, replace (default)
// materialize ducklake://analytics/orders_daily key=order_id → managed, merge (SCD type 1)
// materialize ducklake://analytics/orders_daily append       → managed, append
// materialize ducklake://analytics/dim_customer key=id history → managed, SCD type 2 history
// materialize manual ducklake://analytics/orders_daily       → track-only escape hatch
// materialize ducklake://analytics/raw_events on_schema_change=ignore
//                                  → managed, downstream contract warnings muted
  • managed (default) — the script is setup + one trailing SELECT; Windmill generates the write DDL, captures the DuckLake snapshot, and records state. DuckDB-only; validated at deploy (a non-SELECT script is rejected with a clear error pointing to the wmll.ducklake helpers).
  • manual — escape hatch: the script writes its own DDL; Windmill only records state (no snapshot capture, no idempotency guarantee). Rare; explicit.
  • key=<col> → MERGE (upsert-by-key within the slice, SCD type 1 — overwrites history); append → INSERT-only; neither → DELETE-by-partition
    • INSERT (replace). append wins over key if both are given (deploy warning).
    • Source must have unique keys. The merge is delete-by-key + insert-all: it reconciles the incoming rows against the target (rows whose key is in the SELECT are replaced), but it does not deduplicate the source. Two incoming rows sharing a key would therefore both land under that key, silently breaking the "one row per key" contract. The managed write guards against this — the run fails with a clear error when the SELECT returns more than one row for a non-NULL key (NULL keys are exempt, matching the insert-only path). Deduplicate in the SELECT (e.g. QUALIFY row_number() OVER (PARTITION BY <key> ORDER BY <recency-col> DESC) = 1) or use append if duplicates are intended.
  • key=<col> history [track=<c1,c2,…>] [deletes=close] → upgrades the keyed merge to managed SCD type 2 history (the leading keyword scd2 is an alias). The SELECT is the current snapshot (one row per key), and the runtime adds valid_from/valid_to/is_current; a change to any tracked column (track=, default all non-key) closes the prior version and opens a new one, keeping full history. Diff → close-old (UPDATE) → open-new (INSERT) in one transaction; the effective timestamp is the transaction clock (now()), so a run is self-consistent. v1 is non-partitioned only (// partitioned + history is rejected at deploy), and it requires key= (also rejected at deploy). Both misconfigurations fail fast at save with a clear message instead of on the first run. Unlike manual, it is managed, so // data_test and schema capture work.
    • Deletes. By default a key that disappears from the snapshot stays current (soft delete — dbt's hard_deletes=ignore). deletes=close opts into hard-delete-close: the vanished key's current version is closed (valid_to set, is_current=false) with no new version — dbt's hard_deletes=close. If that key later reappears in the snapshot it opens a fresh version, leaving a validity gap between the delete and the reactivation (correct SCD2).
    • Reserved names. valid_from/valid_to/is_current are reserved column names in this mode — a SELECT that already projects one fails at run time — and the <dim>_current suffix is reserved for the companion view (below), so don't separately materialize a table by that name in the same lake (the view is created IF NOT EXISTS inside the write transaction, so such a collision is skipped silently — the _current convenience is simply absent — rather than erroring).
    • Key should be non-null. A NULL natural key is ill-formed for a dimension; the codegen matches keys null-safely so a NULL-key row is materialized rather than silently dropped, but you should enforce it with // data_test not_null <key>.
    • track= takes no spaces. Like every =-option in the annotation grammar (which is whitespace-tokenized), the track= value must be a bare comma-separated list with no spaces: track=name,tier, not track=name, tier (a space ends the value and the rest is silently ignored).
    • Schema is frozen at first run (persist-and-mutate, like merge/append): the history table is CREATE TABLE IF NOT EXISTS, so adding/removing a projected column later fails the run — an append-only history can't retroactively reshape closed versions. Changing the SELECT's columns needs a manual rebuild (the replace strategy is the only one that re-derives schema each run).
    • Consumer convenience. Each run (re)creates a <dim>_current view (WHERE is_current) in the same catalog, so the common "latest version" read needs no filter and downstream scripts can // on ducklake://…/<dim>_current. The effective-dated payoff is a native DuckDB ASOF JOIN against the history table: … ASOF JOIN <dim> d ON fact.key = d.<key> AND fact.ts >= d.valid_from returns, for each fact, the dimension version that was current at fact.ts — something neither merge nor DuckLake time-travel can do in one query.
  • // partitioned <kind> — unit of work + state + backfill (separate; cross-cutting). Polyglot / multi-statement writes use the wmll.ducklake helpers instead of // materialize.

There is no wrap keyword — materialize is "manage the write," so it was redundant; the only reason for it was to carve out the weak track-only mode, which is now the explicit manual opt-out.

DuckLake snapshots are orthogonal to all of the above — they apply to every strategy automatically because every write is a DuckLake commit. The user never annotates for versioning; they get it.

Executor codegen

The seam

run_duckdb already splits the script into statement blocks and rewrites custom ATTACH blocks in a single pass before execution (duckdb_executor.rs:114-160):

let query_block_list = parse_sql_blocks(&query, true);
// each block: remove_comments → if ducklake/datatable ATTACH, expand; else passthrough

All blocks run in order on one DuckDB connection. Materialize has two modes:

  1. Managed (default). The user writes setup + one trailing SELECT. Windmill replaces that SELECT with generated statements, wrapped in an explicit DuckLake transaction it controls — never textual BEGIN/COMMIT injected around the user's other statements (fragile across their own ATTACHs and multi-statement SQL). For a partitioned replace the SELECT block expands to:

    -- generated for: // partitioned daily ; target = dl.orders_daily ; partition = '2026-06-19'
    CREATE TABLE IF NOT EXISTS dl.orders_daily AS
      SELECT *, CAST(NULL AS VARCHAR) AS _wm_partition FROM (<user_select>) WHERE false;  -- first-run bootstrap
    ALTER TABLE dl.orders_daily SET PARTITIONED BY (_wm_partition);
    BEGIN TRANSACTION;
    DELETE FROM dl.orders_daily WHERE _wm_partition = '2026-06-19';
    INSERT INTO dl.orders_daily SELECT *, '2026-06-19' AS _wm_partition FROM (<user_select>);
    COMMIT;
    

    The strategy variants are all DELETE+INSERT-shaped — no MERGE INTO, which DuckLake can't reliably run on a fresh partition (it 404s writing the first rows):

    • whole-table replace (no // partitioned) → a single CREATE OR REPLACE TABLE … AS <user_select> (handles schema changes, still snapshots).
    • key=<col> → `DELETE FROM … WHERE [ AND] IN (SELECT FROM ())` then `INSERT` (upsert within the slice).
    • append → the DELETE is dropped (insert-only).
  2. manual. The user writes their own DDL inside their own BEGIN … COMMIT; Windmill injects nothing into the body and only records state (no snapshot capture, no idempotency guarantee).

The _wm_partition column is the physical link the orchestration layer lacks: on first materialize Windmill runs ALTER TABLE … SET PARTITIONED BY (_wm_partition) so DuckLake prunes on read and DELETE-by-partition rewrites only that partition's Parquet files.

{partition} in the user SELECT is the identity string, not a timestamp. The token substitutes to the partition's identity — the same string stored in _wm_partition and used for dedup/backfill/state — as an escaped SQL literal ('2026-07-05T23', '2026-W27', '2026-07', '2026-07-05'). Only the daily identity happens to be a valid DuckDB DATE/TIMESTAMP literal, so a naive WHERE ts = TIMESTAMP {partition} works for daily but raises a Conversion Error for hourly/weekly/monthly. Rather than make every author hand-write a strftime format that must match the resolver's, the executor injects a convenience macro as the first setup statement of a time-partitioned materialize:

CREATE OR REPLACE TEMP MACRO wm_partition(ts) AS strftime(ts, '<fmt>');

so the filter is one grain-agnostic line: WHERE wm_partition(<ts_col>) = {partition}. The <fmt> comes from one sourcePartitionKind::default_time_format in windmill-parser (respecting a custom format= override) — which the EE resolver also reads to stamp the identity, so the macro and {partition} can never drift (hourly %Y-%m-%dT%H, weekly %G-W%V, monthly %Y-%m, daily %Y-%m-%d). By construction strftime(ts, fmt) equals the identity for any row in the slice, so this both parses and buckets the whole partition (not just the boundary instant a timestamp cast would match). The macro is timezone-agnostic (it formats ts as given, matching the raw-strftime idiom it replaces); when a non-UTC tz= is set the author expresses ts in that zone. dynamic partitions get no macro — their identity is a caller-supplied key, so the filter is WHERE <key_col> = {partition} directly. The scaffold and the AI pipeline prompt teach the wm_partition form.

Storage: DuckLake writes go to s3://_default_/ through the windmill S3 proxy (/api/w/{ws}/s3_proxy, gated behind the parquet + private features). The proxy must sign the SigV4 canonical URI with single percent-encoding — the SigV4 default (Double) 401s Hive-partition keys like _wm_partition=2026-06-19 (the = double-encodes to %253D vs the client's %3D).

Run summary capture

After the generated blocks, Windmill appends one read block — it is both the job's result (a useful preview rendered as the materialized table) and the row it records:

SELECT 'ducklake://<name>/<table>' AS materialized,
       '<partition>' AS partition,            -- only when partitioned
       (SELECT count(*) FROM <target> [WHERE _wm_partition = '<partition>']) AS rows,
       (SELECT max(snapshot_id) FROM ducklake_snapshots('<target>')) AS snapshot_id;

The snapshot_id and rows are persisted as materialized_partition metadata. One extra round-trip per materialization, no new infra.

Metadata schema

Extends the materialized_partitions table proposed in pipelines-vs-dbt.md §"First implementation slice" with the DuckLake snapshot id:

materialized_partition (
  workspace_id      TEXT,
  asset_kind        TEXT,        -- 'ducklake'
  asset_path        TEXT,        -- 'analytics/orders_daily'
  partition         TEXT,        -- '2026-06-19'  (NULL for unpartitioned)
  snapshot_id       BIGINT,      -- DuckLake snapshot produced by this materialize
  row_count         BIGINT,
  job_id            UUID,
  materialized_at   TIMESTAMPTZ,
  PRIMARY KEY (workspace_id, asset_kind, asset_path, partition)
)

This one table drives four things at once:

  • Observability — "last materialized: snapshot 42, 1.2M rows, 09:14" per asset node (closes the Dagster-catalog gap from the v1-readiness review).
  • Run-stale / gap detection — which partitions exist, which are missing.
  • Backfill — the missing/failed set is the backfill worklist.
  • Snapshot pinning — see below.

Reproducibility — the beyond-dbt part

Because every materialization records the snapshot it produced, you can read any table as of a past version — a capability dbt has no native answer for (dbt models are always "whatever's in the warehouse now"). DuckLake gives us this for the cost of recording one integer per run, and it covers the three things people actually reach for: debugging ("what did this table look like at the failing run"), rollback (re-materialize a consumer from snapshot N), and ad-hoc experimentation on a historical state.

How it's surfaced (shipped): explicit, discoverable time-travel

The version is exposed as a user-driven surface, not hidden plumbing. A consumer pins a read by writing the DuckLake clause directly:

FROM dl.orders_daily AT (VERSION => 42)

The asset node's History tab is a master-detail view: the snapshot list (id

  • time) on the left selects the version previewed in a read-only grid on the right, which surfaces — and copies — the catalog-qualified FROM lake.<table> AT (VERSION => n) clause. Snapshot ids are captured automatically; the user opts into pinning when they want it, and the clause degrades to "latest" if removed, so the same script still runs standalone. Mechanically this rides on time-travel reads (make_select_query / make_count_query emit the AT clause when a version is threaded through the WM_INTERNAL_DB_* markers) plus a DUCKLAKE_SNAPSHOTS read for the history list — capabilities DuckLake already has, no new write path.

Deferred: automatic snapshot pinning across the cascade

An earlier sketch had the cascade automatically thread each producer's snapshot_id into the trigger blob and inject AT (VERSION => $WM_UPSTREAM_SNAPSHOT) into consumer reads, so a whole run is pinned to upstream state at dispatch time without anyone asking. This is deliberately not built, for three reasons:

  • Not critical. The only thing it adds over the explicit surface above is automatic per-run consistency — protection against an upstream re-materializing in the window between dispatch and a consumer reading. That race only bites high-frequency event-driven cascades (rare today), and the read is always a whole, ACID snapshot regardless — never corruption, just "newer than the triggering version". Debugging and rollback are already covered by the explicit surface.
  • Implicit magic. Auto-injecting an AT clause and stripping it on standalone runs is invisible behaviour to debug when it misfires; the explicit clause is inspectable.
  • Multi-upstream ambiguity + EE coupling. A consumer reading two ducklake upstreams needs a per-ref snapshot map accumulated across the AND-join — and the join-slot logic is EE. A single $WM_UPSTREAM_SNAPSHOT would silently pin every read to one (the firing) producer's snapshot.

If a workload ever shows the consistency race in practice, pinning can be layered on top — the capture and the snapshot surfacing built here are its foundation.

What is built is the forensic slice of that sketch: when the cascade dispatches a consumer, it records the latest captured snapshot of each of the consumer's direct upstream assets into the job's trigger arg (upstream_snapshots, rendered read-only on the run detail page with a copyable AT (VERSION => n) clause). "What did the failing run actually see" stays answerable after the fact, with zero read-path changes — reads are not pinned to the recorded versions.

This is distinct from SCD2 history (// materialize … key=… history), which is built: DuckLake time-travel answers "what did the whole table look like at snapshot N?" but not "give me each entity's version history as queryable rows" (valid_from/valid_to/is_current) — the shape dbt's {% snapshot %} produces and downstream dimensional queries join against. The scd2 strategy generates and manages that history table (see the strategy bullet above).

Data tests (// data_test) — and the extensible-annotation pattern

Data tests are the first dbt-parity gap closed on top of materialization, and the first deliberately extensible annotation. The design goal was not just "add five test types" but to establish the convention a sibling family (column-lineage is the next one) follows, so the annotation vocabulary stops being a closed hardcoded list (pipelines-vs-dbt.md gap #7).

Grammar

// data_test unique <col>
// data_test not_null <col>
// data_test accepted_values <col> = a,b,c
// data_test relationships <col> -> datatable://other/asset.<col>
// data_test <script_path>            ← escape hatch (dbt's singular test)

// data_test lines accumulate (every well-formed line adds one check), unlike the single-value annotations (// materialize, // partitioned, …) which are first-write-wins. Malformed lines are dropped fail-safe — a typo becomes an absent check (visible in the graph), never a mis-parsed one.

The keyword is data_test, not test — there is an unrelated, shipped // test: CI-test annotation (windmill_common::schema::parse_ci_test_annotation, tests a script's logic on deploy). data_test tests the data in the materialized asset at run time. This mirrors dbt 1.8's own tests:data_tests: rename, made for exactly this disambiguation.

The pattern: annotation → verifier

The reusable shape, in three layers, each a clean extension seam:

  1. Parse (asset_parser.rs + parsePipelineAnnotations.ts, kept in lockstep by the parity corpus). A data_test line is dispatched on a keyword head to a typed variant (DataTest). A new built-in is one match arm + its sub-parser; the Custom arm is the open fallback. A sibling family reuses this head-keyword dispatch rather than adding a parallel list.
  2. Compile (sql_materialize.rs::build_data_test_checks). Each test becomes a check: (name, probe), where the probe is a one-row query counting and sampling the test's violating rows in a single scan. Built-ins differ only in their violating-rows query; Custom supplies its own (the user's SELECT of violating rows). Referenced assets (relationships) emit an ATTACH resolved by the same transform pass as the user's own.
  3. Execute (duckdb_executor.rs). The materialize summary query embeds every check's outcome in one data_tests list-of-struct column (probes are lifted into one-row CTEs and cross-joined, since DuckDB rejects subqueries inside struct literals), so all tests run in a single pass against the freshly-materialized slice — no abort-on-first. The worker reads the breakdown from the result and decides pass/fail: any violation fails the run (record Failed, propagate up the cascade) with an error listing every test (✓/✗ + counts); a clean run returns the per-test summary so the UI can render a checklist.

Violating-row samples

Each check's probe also captures a bounded sample of its violating rows (≤20 rows, ≤50KB serialized per test — over-cap samples are dropped, never truncated, since truncated JSON fails parsing after paying the bytes). The sample is optional by contract at every layer: enforcement reads only the count; NULL / dropped / unparseable samples degrade to "no sample" and can never flip pass/fail. Where they surface:

  • Failed run: the worker returns a structured error payload (Error::ExecutionRawError), so the failed job's result carries error.data_tests: [{test, violating, sample?}] with samples on failed tests only. The error message stays counts-only, plus a pointer at the payload — so run descriptions and materialized_partition.error carry no row data. The full payload is the job result, and follows every failed job's result wherever that already goes: the worker's failed-job log line (add_completed_job_error) and, on EE, the args of configured global/workspace error handlers — the same pre-existing paths that carry e.g. a failed process's own result.json. A handler that formats only error.message (the common alert shape) stays counts-only; one that wants the offending rows can read error.data_tests. The duckdb executor's password-sanitize catch-all must special-case ExecutionRawError — flattening it to a string would silently strip the payload.
  • UI: DataTestsResult.svelte renders a per-failed-test expandable AutoDataTable; DisplayResult.svelte prefers the structured payload and falls back to text-parsing the breakdown for results predating it.
  • Enterprise (write-audit-publish): samples only exist on the commit-then-test path. Under the EE in-transaction guard a violation aborts pre-commit and the slice rolls back, so the violating rows cease to exist — WAP failures are counts-only by construction (the guard's in-SQL ✓/✗ message), and the guard projects only the probe's count column (pipeline_advanced_ee.rs::data_test_guard_sql).

Sample mechanics worth knowing:

  • The sample rides as a JSON string (to_json(...)::VARCHAR) through the summary row, deliberately: expanded rows would be visible to the executor's key-recursive extract_i64(result, "rows"/"snapshot_id") scans, which a user column of the same name could corrupt. It is parsed only inside extract_data_tests.
  • No ORDER BY on the violating rows — which rows land in the sample is nondeterministic (labelled "sample" in the UI for that reason).
  • unique samples {value, count} pairs at its count's grain (number of duplicated values), so count and sample can't contradict each other.
  • On partitioned targets the synthetic _wm_partition column is EXCLUDEd from samples (same rule as schema capture).
  • A custom body joining with SELECT * can yield duplicate column names — duplicate JSON keys keep the last value; harmless but visible.
  • The probe shape is gated by in-memory tests against the bundled engine in windmill-duckdb-ffi-internal (json extension availability, zero-row NULL degrade, exotic types) — a sample-expr runtime error would fail the summary read after the write committed, so keep those green when touching the shape.

A new annotation family that produces post-materialize checks (or, for column-lineage, post-materialize metadata reads) plugs into the same three seams: add a parsed variant, emit its check/reader SQL into the summary, read it back in the worker. Nothing about the closed set of today's keywords is load-bearing.

Cascade ordering (test_edges)

A relationships test — and, best-effort, a custom test whose body reads a pipeline asset — needs the referenced asset to exist at test time, but it is not a data-consumption // on/read of that asset, so it contributes no lineage edge. Without an ordering constraint, a cold cascade can run the tested script before the referenced dimension is materialized and hard-fail (Catalog Error: Table … does not exist).

asset_graph (windmill-api-assets/src/lib.rs) closes this by resolving the referenced asset's in-pipeline producer (from the write edges it already builds) and emitting an ordering-only test_edges entry producer → testing_script. It is:

  • Only emitted when a producer exists in the graph. An external table (no in-pipeline producer) adds no edge — the missing dependency is real and the runtime error is the correct signal. Self-edges (a script relationship-testing its own output) are dropped.
  • Rendered distinctly — amber dashed "test needs" link on the canvas, apart from lineage (blue/gray solid) and triggers (gray) — because the tested script does not ingest the asset's rows.
  • Fed into the cascade topo-sort via buildLineageDag (AssetGraph/boundedCascade.ts), routed through the referenced asset node (asset → testing_script) so the existing producer → asset write edge extends into producer → asset → testing_script and the two-hop buildLineageDownstreamMap invariant holds. Bounded and full-pipeline runs (computeInducedSchedule) then order the producer first.

Scope caveat: this orders within a single client-driven cascade (dev run / bounded run / full-pipeline run). It does not change the production reactive asset-dispatch of two independently-scheduled roots — there, relationships targets on a disjoint root should still be co-scheduled or bound with an explicit // on <dim> if a hard ordering is required.

Scoping decisions (v1)

  • Partition scope. When // partitioned, built-in checks are scoped to the slice just written (WHERE _wm_partition = <value>), so a rerun/backfill of one partition is independent of other partitions' (possibly pre-existing) data. Whole-table assertions are a follow-up.
  • SCD2 scope. On a key=… history target, built-in checks assert the current snapshot (WHERE is_current): the history table legitimately repeats the natural key across closed versions, so an unscoped unique(<key>) would fail the run on the second change of any key. Custom tests see the raw history and scope themselves.
  • Commit-then-test (public) / write-audit-publish (enterprise). In the public build, like dbt, the write commits before tests run; a failed test fails the run (and records Failed, so downstream cascade stops) but does not roll back the committed snapshot — time-travel still lets you inspect exactly what failed. Enterprise upgrades this to write-audit-publish: the same checks also run inside the write transaction as a guard statement that raises on any violation, aborting the run before COMMIT — a failing slice is never published, readers keep the previous version, and no snapshot is created (even a first run of a new asset rolls back to "no table"). The whole mechanism lives in the enterprise repo: sql_materialize::build_wrap_blocks produces a typed statement plan (MaterializePlan — statements plus structural kinds and the compiled checks), and pipeline_advanced::finalize_materialize_query assembles it — verbatim on the public build, restructured into the guarded transaction on EE. The public build thus carries only plan metadata, not the write-audit-publish transform itself.
  • Custom = DuckDB SQL, server worker. The escape hatch fetches the deployed script's content (a single DuckDB SELECT/CTE returning the violating rows — it's embedded as a subquery, so a multi-statement body is rejected with a clear error) and inlines it as a check; {partition} is substituted and _wm_target is in scope. Agent (Http) workers — which have no script cache — get a clear error. Non-DuckDB custom tests (dispatched as sub-jobs, any language) are the natural follow-up and fit the same verifier seam.
  • Managed only. // materialize manual + // data_test is rejected with a clear error (we can't know the manual script's target alias / partition col).

Schema contracts (save-time, gap #2b)

The captured schema (#2a) is read back as a contract: at save/deploy time, every consumer's asset references — body-read/written columns, // column lineage sources, // data_test relationships refs — are diffed against the latest materialized_asset_schema version of each referenced ducklake asset, and mismatches surface as warnings (deploy never blocks; dbt's on_schema_change=fail is deliberately absent in v1). The diff lives in windmill_common::schema_contracts (endpoint: POST /w/{ws}/scripts/check_schema_contracts, called by the UI right after a save) and is mirrored 1:1 by the editor (schemaContracts.ts): live Monaco warning squiggles from the WASM buffer parse, plus column-name completion for annotation refs fed by the same captured schemas.

Comparison rules worth knowing: column names are case-insensitive (DuckDB unquoted-identifier semantics); _wm_partition is whitelisted (it's excluded from capture); {partition} tokens are stripped before lookup; a <dim>_current reference falls back to the scd2 base table's capture; a relationships join across two captured assets also flags a captured-type difference (the runtime probe coerces, so it's "differs", not "will fail"). An asset with no capture (never materialized, manual mode, any datatable://) produces no warnings.

The producer opts a deliberately unstable schema out with // materialize … on_schema_change=ignore — consumers then get a single informational "suppressed" note instead of per-column warnings. On manual materialize the option is inert (nothing is captured) and deploy logs a warning saying so.

Scoping decision: DuckLake vs DataTable

Make DuckLake the materialization/versioning substrate; keep DataTable as the live operational table with no versioning. DataTable is plain Postgres (transform_attach_datatable, duckdb_executor.rs:742) — no native snapshots or time-travel — so giving it the versioned/incremental story means building MVCC-on-top ourselves (history tables, SCD2), precisely the complexity this DuckLake approach exists to avoid. Clean split:

  • ducklake:// → analytics, versioned, reproducible, backfillable.
  • datatable:// → mutable app/operational state; partition idempotency via DELETE+INSERT still works, but no snapshot/time-travel layer.

Don't try to give both the full treatment for v1.

v1 slice (smallest viable)

  1. Partition runtime context — resolve (value, start, end) and surface as WM_PARTITION* bind/env (Path C step 1; partly built per the pipeline-partition-runtime work).
  2. Physical partition wiring_wm_partition column + SET PARTITIONED BY on first materialize for ducklake:// targets.
  3. Strategy templates — DELETE+INSERT default (CREATE OR REPLACE for the whole table); delete-by-key + insert when key=<col>; INSERT-only when append. Managed // materialize wraps a single-SELECT DuckDB script behind these templates; // materialize manual opts out.
  4. Snapshot + metadata capture — append ducklake_snapshots read, persist materialized_partition rows.
  5. Surface it — last-materialized/snapshot/row-count on the asset node; missing-partition set feeds the backfill UI.
  6. v1.x — time-travel UX over the captured snapshots: a per-asset History tab — a master-detail snapshot list + query-at-version preview that copies the full FROM lake.<table> AT (VERSION => n) clause. Automatic cascade pinning ($WM_UPSTREAM_SNAPSHOT) is deferred — see §"Reproducibility" for why.

Steps 15 are a thin annotation+template layer plus one metadata table and one extra read per run. They deliver managed/incremental/versioned assets, idempotent partitioned materialization, the backfill substrate, and materialization observability together — and stay recognizably Windmill-shaped.

Open decisions

These ride on top of the six in pipelines-vs-dbt.md §"Decisions either path forces"; DuckLake-specific:

  1. Bootstrap of SET PARTITIONED BY. First-materialize detection — table absent vs. present-but-unpartitioned. Idempotent re-apply.
  2. Snapshot retention / compaction. DuckLake snapshots accumulate; when do we expire old ones, and does pinning hold a snapshot alive past retention?
  3. Pin scope. Pin only direct producers, or the full transitive upstream set per run? Storage and "stale pin" semantics differ.
  4. Managed multi-statement. Resolved: managed // materialize accepts setup statements (ATTACH/SET/…) followed by exactly one trailing SELECT, and rejects anything else at deploy with a clear error pointing to // materialize manual. The classifier (sql_materialize.rs) is the single source of truth.

Ingestion (EL): the sanctioned entry-node shape

Design constraints for how external data enters the lake — the user-facing how-to (extract-engine choice, cursor recipes, schema-drift handling, worked examples) lives in windmilldocs core_concepts/63_pipelines → "Ingestion (EL)"; this section records only what future feature work must not break.

  • // materialize is DuckDB-only (deploy-rejected elsewhere, managed and manual alike — windmill-api-scripts/src/scripts.rs), and the SDK materialize helpers (upsert_partition / upsertPartition) build their SQL inside the SDK, so the asset parsers cannot see the write. A polyglot node that "writes the lake directly" therefore deploys with no output edge — breaking lineage, cascade scheduling, and the backfill UI's producer lookup.
  • The sanctioned polyglot shape is two scripts: an entry node that lands the raw batch as an object in workspace storage (write_s3_file — a parser-visible write), and a DuckDB loader (-- on s3:///<key> + -- materialize) that the asset dispatcher re-runs per batch. The landing object is the seam; splitting E from L also keeps row work vectorized and gives the load the full engine treatment (strategies, snapshots, partition grid, // data_test).
  • One string spelling: s3:///<key>. SDK string params are strictly s3://… URIs with a non-empty key; anything else raises (clients > 1.746.0 — older clients silently upload such strings to an auto-generated windmill_uploads/… name, so keep URIs in code that must run on them). The same URI is what // on annotations and DuckDB SQL take, and all forms (URI, {s3} object, S3Object(s3=…)) canonicalize to path /<key>. The asset parsers record no asset for a bare-string SDK argument (the call can only error at run time) — keep parse_s3_object (py client), parseS3Object (ts client, s3Types.ts) and both s3_object_arg_path parsers in lockstep when touching any of them.
  • DuckDB workers load no ICU extension: bare TIMESTAMPTZ - INTERVAL arithmetic binder-errors. Incremental-pull SQL casts both sides (updated_at::TIMESTAMP > now()::TIMESTAMP - INTERVAL 7 DAY).