Struct Index

pub struct Index {
    pub uuid: Uuid,
    pub fields: Vec<i32>,
    pub name: String,
    pub dataset_version: u64,
    pub fragment_bitmap: Option<RoaringBitmap>,
    pub index_details: Option<Any>,
    pub index_version: i32,
    pub created_at: Option<DateTime<Utc>>,
}

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.

If this is None, then this is unknown.

index_details: Option<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.

Trait Implementations

impl Clone for Index

fn clone(&self) -> Index

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Index

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

Formats the value using the given formatter.

impl DeepSizeOf for Index

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<&Index> for IndexMetadata

fn from(idx: &Index) -> Self

Converts to this type from the input type.

impl PartialEq for Index

fn eq(&self, other: &Index) -> 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 Index

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 Index