Struct mz_transform::notice::OptimizerNotice

pub struct OptimizerNotice {
    pub id: GlobalId,
    pub kind: OptimizerNoticeKind,
    pub item_id: Option<GlobalId>,
    pub dependencies: BTreeSet<GlobalId>,
    pub message: String,
    pub hint: String,
    pub action: Action,
    pub message_redacted: Option<String>,
    pub hint_redacted: Option<String>,
    pub action_redacted: Option<Action>,
    pub created_at: u64,
}

An long lived in-memory representation of a RawOptimizerNotice that is meant to be kept as part of the hydrated catalog state.

Fields

id: GlobalId

An id that uniquely identifies this notice in the mz_notices relation.

kind: OptimizerNoticeKind

The notice kind.

item_id: Option<GlobalId>

The ID of the catalog item associated with this notice.

This is None if the notice is scoped to the entire catalog.

dependencies: BTreeSet<GlobalId>

A set of ids that need to exist for this notice to be considered valid. Removing any of the IDs in this set will result in the notice being asynchronously removed from the catalog state.

message: String

A brief description of what concretely went wrong.

Details and context about situations in which this notice kind would be emitted should be reserved for the documentation page for this notice kind.

hint: String

A high-level hint that tells the user what can be improved.

action: Action

A recommended action. This is a more concrete version of the hint.

message_redacted: Option<String>

A redacted version of the message field.

hint_redacted: Option<String>

A redacted version of the hint field.

action_redacted: Option<Action>

A redacted version of the action field.

created_at: u64

The date at which this notice was last created.

Implementations

impl OptimizerNotice

pub fn explain( notices: &Vec<Arc<Self>>, humanizer: &dyn ExprHumanizer, redacted: bool, ) -> Result<Vec<String>, Error>

Turns a vector of notices into a vector of strings that can be used in EXPLAIN.

This method should be consistent with RawOptimizerNotice::explain.

fn is_valid(&self, humanizer: &dyn ExprHumanizer) -> bool

Returns true iff both the dependencies and the associated item for this notice still exist.

This method should be consistent with RawOptimizerNotice::is_valid.

Trait Implementations

impl Arbitrary for OptimizerNotice

type Parameters = (<GlobalId as Arbitrary>::Parameters, <OptimizerNoticeKind as Arbitrary>::Parameters, <Option<GlobalId> as Arbitrary>::Parameters, <BTreeSet<GlobalId> as Arbitrary>::Parameters, <String as Arbitrary>::Parameters, <String as Arbitrary>::Parameters, <Action as Arbitrary>::Parameters, <Option<String> as Arbitrary>::Parameters, <Option<String> as Arbitrary>::Parameters, (<Option<Action> as Arbitrary>::Parameters, <u64 as Arbitrary>::Parameters))

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = Map<(<GlobalId as Arbitrary>::Strategy, <OptimizerNoticeKind as Arbitrary>::Strategy, <Option<GlobalId> as Arbitrary>::Strategy, <BTreeSet<GlobalId> as Arbitrary>::Strategy, <String as Arbitrary>::Strategy, <String as Arbitrary>::Strategy, <Action as Arbitrary>::Strategy, <Option<String> as Arbitrary>::Strategy, <Option<String> as Arbitrary>::Strategy, (<Option<Action> as Arbitrary>::Strategy, <u64 as Arbitrary>::Strategy)), fn(_: (GlobalId, OptimizerNoticeKind, Option<GlobalId>, BTreeSet<GlobalId>, String, String, Action, Option<String>, Option<String>, (Option<Action>, u64))) -> OptimizerNotice>

The type of Strategy used to generate values of type Self.

fn arbitrary_with(_top: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for OptimizerNotice

fn clone(&self) -> OptimizerNotice

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OptimizerNotice

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OptimizerNotice

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for OptimizerNotice

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for OptimizerNotice

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for OptimizerNotice

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for OptimizerNotice

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for OptimizerNotice

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 OptimizerNotice

impl StructuralPartialEq for OptimizerNotice