Enum persist::indexed::Cmd

pub enum Cmd {
    Register(String, (String, String), PFutureHandle<Id>),
    Destroy(String, PFutureHandle<bool>),
    Write(Vec<(Id, ColumnarRecords)>, PFutureHandle<SeqNo>),
    Seal(Vec<Id>, u64, PFutureHandle<SeqNo>),
    AllowCompaction(Vec<(Id, Antichain<u64>)>, PFutureHandle<SeqNo>),
    Maintenance(MaintenanceRes),
    Read(CmdRead),
}

An input to the persist state machine.

Variants

Register(String, (String, String), PFutureHandle<Id>)

Tuple Fields

0: String

1: (String, String)

2: PFutureHandle<Id>

Creates, if necessary, a new unsealed and trace with the given external stream name, returning the corresponding internal stream id.

This is idempotent: names may be registered multiple times.

Destroy(String, PFutureHandle<bool>)

Tuple Fields

0: String

1: PFutureHandle<bool>

Removes a stream from the index.

This is idempotent and may be called multiple times. It returns true if the stream was destroyed from this call, and false if it was already destroyed.

Write(Vec<(Id, ColumnarRecords)>, PFutureHandle<SeqNo>)

Tuple Fields

0: Vec<(Id, ColumnarRecords)>

1: PFutureHandle<SeqNo>

Asynchronously persists (Key, Value, Time, Diff) updates for the stream with the given id.

Seal(Vec<Id>, u64, PFutureHandle<SeqNo>)

Tuple Fields

0: Vec<Id>

1: u64

2: PFutureHandle<SeqNo>

Sealing a time advances the “sealed” frontier for an id, which restricts what times can later be sealed and written for that id. See sealed_frontier for details.

AllowCompaction(Vec<(Id, Antichain<u64>)>, PFutureHandle<SeqNo>)

Tuple Fields

0: Vec<(Id, Antichain<u64>)>

1: PFutureHandle<SeqNo>

Permit compaction of updates at times <= since to since.

The compaction frontier can never decrease and it is an error to call this function with a since argument that is less than the current compaction frontier.

While it may seem counter-intuitive to advance the compaction frontier past the seal frontier, this is perfectly valid. It can happen when joining updates from one stream to updates from another stream, and we already know that the other stream is compacted further along. Allowing compaction on this, the first stream, then is saying that we are fine with losing historical detail, and that we already allow compaction of updates that are yet to come because we don’t need them at their full resolution. A similar case is when we know that any outstanding queries have an as_of that is in the future of the seal: we can also pro-actively allow compaction of updates that did not yet arrive.

Maintenance(MaintenanceRes)

Tuple Fields

0: MaintenanceRes

A response from a previously sent maintenance request.

Read(CmdRead)

Tuple Fields

0: CmdRead

A read-only input to the persist state machine.

Implementations

impl Cmd

pub fn fill_err_runtime_shutdown(self)

Fills self’s response, if applicable, with Error::RuntimeShutdown.

Trait Implementations

impl Debug for Cmd

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

Formats the value using the given formatter.