Struct mz_transform::dataflow::DataflowMetainfo

pub struct DataflowMetainfo<Notice = RawOptimizerNotice> {
    pub optimizer_notices: Vec<Notice>,
    pub index_usage_types: BTreeMap<GlobalId, Vec<IndexUsageType>>,
}

Extra information about the dataflow. This is not going to be shipped, but has to be processed in other ways, e.g., showing notices to the user, or saving meta-information to the catalog.

Fields

optimizer_notices: Vec<Notice>

Notices that the optimizer wants to show to users. For pushing a new element, use Self::push_optimizer_notice_dedup.

index_usage_types: BTreeMap<GlobalId, Vec<IndexUsageType>>

What kind of operation (full scan, lookup, …) will access each index. Computed by prune_and_annotate_dataflow_index_imports.

Implementations

impl<Notice> DataflowMetainfo<Notice>

pub fn used_indexes<T>(&self, df_desc: &DataflowDescription<T>) -> UsedIndexes

Create a UsedIndexes instance by resolving each id in the index_ids iterator against an entry expected to exist in the DataflowMetainfo::index_usage_types.

impl DataflowMetainfo<RawOptimizerNotice>

pub fn push_optimizer_notice_dedup<T>(&mut self, notice: T)

where T: Into<RawOptimizerNotice>,

Pushes a RawOptimizerNotice into Self::optimizer_notices, but only if the exact same notice is not already present.

Trait Implementations

impl<Notice: Arbitrary> Arbitrary for DataflowMetainfo<Notice>

type Parameters = (<Vec<Notice> as Arbitrary>::Parameters, <BTreeMap<GlobalId, Vec<IndexUsageType>> as Arbitrary>::Parameters)

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

type Strategy = Map<(<Vec<Notice> as Arbitrary>::Strategy, <BTreeMap<GlobalId, Vec<IndexUsageType>> as Arbitrary>::Strategy), fn(_: (Vec<Notice>, BTreeMap<GlobalId, Vec<IndexUsageType>>)) -> DataflowMetainfo<Notice>>

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<Notice: Clone> Clone for DataflowMetainfo<Notice>

fn clone(&self) -> DataflowMetainfo<Notice>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Notice: Debug> Debug for DataflowMetainfo<Notice>

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

Formats the value using the given formatter.

impl Default for DataflowMetainfo

fn default() -> Self

Returns the “default value” for a type.

impl<'de, Notice> Deserialize<'de> for DataflowMetainfo<Notice>

where Notice: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Notice: PartialEq> PartialEq for DataflowMetainfo<Notice>

fn eq(&self, other: &DataflowMetainfo<Notice>) -> 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<Notice> Serialize for DataflowMetainfo<Notice>

where Notice: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<Notice: Eq> Eq for DataflowMetainfo<Notice>

impl<Notice> StructuralPartialEq for DataflowMetainfo<Notice>