Struct ExternalManifestCommitHandler 

pub struct ExternalManifestCommitHandler {
    pub external_manifest_store: Arc<dyn ExternalManifestStore>,
}

External manifest commit handler This handler is used to commit a manifest to an external store for detailed design, see https://github.com/lance-format/lance/issues/1183

Fields

external_manifest_store: Arc<dyn ExternalManifestStore>

Trait Implementations

impl CommitHandler for ExternalManifestCommitHandler

fn version_exists<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, base_path: &'life1 Path, version: u64, object_store: &'life2 dyn OSObjectStore, naming_scheme: ManifestNamingScheme, ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>

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

Check whether an attached manifest version exists without loading it.

fn resolve_latest_location<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, base_path: &'life1 Path, object_store: &'life2 ObjectStore, ) -> Pin<Box<dyn Future<Output = Result<ManifestLocation, Error>> + Send + 'async_trait>>

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

fn resolve_version_location<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, base_path: &'life1 Path, version: u64, object_store: &'life2 dyn OSObjectStore, ) -> Pin<Box<dyn Future<Output = Result<ManifestLocation, Error>> + Send + 'async_trait>>

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

fn resolve_identity<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, base_path: &'life1 Path, _object_store: &'life2 ObjectStore, version: u64, ) -> Pin<Box<dyn Future<Output = Result<Option<PredecessorIdentity>>> + Send + 'async_trait>>

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

The identity of the manifest at version as the handler’s store records it now; None where it keeps none or has no record.

fn list_manifest_locations<'a>( &self, base_path: &Path, object_store: &'a ObjectStore, sorted_descending: bool, ) -> BoxStream<'a, Result<ManifestLocation>>

If sorted_descending is true, the stream will yield manifests in descending order of version. When the object store has a lexicographically ordered list and the naming scheme is V2, this will use an optimized list operation. Otherwise, it will list all manifests and sort them in memory. When sorted_descending is false, the stream will yield manifests in arbitrary order.

fn list_manifest_locations_since<'a>( &self, base_path: &Path, object_store: &'a ObjectStore, since_version: u64, ) -> BoxStream<'a, Result<ManifestLocation>>

List manifest locations with version > since_version, in descending order of version.

fn commit<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, manifest: &'life1 mut Manifest, indices: Option<Vec<IndexMetadata>>, base_path: &'life2 Path, object_store: &'life3 ObjectStore, manifest_writer: ManifestWriter, naming_scheme: ManifestNamingScheme, transaction: Option<Transaction>, ) -> Pin<Box<dyn Future<Output = Result<ManifestLocation, CommitError>> + Send + 'async_trait>>

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

Commit a manifest.

fn delete<'life0, 'life1, 'async_trait>( &'life0 self, base_path: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

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

Delete the recorded manifest information for a dataset at the base_path

fn forget_version<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, base_path: &'life1 Path, version: u64, identity: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

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

Retire the record for version after its manifest was removed, only while the record still carries identity; a no-op otherwise.

fn supports_predecessor_condition(&self) -> bool

Whether Self::commit_after is available.

fn resolve_latest_identity<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, base_path: &'life1 Path, _object_store: &'life2 ObjectStore, ) -> Pin<Box<dyn Future<Output = Result<Option<PredecessorIdentity>>> + Send + 'async_trait>>

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

The identity of the latest manifest, for Self::commit_after. None where the handler cannot condition on it.

fn commit_after<'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>( &'life0 self, manifest: &'life1 mut Manifest, indices: Option<Vec<IndexMetadata>>, base_path: &'life2 Path, object_store: &'life3 ObjectStore, manifest_writer: ManifestWriter, naming_scheme: ManifestNamingScheme, transaction: Option<Transaction>, predecessor: &'life4 PredecessorIdentity, ) -> Pin<Box<dyn Future<Output = Result<ManifestLocation, CommitError>> + Send + 'async_trait>>

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

Commit only if predecessor is still the manifest at its version, decided with the reservation; otherwise Error::PrerequisiteFailed, never a conflict.

fn is_version_not_found_definitive(&self) -> bool

Whether a not-found result from Self::resolve_version_location is definitive immediately after a commit attempt.

fn propagate_commit_error_after_success(&self) -> bool

Whether an error should still be returned after readback proves that the manifest from the current commit attempt landed.

fn list_detached_manifest_locations<'a>( &self, base_path: &Path, object_store: &'a ObjectStore, ) -> BoxStream<'a, Result<ManifestLocation>>

List detached manifest locations.

impl Debug for ExternalManifestCommitHandler

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

Formats the value using the given formatter.