Skip to content

Commit b861406

Browse files
doc: update generated developer documentation (#36318)
## Summary Automated daily refresh of `doc/developer/generated/` to reflect source code changes. This PR was generated by the `update-generated-docs` workflow running `.claude/commands/update-docs.md`. ## Scope Only files under `doc/developer/generated/` are modified. ## Review checklist - [ ] No unrelated rewording or restructuring of existing text - [ ] No changelog language ("now", "added", "previously", etc.) - [ ] Changes correspond to actual source code changes 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent ce10ad4 commit b861406

95 files changed

Lines changed: 165 additions & 129 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

doc/developer/generated/adapter/_crate.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
source: src/adapter/src/lib.rs
3-
revision: aa7a1afd31
3+
revision: 9d0a7c3c6f
44
---
55

66
# adapter

doc/developer/generated/adapter/catalog/_module.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
source: src/adapter/src/catalog.rs
3-
revision: a632912d24
3+
revision: 9d0a7c3c6f
44
---
55

66
# adapter::catalog
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
source: src/adapter/src/catalog/apply.rs
3-
revision: a632912d24
3+
revision: 9d0a7c3c6f
44
---
55

66
# adapter::catalog::apply
@@ -10,5 +10,5 @@ Implements the logic for applying `StateUpdate` diffs from the durable catalog s
1010
An `InProgressRetractions` struct caches denormalized state stripped during retractions so that the corresponding additions can reuse it without rebuilding from scratch.
1111
The `ApplyState` state machine batches consecutive updates of the same type when beneficial, then delegates to `apply_updates_inner`, which calls per-type `apply_*_update` methods for roles, role auth, databases, schemas, clusters, network policies, items, system configuration, and more.
1212
After processing retractions that are not replaced by a corresponding addition (i.e., truly dropped items), `apply_updates` calls `drop_optimizer_notices` to clean up any optimizer notices associated with the dropped items and emits the corresponding `mz_notices` retractions.
13-
`CatalogState` methods defined in this module (`set_optimized_plan`, `set_physical_plan`, `set_dataflow_metainfo`, `drop_optimizer_notices`) mutate the plan and notice fields stored directly on `Index`, `MaterializedView`, and `ContinualTask` catalog items.
13+
`CatalogState` methods defined in this module (`set_optimized_plan`, `set_physical_plan`, `set_dataflow_metainfo`, `drop_optimizer_notices`) mutate the plan and notice fields stored directly on `Index` and `MaterializedView` catalog items.
1414
This is the central reconciliation path used both during initial catalog open and when reacting to concurrent remote catalog mutations.

doc/developer/generated/adapter/catalog/builtin_table_updates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
source: src/adapter/src/catalog/builtin_table_updates.rs
3-
revision: d45bbaa9b4
3+
revision: 9d0a7c3c6f
44
---
55

66
# adapter::catalog::builtin_table_updates

doc/developer/generated/adapter/catalog/consistency.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
source: src/adapter/src/catalog/consistency.rs
3-
revision: d37c5be00a
3+
revision: 9d0a7c3c6f
44
---
55

66
# adapter::catalog::consistency

doc/developer/generated/adapter/catalog/open.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
source: src/adapter/src/catalog/open.rs
3-
revision: a632912d24
3+
revision: 9d0a7c3c6f
44
---
55

66
# adapter::catalog::open

doc/developer/generated/adapter/catalog/open/_module.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
source: src/adapter/src/catalog/open.rs
3-
revision: a632912d24
3+
revision: 9d0a7c3c6f
44
---
55

66
# adapter::catalog::open
Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
---
22
source: src/adapter/src/catalog/open/builtin_schema_migration.rs
3-
revision: d45bbaa9b4
3+
revision: 6aacf14c48
44
---
55

66
# adapter::catalog::open::builtin_schema_migration
77

88
Implements schema migration for builtin storage collections whose persist shard schemas change between versions.
99
Two migration mechanisms are provided: `Mechanism::Evolution` uses persist's schema evolution to evolve a shard in-place (backward-compatible changes only), and `Mechanism::Replacement` creates a new shard (works for all changes but discards data).
1010
The `MIGRATIONS` list declares per-version migration steps; `Migration::run` applies outstanding steps, coordinating shard creation, schema registration, fingerprint updates, and cleanup across 0dt-compatible read-only and leader environments.
11-
`CatalogItemType::MaterializedView` is supported alongside `Table`, `Source`, and `ContinualTask` as a valid target for schema migrations, as reflected by entries in the `MIGRATIONS` list that migrate several `mz_catalog` and `mz_internal` materialized views including `mz_databases`, `mz_schemas`, `mz_role_members`, `mz_network_policies`, `mz_network_policy_rules`, `mz_cluster_workload_classes`, `mz_internal_cluster_replicas`, `mz_pending_cluster_replicas`, `mz_materialized_views`, `mz_connections`, and `mz_secrets`.
11+
`CatalogItemType::MaterializedView` is supported alongside `Table` and `Source` as a valid target for schema migrations, as reflected by entries in the `MIGRATIONS` list that migrate several `mz_catalog` and `mz_internal` materialized views including `mz_databases`, `mz_schemas`, `mz_role_members`, `mz_network_policies`, `mz_network_policy_rules`, `mz_cluster_workload_classes`, `mz_internal_cluster_replicas`, `mz_pending_cluster_replicas`, `mz_materialized_views`, `mz_connections`, and `mz_secrets`.
12+
When applying replacement migrations, `mz_storage_usage_by_shard` is excluded from data-destroying replacement plans to preserve billing data.
13+
When the source and target versions differ and the source version is a dev build, `Migration::run` forces evolution-mode migration even without an explicit `force_migration` config, avoiding version-based filter failures in dev environments.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
source: src/adapter/src/catalog/state.rs
3-
revision: 278f65f05f
3+
revision: 9d0a7c3c6f
44
---
55

66
# adapter::catalog::state
77

88
Defines `CatalogState`, the in-memory representation of the entire Materialize catalog.
99
`CatalogState` holds `imbl::OrdMap` collections for databases, schemas, roles, role auth (`role_auth_by_id`), clusters, network policies, the item namespace (keyed by both `CatalogItemId` and `GlobalId`), source references, temporary schemas per connection, comments, default privileges, system privileges, system configuration, and a `notices_by_dep_id` index mapping each `GlobalId` to the optimizer notices that depend on it; it also implements `SessionCatalog` for SQL name resolution.
1010
The file also defines `LocalExpressionCache`, a helper used during catalog open and catalog transactions to track which optimizer expressions were found in (or are missing from) the persistent expression cache, avoiding redundant re-optimization.
11-
When `deserialize_item` re-parses an existing item (e.g. during a RENAME), it preserves the `optimized_plan`, `physical_plan`, and `dataflow_metainfo` fields from the previous `CatalogItem` incarnation via `plan_fields_mut`; these fields are not reconstructable from `create_sql` alone and must be carried over to avoid silently dropping plans for materialized views, indexes, and continual tasks.
11+
When `deserialize_item` re-parses an existing item (e.g. during a RENAME), it preserves the `optimized_plan`, `physical_plan`, and `dataflow_metainfo` fields from the previous `CatalogItem` incarnation via `plan_fields_mut`; these fields are not reconstructable from `create_sql` alone and must be carried over to avoid silently dropping plans for materialized views and indexes.
1212
This is the authoritative read-side view of the catalog; mutations go through `catalog::transact` and are applied by `catalog::apply`.

doc/developer/generated/adapter/catalog/timeline.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
source: src/adapter/src/catalog/timeline.rs
3-
revision: a632912d24
3+
revision: 9d0a7c3c6f
44
---
55

66
# adapter::catalog::timeline

0 commit comments

Comments
 (0)