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>,
}

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 latest version of the dataset this index covers

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.

Implementations

impl IndexMetadata

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

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

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) -> Self

Converts to this type from the input type.

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<Self>

Performs the conversion.

impl StructuralPartialEq for IndexMetadata