Index

Type Alias Index 

Source
pub type Index = IndexMetadata;
👎Deprecated since 0.36.1: Use IndexMetadata instead

Aliased Type§

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<Arc<Any>>,
    pub index_version: i32,
    pub created_at: Option<DateTime<Utc>>,
    pub base_id: Option<u32>,
}

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.