Enum mz_storage::sink::healthcheck::SinkStatus

pub enum SinkStatus {
    Starting,
    Running,
    Stalled {
        error: String,
        hint: Option<String>,
    },
}

Identify the state a worker for a given source can be at a point in time

Variants

Starting

Intended to be the state while the clusterd process is initializing itself Pushed by the Healthchecker on creation.

Running

State indicating the sink is running fine. Pushed automatically as long as rows are being consumed.

Stalled

Fields

error: String

Error string used to populate the error column in the mz_sink_status_history table.

hint: Option<String>

Optional hint string which if present, will be added to the details column in the mz_sink_status_history table.

Represents a stall in the export process that might get resolved. Existing data is still available and queryable.

Implementations

impl SinkStatus

fn name(&self) -> &'static str

fn error(&self) -> Option<&str>

fn hint(&self) -> Option<&str>

fn can_transition( old_status: Option<&SinkStatus>, new_status: &SinkStatus ) -> bool

Trait Implementations

impl Clone for SinkStatus

fn clone(&self) -> SinkStatus

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SinkStatus

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SinkStatus

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SinkStatus

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HealthStatus for SinkStatus

fn name(&self) -> &'static str

The user-readable name of the status state.

fn error(&self) -> Option<&str>

The user-readable error string, if there is one.

fn hint(&self) -> Option<&str>

A hint for solving the error, if there is one.

fn should_halt(&self) -> bool

Whether or not we should halt the dataflow instances and restart it.

fn can_transition_from(&self, other: Option<&Self>) -> bool

Whether or not we can transition from a state (or lack of one).

fn starting() -> Self

A instance of a status that specifies that the object is starting. Used when the dataflow starts up.

impl Ord for SinkStatus

fn cmp(&self, other: &SinkStatus) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<SinkStatus> for SinkStatus

fn eq(&self, other: &SinkStatus) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<SinkStatus> for SinkStatus

fn partial_cmp(&self, other: &SinkStatus) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for SinkStatus

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SinkStatus

impl StructuralEq for SinkStatus

impl StructuralPartialEq for SinkStatus