catalog: document the source and sink statuses the code produces - #38585
Open
ggevay wants to merge 1 commit into
Open
catalog: document the source and sink statuses the code produces#38585ggevay wants to merge 1 commit into
ggevay wants to merge 1 commit into
Conversation
The column comments and the docs listed `failed` among the statuses of mz_source_statuses, mz_sink_statuses and their history relations, and omitted `paused` for sinks. The storage status enum has no `failed` variant and its parser rejects the string, no writer produces it, and the controller sets `paused` on sinks as well as sources when their cluster has no replica. `created` stays: the status views synthesize it for an object with no status recorded yet. The sink troubleshooting page named `failed` as well. The autogenerated catalog docs SLT is regenerated with ci/test/lint-docs-catalog.sh --rewrite. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
ggevay
force-pushed
the
gabor/source-status-docs
branch
from
August 31, 2026 14:55
52593c3 to
74ff4d3
Compare
ggevay
marked this pull request as ready for review
August 31, 2026 18:18
kay-kim
approved these changes
Aug 31, 2026
martykulma
reviewed
Aug 31, 2026
| | `occurred_at` | [`timestamp with time zone`] | Wall-clock timestamp of the sink status change. | | ||
| | `sink_id` | [`text`] | The ID of the sink. Corresponds to [`mz_catalog.mz_sinks.id`](../mz_catalog#mz_sinks). | | ||
| | `status` | [`text`] | The status of the sink: one of `created`, `starting`, `running`, `stalled`, `failed`, or `dropped`. | | ||
| | `status` | [`text`] | The status of the sink: one of `created`, `starting`, `running`, `paused`, `stalled`, or `dropped`. | |
Contributor
There was a problem hiding this comment.
I didn't think created was valid in mz_sink_status_history, it shows up in mz_sink_statuses due to coalesce(status, 'created') as status so it wouldn't be NULL when joining against mz_sinks.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
The
statuscolumn comments ofmz_source_statuses,mz_sink_statuses,mz_source_status_historyandmz_sink_status_history, and the docs rows generated from them, listfailed, which nothing produces, and leave outpausedfor sinks, which the controller does produce. Found while writing agent guidance that keys off these statuses.Description
failedremoved from all four comments and docs rows: the storageStatusenum (src/storage-client/src/client.rs:168) hasstarting,running,paused,stalled,ceased(unused) anddropped, itsFromStrrejects any other string, and no writer emitsfailed.pausedadded to the two sink relations:update_paused_statuses(src/storage-controller/src/instance.rs:306) and the replica-dropped path (src/storage-controller/src/lib.rs:640) writepausedfor sinks as well as sources.createdstays: the status views synthesize it for objects with no status row yet (COALESCE(status, 'created')).sink-troubleshooting.mdalso told users to look forfailed. It now names onlystalled.test/sqllogictest/autogenerated/mz_internal.sltregenerated withci/test/lint-docs-catalog.sh --rewrite.Verification
ci/test/lint-docs-catalog.shpasses; the regenerated SLT asserts the docs text against the live column comments in CI.