Struct IndexMetadata 

pub struct IndexMetadata {
    pub uuid: Option<Uuid>,
    pub fields: Vec<i32>,
    pub name: String,
    pub dataset_version: u64,
    pub fragment_bitmap: Vec<u8>,
    pub index_details: Option<Any>,
    pub index_version: Option<i32>,
    pub created_at: Option<u64>,
    pub base_id: Option<u32>,
}

Metadata describing an index.

Fields

uuid: Option<Uuid>

Unique ID of an index. It is unique across all the dataset versions.

fields: Vec<i32>

The columns to build the index. These refer to file.Field.id.

name: String

Index name. Must be unique within one dataset version.

dataset_version: u64

The version of the dataset this index was built from.

fragment_bitmap: Vec<u8>

A bitmap of the included fragment ids.

This may by used to determine how much of the dataset is covered by the index. This information can be retrieved from the dataset by looking at the dataset at dataset_version. However, since the old version may be deleted while the index is still in use, this information is also stored in the index.

The bitmap is stored as a 32-bit Roaring bitmap.

index_details: Option<Any>

Details, specific to the index type, which are needed to load / interpret the index

Indices should avoid putting large amounts of information in this field, as it will bloat the manifest.

index_version: Option<i32>

The minimum lance version that this index is compatible with.

created_at: Option<u64>

Timestamp when the index was created (UTC timestamp in milliseconds since epoch)

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

base_id: Option<u32>

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

Implementations

impl IndexMetadata

pub fn index_version(&self) -> i32

Returns the value of index_version, or the default value if index_version is unset.

pub fn created_at(&self) -> u64

Returns the value of created_at, or the default value if created_at is unset.

pub fn base_id(&self) -> u32

Returns the value of base_id, or the default value if base_id is unset.

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 Default for IndexMetadata

fn default() -> Self

Returns the “default value” for a type.

impl From<&IndexMetadata> for IndexMetadata

fn from(idx: &IndexMetadata) -> Self

Converts to this type from the input type.

impl Message for IndexMetadata

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl Name for IndexMetadata

const NAME: &'static str = "IndexMetadata"

Simple name for this Message. This name is the same as it appears in the source .proto file, e.g. FooBar.

const PACKAGE: &'static str = "lance.table"

Package name this message type is contained in. They are domain-like and delimited by ., e.g. google.protobuf.

fn full_name() -> String

Fully-qualified unique name for this Message. It’s prefixed with the package name and names of any parent messages, e.g. google.rpc.BadRequest.FieldViolation. By default, this is the package name followed by the message name. Fully-qualified names must be unique within a domain of Type URLs.

fn type_url() -> String

Type URL for this Message, which by default is the full name with a leading slash, but may also include a leading domain name, e.g. type.googleapis.com/google.profile.Person. This can be used when serializing into the google.protobuf.Any 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