Struct mz_storage_client::controller::collection_mgmt::CollectionManager

pub struct CollectionManager<T>where
    T: Timestamp + Lattice + Codec64 + TimestampManipulation,{
    collections: Arc<Mutex<BTreeMap<GlobalId, (Sender<(Vec<(Row, Diff)>, Sender<Result<(), StorageError>>)>, AbortOnDropHandle<()>, Sender<()>)>>>,
    write_handle: PersistMonotonicWriteWorker<T>,
    now: NowFn,
}

Fields

collections: Arc<Mutex<BTreeMap<GlobalId, (Sender<(Vec<(Row, Diff)>, Sender<Result<(), StorageError>>)>, AbortOnDropHandle<()>, Sender<()>)>>>

write_handle: PersistMonotonicWriteWorker<T>

now: NowFn

Implementations

impl<T> CollectionManager<T>where T: Timestamp + Lattice + Codec64 + From<EpochMillis> + TimestampManipulation,

The CollectionManager provides two complementary functions:

• Providing an API to append values to a registered set of collections. For this usecase:
  • The CollectionManager expects to be the only writer.
  • Appending to a closed collection panics
• Automatically advancing the timestamp of managed collections every second. For this usecase:
  • The CollectionManager handles contention by permitting and ignoring errors.
  • Closed collections will not panic if they continue receiving these requests.

pub(super) fn new( write_handle: PersistMonotonicWriteWorker<T>, now: NowFn ) -> CollectionManager<T>

pub(super) fn register_collection(&self, id: GlobalId)

Registers the collection as one that CollectionManager will:

• Automatically advance the upper of every second
• Accept appends for. However, note that when appending, the CollectionManager expects to be the only writer.

pub(super) async fn unregsiter_collection(&self, id: GlobalId) -> bool

Unregisters the collection as one that CollectionManager will maintain.

Also waits until the CollectionManager has completed all outstanding work to ensure that it has stopped referencing the provided id.

pub(super) async fn append_to_collection( &self, id: GlobalId, updates: Vec<(Row, Diff)> )

Appends updates to the collection correlated with id, does not work for the append to complete.

Panics

• If id does not belong to managed collections.
• If there is contention to write to the collection identified by id.
• If the collection closed.

pub(super) fn monotonic_appender( &self, id: GlobalId ) -> Result<MonotonicAppender, StorageError>

Returns a MonotonicAppender that can be used to monotonically append updates to the collection correlated with id.

Trait Implementations

impl<T> Clone for CollectionManager<T>where T: Timestamp + Lattice + Codec64 + TimestampManipulation + Clone,

fn clone(&self) -> CollectionManager<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for CollectionManager<T>where T: Timestamp + Lattice + Codec64 + TimestampManipulation + Debug,

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

Formats the value using the given formatter.