com.lancedb.lance.index

Class Index

java.lang.Object

com.lancedb.lance.index.Index

public class Index
extends Object

Metadata for an index in the dataset. This class corresponds to the Rust Index struct in lance/rust/lance-table/src/format/index.rs.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Index.Builder

Method Summary

Modifier and Type	Method and Description
Optional<Integer>	baseId()
static Index.Builder	builder() Create a new builder for Index.
Optional<java.time.Instant>	createdAt() Get the creation time of the index.
long	datasetVersion() The latest version of the dataset this index covers
boolean	equals(Object o)
List<Integer>	fields() Get the field id list included in the index.
Optional<byte[]>	fragmentBitmap()
int	hashCode()
Optional<byte[]>	indexDetails()
int	indexVersion() Get the index version.
String	name() Human readable index name
String	toString()
UUID	uuid()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

uuid

public UUID uuid()

fields

public List<Integer> fields()

Get the field id list included in the index.

Returns:

the field IDs

name

public String name()

Human readable index name

Returns:

the index name

datasetVersion

public long datasetVersion()

The latest version of the dataset this index covers

Returns:

the dataset version

fragmentBitmap

public Optional<byte[]> fragmentBitmap()

indexDetails

public Optional<byte[]> indexDetails()

baseId

public Optional<Integer> baseId()

indexVersion

public int indexVersion()

Get the index version.

Returns:

the index version

createdAt

public Optional<java.time.Instant> createdAt()

Get the creation time of the index.

Returns:

the creation time

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

builder

public static Index.Builder builder()

Create a new builder for Index.

Returns:

a new builder