Struct IndexMetadata 

pub struct IndexMetadata {
    pub uuid: Uuid,
    pub fields: Vec<i32>,
    pub name: String,
    pub dataset_version: u64,
    pub fragment_bitmap: Option<RoaringBitmap>,
    pub index_details: Option<Arc<Any>>,
    pub index_version: i32,
    pub created_at: Option<DateTime<Utc>>,
    pub base_id: Option<u32>,
    pub files: Option<Vec<IndexFile>>,
}

Index metadata

Fields

uuid: Uuid

Unique ID across all dataset versions.

fields: Vec<i32>

Fields to build the index.

name: String

Human readable index name

dataset_version: u64

The version of the dataset this index was last updated on

This is set when the index is created (based on the version used to train the index) This is updated when the index is updated or remapped

fragment_bitmap: Option<RoaringBitmap>

The fragment ids this index covers.

This may contain fragment ids that no longer exist in the dataset.

If this is None, then this is unknown.

index_details: Option<Arc<Any>>

Metadata specific to the index type

This is an Option because older versions of Lance may not have this defined. However, it should always be present in newer versions.

index_version: i32

The index version.

created_at: Option<DateTime<Utc>>

Timestamp when the index was created

This field is optional for backward compatibility. For existing indices created before this field was added, this will be None.

base_id: Option<u32>

The base path index of the index files. Used when the index is imported or referred from another dataset. Lance uses it as key of the base_paths field in Manifest to determine the actual base path of the index files.

files: Option<Vec<IndexFile>>

List of files and their sizes for this index segment. This enables skipping HEAD calls when opening indices and provides visibility into index storage size via describe_indices(). This is None if the file sizes are unknown. This happens for indices created before this field was added.

Implementations

impl IndexMetadata

pub fn effective_fragment_bitmap( &self, existing_fragments: &RoaringBitmap, ) -> Option<RoaringBitmap>

pub fn file_size_map(&self) -> HashMap<String, u64>

Returns a map of relative file paths to their sizes. Returns an empty map if file information is not available.

pub fn total_size_bytes(&self) -> Option<u64>

Returns the total size of all files in this index segment in bytes. Returns None if file information is not available.

pub fn deleted_fragment_bitmap( &self, existing_fragments: &RoaringBitmap, ) -> Option<RoaringBitmap>

Returns the set of fragments which are part of the fragment bitmap but no longer in the dataset.

Trait Implementations

impl Clone for IndexMetadata

fn clone(&self) -> IndexMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IndexMetadata

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

Formats the value using the given formatter.

impl DeepSizeOf for IndexMetadata

fn deep_size_of_children(&self, context: &mut Context) -> usize

Returns an estimation of the heap-managed storage of this object. This does not include the size of the object itself.

fn deep_size_of(&self) -> usize

Returns an estimation of a total size of memory owned by the object, including heap-managed storage.

impl From<&IndexMetadata> for IndexMetadata

fn from(idx: &IndexMetadata) -> IndexMetadata

Converts to this type from the input type.

impl IntoIndexSegment for IndexMetadata

fn into_index_segment(self) -> Result<IndexSegment>

Convert into an index segment.

impl PartialEq for IndexMetadata

fn eq(&self, other: &IndexMetadata) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<IndexMetadata> for IndexMetadata

type Error = Error

The type returned in the event of a conversion error.

fn try_from(proto: IndexMetadata) -> Result<IndexMetadata, Error>

Performs the conversion.

impl StructuralPartialEq for IndexMetadata