diff --git a/doc/user/content/reference/system-catalog/mz_internal.md b/doc/user/content/reference/system-catalog/mz_internal.md index 39fbf312341a4..e2ebd447ff57e 100644 --- a/doc/user/content/reference/system-catalog/mz_internal.md +++ b/doc/user/content/reference/system-catalog/mz_internal.md @@ -1280,7 +1280,7 @@ debugging. | `name` | [`text`] | The name of the sink. | | `type` | [`text`] | The type of the sink. | | `last_status_change_at` | [`timestamp with time zone`] | Wall-clock timestamp of the sink status change. | -| `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`. | | `error` | [`text`] | If the sink is in an error state, the error message. | | `details` | [`jsonb`] | Additional metadata provided by the sink. In case of error, may contain a `hint` field with helpful suggestions. | @@ -1295,7 +1295,7 @@ messages and additional metadata helpful for debugging. | -------------- | ------------------------------- | -------- | | `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`. | | `error` | [`text`] | If the sink is in an error state, the error message. | | `details` | [`jsonb`] | Additional metadata provided by the sink. In case of error, may contain a `hint` field with helpful suggestions. | | `replica_id` | [`text`] | The ID of the replica that an instance of a sink is running on. | @@ -1402,7 +1402,7 @@ debugging. | `name` | [`text`] | The name of the source. | | `type` | [`text`] | The type of the source. | | `last_status_change_at` | [`timestamp with time zone`] | Wall-clock timestamp of the source status change. | -| `status` | [`text`] | The status of the source: one of `created`, `starting`, `running`, `paused`, `stalled`, `failed`, or `dropped`. | +| `status` | [`text`] | The status of the source: one of `created`, `starting`, `running`, `paused`, `stalled`, or `dropped`. | | `error` | [`text`] | If the source is in an error state, the error message. | | `details` | [`jsonb`] | Additional metadata provided by the source. In case of error, may contain a `hint` field with helpful suggestions. | @@ -1417,7 +1417,7 @@ messages and additional metadata helpful for debugging. | -------------- | ------------------------------- | -------- | | `occurred_at` | [`timestamp with time zone`] | Wall-clock timestamp of the source status change. | | `source_id` | [`text`] | The ID of the source. Corresponds to [`mz_catalog.mz_sources.id`](../mz_catalog#mz_sources). | -| `status` | [`text`] | The status of the source: one of `created`, `starting`, `running`, `paused`, `stalled`, `failed`, or `dropped`. | +| `status` | [`text`] | The status of the source: one of `created`, `starting`, `running`, `paused`, `stalled`, or `dropped`. | | `error` | [`text`] | If the source is in an error state, the error message. | | `details` | [`jsonb`] | Additional metadata provided by the source. In case of error, may contain a `hint` field with helpful suggestions. | | `replica_id` | [`text`] | The ID of the replica that an instance of a source is running on. | diff --git a/doc/user/content/serve-results/sink/sink-troubleshooting.md b/doc/user/content/serve-results/sink/sink-troubleshooting.md index b199562b3fda5..3868e7e0607f0 100644 --- a/doc/user/content/serve-results/sink/sink-troubleshooting.md +++ b/doc/user/content/serve-results/sink/sink-troubleshooting.md @@ -21,8 +21,8 @@ SELECT * FROM mz_internal.mz_sink_statuses WHERE name = ; ``` -If your sink reports a status of `stalled` or `failed`, you likely have a -configuration issue. The returned `error` field will provide details. +If your sink reports a status of `stalled`, you likely have a configuration +issue. The returned `error` field will provide details. If your sink reports a status of `starting` for more than a few minutes, [contact support](/support). diff --git a/src/catalog/src/builtin/mz_internal.rs b/src/catalog/src/builtin/mz_internal.rs index 123c870f2fce3..1d5be62e21d26 100644 --- a/src/catalog/src/builtin/mz_internal.rs +++ b/src/catalog/src/builtin/mz_internal.rs @@ -1318,7 +1318,7 @@ pub static MZ_SOURCE_STATUS_HISTORY: LazyLock = LazyLock::new(|| ), ( "status", - "The status of the source: one of `created`, `starting`, `running`, `paused`, `stalled`, `failed`, or `dropped`.", + "The status of the source: one of `created`, `starting`, `running`, `paused`, `stalled`, or `dropped`.", ), ( "error", @@ -2169,7 +2169,7 @@ pub static MZ_SOURCE_STATUSES: LazyLock = LazyLock::new(|| BuiltinV ), ( "status", - "The status of the source: one of `created`, `starting`, `running`, `paused`, `stalled`, `failed`, or `dropped`.", + "The status of the source: one of `created`, `starting`, `running`, `paused`, `stalled`, or `dropped`.", ), ( "error", @@ -2368,7 +2368,7 @@ pub static MZ_SINK_STATUS_HISTORY: LazyLock = LazyLock::new(|| Bu ), ( "status", - "The status of the sink: one of `created`, `starting`, `running`, `stalled`, `failed`, or `dropped`.", + "The status of the sink: one of `created`, `starting`, `running`, `paused`, `stalled`, or `dropped`.", ), ( "error", @@ -2451,7 +2451,7 @@ pub static MZ_SINK_STATUSES: LazyLock = LazyLock::new(|| BuiltinVie ), ( "status", - "The status of the sink: one of `created`, `starting`, `running`, `stalled`, `failed`, or `dropped`.", + "The status of the sink: one of `created`, `starting`, `running`, `paused`, `stalled`, or `dropped`.", ), ( "error", diff --git a/test/sqllogictest/autogenerated/mz_internal.slt b/test/sqllogictest/autogenerated/mz_internal.slt index 47c55bb3d6813..a806a2bf8bac2 100644 --- a/test/sqllogictest/autogenerated/mz_internal.slt +++ b/test/sqllogictest/autogenerated/mz_internal.slt @@ -683,7 +683,7 @@ id text The␠ID␠of␠the␠sink.␠Corresponds␠to␠`mz_catalog.mz_sinks. name text The␠name␠of␠the␠sink. type text The␠type␠of␠the␠sink. last_status_change_at timestamp␠with␠time␠zone Wall-clock␠timestamp␠of␠the␠sink␠status␠change. -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`. error text If␠the␠sink␠is␠in␠an␠error␠state,␠the␠error␠message. details jsonb Additional␠metadata␠provided␠by␠the␠sink.␠In␠case␠of␠error,␠may␠contain␠a␠`hint`␠field␠with␠helpful␠suggestions. @@ -692,7 +692,7 @@ SELECT name, type, comment FROM objects WHERE schema = 'mz_internal' AND object ---- 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`. -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`. error text If␠the␠sink␠is␠in␠an␠error␠state,␠the␠error␠message. details jsonb Additional␠metadata␠provided␠by␠the␠sink.␠In␠case␠of␠error,␠may␠contain␠a␠`hint`␠field␠with␠helpful␠suggestions. replica_id text The␠ID␠of␠the␠replica␠that␠an␠instance␠of␠a␠sink␠is␠running␠on. @@ -722,7 +722,7 @@ id text The␠ID␠of␠the␠source.␠Corresponds␠to␠`mz_catalog.mz_sour name text The␠name␠of␠the␠source. type text The␠type␠of␠the␠source. last_status_change_at timestamp␠with␠time␠zone Wall-clock␠timestamp␠of␠the␠source␠status␠change. -status text The␠status␠of␠the␠source:␠one␠of␠`created`,␠`starting`,␠`running`,␠`paused`,␠`stalled`,␠`failed`,␠or␠`dropped`. +status text The␠status␠of␠the␠source:␠one␠of␠`created`,␠`starting`,␠`running`,␠`paused`,␠`stalled`,␠or␠`dropped`. error text If␠the␠source␠is␠in␠an␠error␠state,␠the␠error␠message. details jsonb Additional␠metadata␠provided␠by␠the␠source.␠In␠case␠of␠error,␠may␠contain␠a␠`hint`␠field␠with␠helpful␠suggestions. @@ -731,7 +731,7 @@ SELECT name, type, comment FROM objects WHERE schema = 'mz_internal' AND object ---- occurred_at timestamp␠with␠time␠zone Wall-clock␠timestamp␠of␠the␠source␠status␠change. source_id text The␠ID␠of␠the␠source.␠Corresponds␠to␠`mz_catalog.mz_sources.id`. -status text The␠status␠of␠the␠source:␠one␠of␠`created`,␠`starting`,␠`running`,␠`paused`,␠`stalled`,␠`failed`,␠or␠`dropped`. +status text The␠status␠of␠the␠source:␠one␠of␠`created`,␠`starting`,␠`running`,␠`paused`,␠`stalled`,␠or␠`dropped`. error text If␠the␠source␠is␠in␠an␠error␠state,␠the␠error␠message. details jsonb Additional␠metadata␠provided␠by␠the␠source.␠In␠case␠of␠error,␠may␠contain␠a␠`hint`␠field␠with␠helpful␠suggestions. replica_id text The␠ID␠of␠the␠replica␠that␠an␠instance␠of␠a␠source␠is␠running␠on.