Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions doc/developer/generated/adapter-types/dyncfgs.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
source: src/adapter-types/src/dyncfgs.rs
revision: b1e123e786
revision: 1505e0c3f0
---

# mz-adapter-types::dyncfgs

Declares all dynamic configuration flags owned by the adapter layer as `mz_dyncfg::Config` constants.
Covers session gating (`ALLOW_USER_SESSIONS`), zero-downtime deployment parameters (`WITH_0DT_*`, `ENABLE_0DT_*`), feature flags for expression caching, multi-replica sources, statement lifecycle logging, introspection subscribes, plan insights optimization thresholds, continual task builtins, password authentication, OIDC settings (`OIDC_ISSUER`, `OIDC_AUDIENCE`, `OIDC_AUTHENTICATION_CLAIM`), console OIDC configuration (`CONSOLE_OIDC_CLIENT_ID`, `CONSOLE_OIDC_SCOPES`), MCP endpoint toggles (`ENABLE_MCP_AGENT`, `ENABLE_MCP_AGENT_QUERY_TOOL`, `ENABLE_MCP_DEVELOPER`), persist fast-path ordering, S3 Tables region checks, and the user ID pool batch size.
Covers session gating (`ALLOW_USER_SESSIONS`), zero-downtime deployment parameters (`WITH_0DT_*`, `ENABLE_0DT_*`), feature flags for expression caching, multi-replica sources, statement lifecycle logging, introspection subscribes, plan insights optimization thresholds, continual task builtins, password authentication, OIDC settings (`OIDC_ISSUER`, `OIDC_AUDIENCE`, `OIDC_AUTHENTICATION_CLAIM`), console OIDC configuration (`CONSOLE_OIDC_CLIENT_ID`, `CONSOLE_OIDC_SCOPES`), MCP endpoint toggles (`ENABLE_MCP_AGENT`, `ENABLE_MCP_AGENT_QUERY_TOOL`, `ENABLE_MCP_DEVELOPER`) and response size limit (`MCP_MAX_RESPONSE_SIZE`), persist fast-path ordering, S3 Tables region checks, and the user ID pool batch size.
`all_dyncfgs` registers every config constant into a `ConfigSet` for use during bootstrap.
2 changes: 1 addition & 1 deletion doc/developer/generated/adapter/catalog/_module.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
source: src/adapter/src/catalog.rs
revision: 0b6718c2a4
revision: bce428d203
---

# adapter::catalog
Expand Down
2 changes: 1 addition & 1 deletion doc/developer/generated/adapter/catalog/apply.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
source: src/adapter/src/catalog/apply.rs
revision: f75acad2d2
revision: ae3360a4c1
---

# adapter::catalog::apply
Expand Down
2 changes: 1 addition & 1 deletion doc/developer/generated/adapter/catalog/open.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
source: src/adapter/src/catalog/open.rs
revision: 210c00eb3d
revision: 00cc513fa5
---

# adapter::catalog::open
Expand Down
2 changes: 1 addition & 1 deletion doc/developer/generated/adapter/catalog/open/_module.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
source: src/adapter/src/catalog/open.rs
revision: 210c00eb3d
revision: 00cc513fa5
---

# adapter::catalog::open
Expand Down
2 changes: 1 addition & 1 deletion doc/developer/generated/adapter/catalog/transact.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
source: src/adapter/src/catalog/transact.rs
revision: 5680493e7d
revision: 00cc513fa5
---

# adapter::catalog::transact
Expand Down
2 changes: 1 addition & 1 deletion doc/developer/generated/adapter/command.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
source: src/adapter/src/command.rs
revision: f7c755e1ed
revision: bce428d203
---

# adapter::command
Expand Down
4 changes: 2 additions & 2 deletions doc/developer/generated/adapter/coord/_module.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
source: src/adapter/src/coord.rs
revision: f7c755e1ed
revision: bce428d203
---

# adapter::coord
Expand All @@ -9,4 +9,4 @@ The core coordinator: `coord.rs` defines the `Coordinator` struct (the central s
The coordinator owns the `Catalog`, active compute sinks, pending peeks, read-policy manager, timeline oracles, and all inter-subsystem handles (controller, storage collections, secrets, orchestrator).
The file also defines `IdPool`, a pre-allocated pool of user `GlobalId` integers that amortizes per-DDL persist writes by reserving batches of IDs at once; the pool is owned by the coordinator and access is serialized through its single-threaded event loop.
Child modules partition the coordinator's responsibilities: `command_handler` handles external `Command` messages; `message_handler` handles internal async `Message` responses; `sequencer` executes SQL plans; `appends` manages table and builtin-table writes; `catalog_implications` derives and applies downstream effects from catalog state changes; `ddl` wraps catalog transactions; `peek` and `read_policy` manage query execution and compaction; `timestamp_selection` and `timeline` handle temporal reasoning; `catalog_serving` serves catalog snapshots; and supporting modules cover cluster scheduling, introspection routing, consistency checking, index management, and statement logging.
Bootstrap handles derived builtin storage collections (builtin MVs and CTs) separately: after registering input-less collections, it bumps their sinces based on transitive dependency frontiers to satisfy as-of selection invariants.
Bootstrap handles derived builtin storage collections (builtin MVs and CTs) separately: after registering input-less collections in dependency order, it bumps their sinces based on transitive dependency frontiers to satisfy as-of selection invariants.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
source: src/adapter/src/coord/catalog_implications.rs
revision: 62f6c5cc15
revision: 00cc513fa5
---

# adapter::coord::catalog_implications
Expand Down
4 changes: 2 additions & 2 deletions doc/developer/generated/adapter/coord/ddl.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
source: src/adapter/src/coord/ddl.rs
revision: 0b6718c2a4
revision: 57ddfadb9c
---

# adapter::coord::ddl

Implements `Coordinator::catalog_transact` and related DDL helpers that combine a `catalog::transact` call with the downstream `apply_catalog_implications` step, publishing telemetry events and propagating errors back to the client.
Also provides `drop_compute_sinks`, `retire_execution`, and other coordinator-level housekeeping triggered by DDL.
Also provides `drop_compute_sinks` and other coordinator-level housekeeping triggered by DDL.
`catalog_transact_with_side_effects` supports DDL operations that need to run async side-effects (e.g. dropping persist shards) after the catalog transaction commits.
The `Op::InjectAuditEvents` variant is recognized as a no-op for downstream implication processing.
2 changes: 1 addition & 1 deletion doc/developer/generated/adapter/coord/in_memory_oracle.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
source: src/adapter/src/coord/in_memory_oracle.rs
revision: 8ed0d4135b
revision: bce428d203
---

# adapter::coord::in_memory_oracle
Expand Down
4 changes: 2 additions & 2 deletions doc/developer/generated/adapter/coord/peek.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
source: src/adapter/src/coord/peek.rs
revision: 5680493e7d
revision: bce428d203
---

# adapter::coord::peek

Defines the data structures and execution logic for coordinator-side peeks (SELECT queries).
`PeekPlan` discriminates between fast-path (`FastPathPlan`) and slow-path (`PeekDataflowPlan`) execution; `FastPathPlan` covers constant results, direct arrangement reads, and persist fast-path reads.
`PeekDataflowPlan` describes a slow-path peek that requires a dataflow; `FastPathPlan` covers constant results, direct arrangement reads, and persist fast-path reads.
`implement_peek_plan` ships the peek to the compute layer or evaluates it immediately, returning a `PeekResponseUnary` stream; `PeekResponseUnary` carries rows, errors, or a cancellation signal back to the client.
6 changes: 3 additions & 3 deletions doc/developer/generated/adapter/coord/read_policy.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
source: src/adapter/src/coord/read_policy.rs
revision: d7c2126b4a
revision: fcc110b5fe
---

# adapter::coord::read_policy

Manages compaction read policies for collections: `ReadHolds` is an RAII handle that reserves a timestamp lower bound for a set of collections, preventing their `since` from advancing past the held timestamp; releasing the handle allows compaction to proceed.
`ReadPolicyManager` tracks all active read holds per collection and computes the effective `since` that must be maintained; it is consulted by the coordinator when advancing compaction frontiers.
Manages compaction read policies for collections: `ReadHolds` is an RAII handle that bundles a set of `ReadHold` tokens (one per storage or compute collection), preventing their `since` from advancing past the held timestamp; dropping the handle relinquishes the read capabilities.
`Coordinator` methods in this module (`initialize_read_policies`, `update_storage_read_policies`, `update_compute_read_policies`, `acquire_read_holds`) install and update read policies on the storage and compute controllers.
2 changes: 1 addition & 1 deletion doc/developer/generated/adapter/coord/sequencer.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
source: src/adapter/src/coord/sequencer.rs
revision: 1d15c92c08
revision: 00cc513fa5
---

# adapter::coord::sequencer
Expand Down
2 changes: 1 addition & 1 deletion doc/developer/generated/adapter/coord/sequencer/_module.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
source: src/adapter/src/coord/sequencer.rs
revision: 1d15c92c08
revision: 00cc513fa5
---

# adapter::coord::sequencer
Expand Down
2 changes: 1 addition & 1 deletion doc/developer/generated/adapter/coord/sequencer/inner.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
source: src/adapter/src/coord/sequencer/inner.rs
revision: 4218b69078
revision: bce428d203
---

# adapter::coord::sequencer::inner
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
source: src/adapter/src/coord/sequencer/inner.rs
revision: 4218b69078
revision: bce428d203
---

# adapter::coord::sequencer::inner
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
source: src/adapter/src/coord/sequencer/inner/create_materialized_view.rs
revision: 5b9fb22e87
revision: fcc110b5fe
---

# adapter::coord::sequencer::inner::create_materialized_view
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
source: src/adapter/src/coord/sequencer/inner/explain_timestamp.rs
revision: e816eeb545
revision: bce428d203
---

# adapter::coord::sequencer::inner::explain_timestamp
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
source: src/adapter/src/coord/sequencer/inner/peek.rs
revision: 4267863081
revision: bce428d203
---

# adapter::coord::sequencer::inner::peek
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
source: src/adapter/src/coord/sequencer/inner/subscribe.rs
revision: 2982634c0d
revision: fcc110b5fe
---

# adapter::coord::sequencer::inner::subscribe
Expand Down
6 changes: 3 additions & 3 deletions doc/developer/generated/adapter/coord/sql.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
source: src/adapter/src/coord/sql.rs
revision: 7340287c14
revision: bce428d203
---

# adapter::coord::sql

Implements the coordinator's SQL-layer entry points: `parse`, `plan`, and the `prepare`/`execute` steps of the extended query protocol.
`plan` resolves names against the catalog, invokes the SQL planner, and returns a `Plan`; `prepare` additionally describes the statement's parameter and result types for the pgwire Describe flow.
Implements coordinator utility methods for the SQL layer: `plan_statement` resolves names against the catalog and invokes the SQL planner; `declare` and `describe` support cursor declaration and the pgwire Describe flow; `verify_prepared_statement` and `verify_portal` re-check prepared statement and portal validity after catalog changes.
Also contains `clear_transaction`, `clear_connection`, `add_active_compute_sink`, and `remove_active_compute_sink` for per-connection and per-sink bookkeeping.
6 changes: 3 additions & 3 deletions doc/developer/generated/adapter/coord/timeline.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
source: src/adapter/src/coord/timeline.rs
revision: 4a1aeff959
revision: fcc110b5fe
---

# adapter::coord::timeline

Manages per-timeline timestamp oracles and the coordinator's timeline bookkeeping.
`TimelineState` holds the `TimestampOracle` for each timeline and the oracle's current read/write timestamps; `timedomain_for` computes the union of timelines that a query's input collections belong to; the coordinator creates and caches oracle instances here.
`TimelineContext` (re-exported from the catalog) describes whether a collection is timeline-dependent or timestamp-independent.
`TimelineState` holds the `TimestampOracle<Timestamp>` for each timeline and a set of `ReadHolds` that keep those read timestamps valid; the coordinator creates and caches oracle instances here.
`TimelineContext` describes whether a collection is timeline-dependent (`TimelineDependent`), timestamp-dependent (`TimestampDependent`), or timestamp-independent (`TimestampIndependent`).
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
source: src/adapter/src/coord/timestamp_selection.rs
revision: b0ce85a355
revision: bce428d203
---

# adapter::coord::timestamp_selection
Expand Down
2 changes: 1 addition & 1 deletion doc/developer/generated/adapter/coord/validity.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
source: src/adapter/src/coord/validity.rs
revision: aa7a1afd31
revision: bce428d203
---

# adapter::coord::validity
Expand Down
2 changes: 1 addition & 1 deletion doc/developer/generated/adapter/error.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
source: src/adapter/src/error.rs
revision: 892cf626bc
revision: 00cc513fa5
---

# adapter::error
Expand Down
2 changes: 1 addition & 1 deletion doc/developer/generated/adapter/explain/insights.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
source: src/adapter/src/explain/insights.rs
revision: 2a6ac3ab4c
revision: bce428d203
---

# adapter::explain::insights
Expand Down
2 changes: 1 addition & 1 deletion doc/developer/generated/adapter/frontend_peek.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
source: src/adapter/src/frontend_peek.rs
revision: 2982634c0d
revision: bce428d203
---

# adapter::frontend_peek
Expand Down
2 changes: 1 addition & 1 deletion doc/developer/generated/adapter/notice.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
source: src/adapter/src/notice.rs
revision: 4267863081
revision: bce428d203
---

# adapter::notice
Expand Down
2 changes: 1 addition & 1 deletion doc/developer/generated/adapter/optimize/copy_to.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
source: src/adapter/src/optimize/copy_to.rs
revision: c0e930f9df
revision: bce428d203
---

# adapter::optimize::copy_to
Expand Down
2 changes: 1 addition & 1 deletion doc/developer/generated/adapter/optimize/peek.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
source: src/adapter/src/optimize/peek.rs
revision: c0e930f9df
revision: bce428d203
---

# adapter::optimize::peek
Expand Down
2 changes: 1 addition & 1 deletion doc/developer/generated/adapter/peek_client.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
source: src/adapter/src/peek_client.rs
revision: 5680493e7d
revision: fcc110b5fe
---

# adapter::peek_client
Expand Down
6 changes: 3 additions & 3 deletions doc/developer/generated/adapter/session.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
source: src/adapter/src/session.rs
revision: aa7a1afd31
revision: bce428d203
---

# adapter::session

Defines `Session<T>`, the per-connection state object held by the coordinator for the duration of a client connection.
Defines `Session`, the per-connection state object held by the coordinator for the duration of a client connection.
A `Session` tracks the connection ID and UUID, the current transaction state (`TransactionStatus`), open cursors, prepared statements with their logging metadata, portal bindings, session variables, role metadata, and lifecycle timestamps used for statement logging.
`SessionConfig` includes an `authenticator_kind: AuthenticatorKind` field that records which authenticator was used for the connection.
`Transaction` holds the current transaction's operations (`TransactionOps`), timestamp context, and read holds; `TransactionStatus` is the state machine covering `Default`, `Started`, `InTransaction`, `InTransactionImplicit`, and `Failed` states.
`Transaction` holds the current transaction's operations (`TransactionOps`), a plan context, and optional write-lock guards; `TransactionStatus` is the state machine covering `Default`, `Started`, `InTransaction`, `InTransactionImplicit`, and `Failed` states.
The module also defines `RowBatchStream` (the channel type for streaming subscribe results to pgwire) and `PreparedStatement` (a parsed, described statement with optional logging info).
2 changes: 1 addition & 1 deletion doc/developer/generated/adapter/util.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
source: src/adapter/src/util.rs
revision: 5680493e7d
revision: 00cc513fa5
---

# adapter::util
Expand Down
2 changes: 1 addition & 1 deletion doc/developer/generated/adapter/webhook.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
source: src/adapter/src/webhook.rs
revision: 5f6e25ff20
revision: 00cc513fa5
---

# adapter::webhook
Expand Down
2 changes: 1 addition & 1 deletion doc/developer/generated/catalog-debug/_crate.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
source: src/catalog-debug/src/main.rs
revision: 7ee7a08339
revision: 00cc513fa5
---

# mz-catalog-debug
Expand Down
2 changes: 1 addition & 1 deletion doc/developer/generated/catalog/builtin/_module.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
source: src/catalog/src/builtin.rs
revision: bf2293aa49
revision: ae3360a4c1
---

# catalog::builtin
Expand Down
6 changes: 3 additions & 3 deletions doc/developer/generated/catalog/durable/error.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
source: src/catalog/src/durable/error.rs
revision: 8be2c88c0f
revision: 00cc513fa5
---

# catalog::durable::error

Defines the error hierarchy for durable catalog operations.
`CatalogError` wraps either a `SqlCatalogError` (logical catalog errors) or a `DurableCatalogError` (storage-level errors).
`DurableCatalogError` covers fencing (`FenceError`), incompatible data versions, persist upper mismatches, uninitialized catalog, and general internal errors.
`FenceError` distinguishes being fenced by a higher epoch from being fenced by a newer deploy generation.
`DurableCatalogError` covers fencing (`FenceError`), incompatible data versions (`IncompatibleDataVersion`, `IncompatiblePersistVersion`), uninitialized catalog, not-writable catalog, protobuf deserialization errors, duplicate key, uniqueness violations, storage errors, and internal errors. The method `can_recover_with_write_mode` reports whether the error can be recovered by reopening the catalog in writable mode.
`FenceError` has three variants: `DeployGeneration` (fenced by a newer deployment generation), `Epoch` (fenced by a newer epoch), and `MigrationUpper` (fenced during 0dt builtin table migration). The enum is ordered from most to least informative.
2 changes: 1 addition & 1 deletion doc/developer/generated/catalog/durable/transaction.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
source: src/catalog/src/durable/transaction.rs
revision: 210c00eb3d
revision: 00cc513fa5
---

# catalog::durable::transaction
Expand Down
2 changes: 1 addition & 1 deletion doc/developer/generated/cluster/client.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
source: src/cluster/src/client.rs
revision: 3ac449b444
revision: b0fa98e931
---

# client
Expand Down
2 changes: 1 addition & 1 deletion doc/developer/generated/cluster/communication.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
source: src/cluster/src/communication.rs
revision: 8cd889e259
revision: b0fa98e931
---

# communication
Expand Down
2 changes: 1 addition & 1 deletion doc/developer/generated/clusterd/_crate.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
source: src/clusterd/src/lib.rs
revision: 8cd889e259
revision: 086ebe05a3
---

# clusterd
Expand Down
2 changes: 1 addition & 1 deletion doc/developer/generated/compute-client/as_of_selection.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
source: src/compute-client/src/as_of_selection.rs
revision: 52af3ba2a1
revision: 00cc513fa5
---

# mz-compute-client::as_of_selection
Expand Down
Loading
Loading