Struct CollectionState

pub struct CollectionState {
    reported_frontiers: ReportedFrontiers,
    dataflow_index: Rc<usize>,
    pub is_subscribe_or_copy: bool,
    as_of: Antichain<Timestamp>,
    pub sink_token: Option<SinkToken>,
    pub sink_write_frontier: Option<Rc<RefCell<Antichain<Timestamp>>>>,
    pub input_probes: BTreeMap<GlobalId, Handle<Timestamp>>,
    pub compute_probe: Option<Handle<Timestamp>>,
    logging: Option<CollectionLogging>,
    metrics: CollectionMetrics,
}

State maintained for a compute collection.

Fields

reported_frontiers: ReportedFrontiers

Tracks the frontiers that have been reported to the controller.

dataflow_index: Rc<usize>

The index of the dataflow computing this collection.

Used for dropping the dataflow when the collection is dropped. The Dataflow index is wrapped in an Rcs and can be shared between collections, to reflect the possibility that a single dataflow can export multiple collections.

is_subscribe_or_copy: bool

Whether this collection is a subscribe or copy-to.

The compute protocol does not allow Frontiers responses for subscribe and copy-to collections, so we need to be able to recognize them. This is something we would like to change in the future (database-issues#4701).

as_of: Antichain<Timestamp>

The collection’s initial as-of frontier.

Used to determine hydration status.

sink_token: Option<SinkToken>

A token that should be dropped when this collection is dropped to clean up associated sink state.

Only Some if the collection is a sink.

sink_write_frontier: Option<Rc<RefCell<Antichain<Timestamp>>>>

Frontier of sink writes.

Only Some if the collection is a sink and not a subscribe.

input_probes: BTreeMap<GlobalId, Handle<Timestamp>>

Frontier probes for every input to the collection.

compute_probe: Option<Handle<Timestamp>>

A probe reporting the frontier of times through which all collection outputs have been computed (but not necessarily written).

None for collections with compute frontiers equal to their write frontiers.

logging: Option<CollectionLogging>

Logging state maintained for this collection.

metrics: CollectionMetrics

Metrics tracked for this collection.

Implementations

impl CollectionState

fn new( dataflow_index: Rc<usize>, is_subscribe_or_copy: bool, as_of: Antichain<Timestamp>, metrics: CollectionMetrics, ) -> Self

fn reported_frontiers(&self) -> &ReportedFrontiers

Return the frontiers that have been reported to the controller.

pub fn reset_reported_frontiers(&mut self, frontier: ReportedFrontier)

Reset all reported frontiers to the given value.

fn set_reported_write_frontier(&mut self, frontier: ReportedFrontier)

Set the write frontier that has been reported to the controller.

fn set_reported_input_frontier(&mut self, frontier: ReportedFrontier)

Set the input frontier that has been reported to the controller.

fn set_reported_output_frontier(&mut self, frontier: ReportedFrontier)

Set the output frontier that has been reported to the controller.

fn hydrated(&self) -> bool

Return whether this collection is hydrated.