Struct StorageCollectionsImpl 

pub struct StorageCollectionsImpl { /* private fields */ }

Implementation of StorageCollections that is shallow-cloneable and uses a background task for doing work concurrently, in the background.

Implementations

impl StorageCollectionsImpl

pub async fn new( persist_location: PersistLocation, persist_clients: Arc<PersistClientCache>, metrics_registry: &MetricsRegistry, _now: NowFn, txns_metrics: Arc<TxnMetrics>, envd_epoch: NonZeroI64, read_only: bool, connection_context: ConnectionContext, txn: &dyn StorageTxn, ) -> Self

Creates and returns a new StorageCollections.

Note that when creating a new StorageCollections, you must also reconcile it with the previous state using StorageCollections::initialize_state, StorageCollections::prepare_state, and StorageCollections::create_collections_for_bootstrap.

Trait Implementations

impl Clone for StorageCollectionsImpl

fn clone(&self) -> StorageCollectionsImpl

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StorageCollectionsImpl

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

Formats the value using the given formatter.

impl StorageCollections for StorageCollectionsImpl

fn determine_time_dependence( &self, id: GlobalId, ) -> Result<Option<TimeDependence>, TimeDependenceError>

Determine time dependence information for the object.

fn initialize_state<'life0, 'life1, 'async_trait>( &'life0 self, txn: &'life1 mut (dyn StorageTxn + Send), init_ids: BTreeSet<GlobalId>, ) -> Pin<Box<dyn Future<Output = Result<(), StorageError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

On boot, reconcile this StorageCollections with outside state. We get a StorageTxn where we can record any durable state that we need.

fn update_parameters(&self, config_params: StorageParameters)

Update storage configuration with new parameters.

fn collection_metadata( &self, id: GlobalId, ) -> Result<CollectionMetadata, CollectionMissing>

Returns the CollectionMetadata of the collection identified by id.

fn active_collection_metadatas(&self) -> Vec<(GlobalId, CollectionMetadata)>

Acquire an iterator over CollectionMetadata for all active collections.

fn collections_frontiers( &self, ids: Vec<GlobalId>, ) -> Result<Vec<CollectionFrontiers>, CollectionMissing>

Atomically gets and returns the frontiers of all the identified collections.

fn active_collection_frontiers(&self) -> Vec<CollectionFrontiers>

Atomically gets and returns the frontiers of all active collections.

fn snapshot_stats<'life0, 'async_trait>( &'life0 self, id: GlobalId, as_of: Antichain<Timestamp>, ) -> Pin<Box<dyn Future<Output = Result<SnapshotStats, StorageError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns aggregate statistics about the contents of the local input named id at as_of.

fn snapshot_parts_stats<'life0, 'async_trait>( &'life0 self, id: GlobalId, as_of: Antichain<Timestamp>, ) -> Pin<Box<dyn Future<Output = BoxFuture<'static, Result<SnapshotPartsStats, StorageError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns aggregate statistics about the contents of the local input named id at as_of.

fn snapshot( &self, id: GlobalId, as_of: Timestamp, ) -> BoxFuture<'static, Result<Vec<(Row, StorageDiff)>, StorageError>>

Returns a snapshot of the contents of collection id at as_of.

fn snapshot_latest<'life0, 'async_trait>( &'life0 self, id: GlobalId, ) -> Pin<Box<dyn Future<Output = Result<Vec<Row>, StorageError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns a snapshot of the contents of collection id at the largest readable as_of. The collection must consolidate to a set, i.e., the multiplicity of every row must be 1!

fn snapshot_cursor( &self, id: GlobalId, as_of: Timestamp, ) -> BoxFuture<'static, Result<SnapshotCursor, StorageError>>

Returns a snapshot of the contents of collection id at as_of.

fn snapshot_and_stream( &self, id: GlobalId, as_of: Timestamp, ) -> BoxFuture<'static, Result<BoxStream<'static, (SourceData, Timestamp, StorageDiff)>, StorageError>>

Generates a snapshot of the contents of collection id at as_of and streams out all of the updates in bounded memory.

fn create_update_builder( &self, id: GlobalId, ) -> BoxFuture<'static, Result<TimestamplessUpdateBuilder<SourceData, (), StorageDiff>, StorageError>>

Create a TimestamplessUpdateBuilder that can be used to stage updates for the provided GlobalId.

fn check_exists(&self, id: GlobalId) -> Result<(), StorageError>

Checks whether a collection exists under the given GlobalId. Returns an error if the collection does not exist.

fn prepare_state<'life0, 'life1, 'async_trait>( &'life0 self, txn: &'life1 mut (dyn StorageTxn + Send), ids_to_add: BTreeSet<GlobalId>, ids_to_drop: BTreeSet<GlobalId>, ids_to_register: BTreeMap<GlobalId, ShardId>, ) -> Pin<Box<dyn Future<Output = Result<(), StorageError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Update the given StorageTxn with the appropriate metadata given the IDs to add and drop.

fn create_collections_for_bootstrap<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, storage_metadata: &'life1 StorageMetadata, register_ts: Option<Timestamp>, collections: Vec<(GlobalId, CollectionDescription)>, migrated_storage_collections: &'life2 BTreeSet<GlobalId>, ) -> Pin<Box<dyn Future<Output = Result<(), StorageError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Create the collections described by the individual CollectionDescriptions.

fn alter_table_desc<'life0, 'async_trait>( &'life0 self, existing_collection: GlobalId, new_collection: GlobalId, new_desc: RelationDesc, expected_version: RelationVersion, ) -> Pin<Box<dyn Future<Output = Result<(), StorageError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Updates the RelationDesc for the specified table.

fn drop_collections_unvalidated( &self, storage_metadata: &StorageMetadata, identifiers: Vec<GlobalId>, )

Drops the read capability for the sources and allows their resources to be reclaimed.

fn set_read_policies(&self, policies: Vec<(GlobalId, ReadPolicy)>)

Assigns a read policy to specific identifiers.

fn acquire_read_holds( &self, desired_holds: Vec<GlobalId>, ) -> Result<Vec<ReadHold>, CollectionMissing>

Acquires and returns the earliest possible read holds for the specified collections.

fn dump(&self) -> Result<Value, Error>

Returns the state of StorageCollections formatted as JSON.

fn collection_frontiers( &self, id: GlobalId, ) -> Result<CollectionFrontiers, CollectionMissing>

Returns the frontiers of the identified collection.