Skip navigation links
A B C D E F G H I J L M N O P Q R S T U V W 

A

acquireReadLock() - Method in class com.lancedb.lance.LockManager
Acquires a read lock on the LockManager.
acquireWriteLock() - Method in class com.lancedb.lance.LockManager
Acquires a write lock on the LockManager.
addColumns(SqlExpressions, Optional<Long>) - Method in class com.lancedb.lance.Dataset
Add columns to the dataset.
addColumns(ArrowArrayStream, Optional<Long>) - Method in class com.lancedb.lance.Dataset
Add columns to the dataset.
addColumns(Schema) - Method in class com.lancedb.lance.Dataset
Add columns to the dataset.
addColumns(List<Field>) - Method in class com.lancedb.lance.Dataset
Add columns to the dataset.
addFiledStatistics(FieldStatistics) - Method in class com.lancedb.lance.ipc.DataStatistics
 
allocator() - Method in class com.lancedb.lance.Dataset
 
alterColumns(List<ColumnAlteration>) - Method in class com.lancedb.lance.Dataset
Alter columns in the dataset.
Append(List<FragmentMetadata>) - Constructor for class com.lancedb.lance.FragmentOperation.Append
Deprecated.
 
Append - Class in com.lancedb.lance.operation
 
Append.Builder - Class in com.lancedb.lance.operation
 
asArrowField() - Method in class com.lancedb.lance.schema.LanceField
 
asArrowSchema() - Method in class com.lancedb.lance.schema.LanceSchema
 

B

baseId() - Method in class com.lancedb.lance.index.Index
 
baseId(Integer) - Method in class com.lancedb.lance.index.Index.Builder
 
batchReadahead(int) - Method in class com.lancedb.lance.ipc.ScanOptions.Builder
Set the batch readahead.
batchSize(long) - Method in class com.lancedb.lance.ipc.ScanOptions.Builder
Set the batch size.
blobsOperation() - Method in class com.lancedb.lance.Transaction
 
build() - Method in class com.lancedb.lance.index.Index.Builder
 
build() - Method in class com.lancedb.lance.index.IndexParams.Builder
 
build() - Method in class com.lancedb.lance.index.vector.HnswBuildParams.Builder
 
build() - Method in class com.lancedb.lance.index.vector.IvfBuildParams.Builder
 
build() - Method in class com.lancedb.lance.index.vector.PQBuildParams.Builder
 
build() - Method in class com.lancedb.lance.index.vector.SQBuildParams.Builder
 
build() - Method in class com.lancedb.lance.index.vector.VectorIndexParams.Builder
 
build() - Method in class com.lancedb.lance.ipc.ColumnOrdering.Builder
 
build() - Method in class com.lancedb.lance.ipc.Query.Builder
Builds the Query object.
build() - Method in class com.lancedb.lance.ipc.ScanOptions.Builder
Build the LanceScanOptions instance.
build() - Method in class com.lancedb.lance.operation.Append.Builder
 
build() - Method in class com.lancedb.lance.operation.DataReplacement.Builder
Build a new DataReplacement.
build() - Method in class com.lancedb.lance.operation.Delete.Builder
 
build() - Method in class com.lancedb.lance.operation.Merge.Builder
 
build() - Method in class com.lancedb.lance.operation.Overwrite.Builder
 
build() - Method in class com.lancedb.lance.operation.Project.Builder
 
build() - Method in class com.lancedb.lance.operation.ReserveFragments.Builder
 
build() - Method in class com.lancedb.lance.operation.Restore.Builder
 
build() - Method in class com.lancedb.lance.operation.Rewrite.Builder
Build a new Rewrite operation.
build() - Method in class com.lancedb.lance.operation.RewriteGroup.Builder
 
build() - Method in class com.lancedb.lance.operation.RewrittenIndex.Builder
 
build() - Method in class com.lancedb.lance.operation.Update.Builder
 
build() - Method in class com.lancedb.lance.operation.UpdateConfig.Builder
 
build() - Method in class com.lancedb.lance.ReadOptions.Builder
 
build() - Method in class com.lancedb.lance.schema.ColumnAlteration.Builder
 
build() - Method in class com.lancedb.lance.schema.SqlExpressions.Builder
 
build() - Method in class com.lancedb.lance.Transaction.Builder
 
build() - Method in class com.lancedb.lance.WriteParams.Builder
 
builder() - Static method in class com.lancedb.lance.index.Index
Create a new builder for Index.
Builder() - Constructor for class com.lancedb.lance.index.IndexParams.Builder
 
Builder() - Constructor for class com.lancedb.lance.index.vector.HnswBuildParams.Builder
Create a new builder for HNSW index parameters.
Builder() - Constructor for class com.lancedb.lance.index.vector.IvfBuildParams.Builder
Parameters for building an IVF index.
Builder() - Constructor for class com.lancedb.lance.index.vector.PQBuildParams.Builder
Create a new builder for training a PQ model.
Builder() - Constructor for class com.lancedb.lance.index.vector.SQBuildParams.Builder
 
Builder(IvfBuildParams) - Constructor for class com.lancedb.lance.index.vector.VectorIndexParams.Builder
Create a new builder to create a vector index.
Builder() - Constructor for class com.lancedb.lance.ipc.ColumnOrdering.Builder
 
Builder() - Constructor for class com.lancedb.lance.ipc.Query.Builder
 
Builder() - Constructor for class com.lancedb.lance.ipc.ScanOptions.Builder
 
Builder(ScanOptions) - Constructor for class com.lancedb.lance.ipc.ScanOptions.Builder
Create a builder from another scan options.
builder() - Static method in class com.lancedb.lance.operation.Append
 
Builder() - Constructor for class com.lancedb.lance.operation.Append.Builder
 
builder() - Static method in class com.lancedb.lance.operation.DataReplacement
Create a new builder for DataReplacement.
Builder() - Constructor for class com.lancedb.lance.operation.DataReplacement.Builder
 
builder() - Static method in class com.lancedb.lance.operation.Delete
 
builder() - Static method in class com.lancedb.lance.operation.Merge
 
builder() - Static method in class com.lancedb.lance.operation.Overwrite
 
builder() - Static method in class com.lancedb.lance.operation.Project
 
Builder() - Constructor for class com.lancedb.lance.operation.Project.Builder
 
builder() - Static method in class com.lancedb.lance.operation.ReserveFragments
 
Builder() - Constructor for class com.lancedb.lance.operation.ReserveFragments.Builder
 
builder() - Static method in class com.lancedb.lance.operation.Restore
 
Builder() - Constructor for class com.lancedb.lance.operation.Restore.Builder
 
builder() - Static method in class com.lancedb.lance.operation.Rewrite
Create a new builder for Rewrite.
builder() - Static method in class com.lancedb.lance.operation.RewriteGroup
 
builder() - Static method in class com.lancedb.lance.operation.RewrittenIndex
 
builder() - Static method in class com.lancedb.lance.operation.Update
 
builder() - Static method in class com.lancedb.lance.operation.UpdateConfig
 
Builder() - Constructor for class com.lancedb.lance.operation.UpdateConfig.Builder
 
Builder() - Constructor for class com.lancedb.lance.ReadOptions.Builder
 
Builder(String) - Constructor for class com.lancedb.lance.schema.ColumnAlteration.Builder
 
Builder() - Constructor for class com.lancedb.lance.schema.SqlExpressions.Builder
 
Builder(Dataset) - Constructor for class com.lancedb.lance.Transaction.Builder
 
Builder() - Constructor for class com.lancedb.lance.WriteParams.Builder
 

C

calculateDataSize() - Method in class com.lancedb.lance.Dataset
Calculate the size of the dataset.
castTo(ArrowType) - Method in class com.lancedb.lance.schema.ColumnAlteration.Builder
 
checkoutLatest() - Method in class com.lancedb.lance.Dataset
Checkout the dataset to the latest version.
checkoutTag(String) - Method in class com.lancedb.lance.Dataset
Checks out a specific tag of the dataset.
checkoutVersion(long) - Method in class com.lancedb.lance.Dataset
Checks out a specific version of the dataset.
close() - Method in class com.lancedb.lance.Dataset
Closes this dataset and releases any system resources associated with it.
close() - Method in class com.lancedb.lance.file.LanceFileReader
Close the LanceFileReader
close() - Method in class com.lancedb.lance.file.LanceFileWriter
Close the LanceFileWriter
close() - Method in class com.lancedb.lance.ipc.LanceScanner
Closes this scanner and releases any system resources associated with it.
close() - Method in class com.lancedb.lance.LockManager.ReadLock
 
close() - Method in class com.lancedb.lance.LockManager.WriteLock
 
closed() - Method in class com.lancedb.lance.Dataset
Checks if the dataset is closed.
ColumnAlteration - Class in com.lancedb.lance.schema
Column alteration used to alter dataset columns.
ColumnAlteration.Builder - Class in com.lancedb.lance.schema
 
ColumnOrdering - Class in com.lancedb.lance.ipc
 
ColumnOrdering.Builder - Class in com.lancedb.lance.ipc
 
columns(List<String>) - Method in class com.lancedb.lance.ipc.ScanOptions.Builder
Set the columns.
com.lancedb.lance - package com.lancedb.lance
 
com.lancedb.lance.file - package com.lancedb.lance.file
 
com.lancedb.lance.fragment - package com.lancedb.lance.fragment
 
com.lancedb.lance.index - package com.lancedb.lance.index
 
com.lancedb.lance.index.vector - package com.lancedb.lance.index.vector
 
com.lancedb.lance.ipc - package com.lancedb.lance.ipc
 
com.lancedb.lance.operation - package com.lancedb.lance.operation
 
com.lancedb.lance.schema - package com.lancedb.lance.schema
 
com.lancedb.lance.test - package com.lancedb.lance.test
 
com.lancedb.lance.util - package com.lancedb.lance.util
 
commit(BufferAllocator, String, FragmentOperation, Optional<Long>) - Static method in class com.lancedb.lance.Dataset
Deprecated.
commit(BufferAllocator, String, FragmentOperation, Optional<Long>, Map<String, String>) - Static method in class com.lancedb.lance.Dataset
Deprecated.
commit(BufferAllocator, String, Optional<Long>, Map<String, String>) - Method in class com.lancedb.lance.FragmentOperation.Append
Deprecated.
 
commit(BufferAllocator, String, Optional<Long>, Map<String, String>) - Method in class com.lancedb.lance.FragmentOperation
Deprecated.
 
commit(BufferAllocator, String, Optional<Long>, Map<String, String>) - Method in class com.lancedb.lance.FragmentOperation.Overwrite
Deprecated.
 
commit() - Method in class com.lancedb.lance.Transaction
 
commitAppend(String, Optional<Long>, List<FragmentMetadata>, Map<String, String>) - Static method in class com.lancedb.lance.Dataset
Deprecated.
commitOverwrite(String, long, Optional<Long>, List<FragmentMetadata>, Map<String, String>) - Static method in class com.lancedb.lance.Dataset
Deprecated.
commitTransaction(Transaction) - Method in class com.lancedb.lance.Dataset
Commit a single transaction and return a new Dataset with the new version.
configUpsertValues(Map<String, String>) - Method in class com.lancedb.lance.operation.Overwrite.Builder
 
configUpsertValues() - Method in class com.lancedb.lance.operation.Overwrite
 
convert(Optional<String[]>) - Static method in class com.lancedb.lance.Utils
Convert optional array to optional list for JNI processing.
countRows() - Method in class com.lancedb.lance.Dataset
Count the number of rows in the dataset.
countRows(String) - Method in class com.lancedb.lance.Dataset
Count the number of rows in the dataset.
countRows() - Method in class com.lancedb.lance.Fragment
 
countRows() - Method in class com.lancedb.lance.ipc.LanceScanner
Scan and return the number of matching rows (fulfill the given scan options).
create(BufferAllocator, String, Schema, WriteParams) - Static method in class com.lancedb.lance.Dataset
Creates an empty dataset.
create(BufferAllocator, ArrowArrayStream, String, WriteParams) - Static method in class com.lancedb.lance.Dataset
Create a dataset with given stream.
create(String, long) - Method in class com.lancedb.lance.Dataset.Tags
Create a new tag for this dataset.
create(String, BufferAllocator, VectorSchemaRoot, WriteParams) - Static method in class com.lancedb.lance.Fragment
Create a fragment from the given data.
create(String, ArrowArrayStream, WriteParams) - Static method in class com.lancedb.lance.Fragment
Create a fragment from the given arrow stream.
create(Dataset, ScanOptions, BufferAllocator) - Static method in class com.lancedb.lance.ipc.LanceScanner
Create a Scanner.
createdAt(Instant) - Method in class com.lancedb.lance.index.Index.Builder
 
createdAt() - Method in class com.lancedb.lance.index.Index
Get the creation time of the index.
createIndex(List<String>, IndexType, Optional<String>, IndexParams, boolean) - Method in class com.lancedb.lance.Dataset
Creates a new index on the dataset.

D

DataFile - Class in com.lancedb.lance.fragment
 
DataFile(String, int[], int[], int, int, Long, Integer) - Constructor for class com.lancedb.lance.fragment.DataFile
 
DataReplacement - Class in com.lancedb.lance.operation
Replace data in a column in the dataset with new data.
DataReplacement.Builder - Class in com.lancedb.lance.operation
Builder for DataReplacement.
DataReplacement.DataReplacementGroup - Class in com.lancedb.lance.operation
A group of data replacement, containing a fragment ID and a new data file.
DataReplacementGroup(long, DataFile) - Constructor for class com.lancedb.lance.operation.DataReplacement.DataReplacementGroup
Create a new DataReplacementGroup.
Dataset - Class in com.lancedb.lance
Class representing a Lance dataset, interfacing with the native lance library.
Dataset.Tags - Class in com.lancedb.lance
Tag operations of the dataset.
datasetVersion(long) - Method in class com.lancedb.lance.index.Index.Builder
 
datasetVersion() - Method in class com.lancedb.lance.index.Index
The latest version of the dataset this index covers
DataStatistics - Class in com.lancedb.lance.ipc
 
DataStatistics() - Constructor for class com.lancedb.lance.ipc.DataStatistics
 
delete(String) - Method in class com.lancedb.lance.Dataset
Delete rows of data by predicate.
delete(String) - Method in class com.lancedb.lance.Dataset.Tags
Delete a tag from this dataset.
Delete - Class in com.lancedb.lance.operation
 
Delete.Builder - Class in com.lancedb.lance.operation
 
deleteConfigKeys(Set<String>) - Method in class com.lancedb.lance.Dataset
Delete the config keys of the dataset.
deletedFragmentIds(List<Long>) - Method in class com.lancedb.lance.operation.Delete.Builder
 
deletedFragmentIds() - Method in class com.lancedb.lance.operation.Delete
 
deleteKeys(List<String>) - Method in class com.lancedb.lance.operation.UpdateConfig.Builder
 
deleteKeys() - Method in class com.lancedb.lance.operation.UpdateConfig
 
deleteRows(List<Integer>) - Method in class com.lancedb.lance.Fragment
Delete rows by row indexes.
DeletionFile - Class in com.lancedb.lance.fragment
 
DeletionFile(long, long, Long, DeletionFileType, Integer) - Constructor for class com.lancedb.lance.fragment.DeletionFile
 
DeletionFileType - Enum in com.lancedb.lance.fragment
 
DistanceType - Enum in com.lancedb.lance.index
 
drop(String, Map<String, String>) - Static method in class com.lancedb.lance.Dataset
Drop a Dataset.
dropColumns(List<String>) - Method in class com.lancedb.lance.Dataset
Drop columns from the dataset.

E

ensureLoaded() - Static method in class com.lancedb.lance.JniLoader
Ensures the native library is loaded.
equals(Object) - Method in class com.lancedb.lance.fragment.DataFile
 
equals(Object) - Method in class com.lancedb.lance.fragment.DeletionFile
 
equals(Object) - Method in class com.lancedb.lance.fragment.RowIdMeta
 
equals(Object) - Method in class com.lancedb.lance.FragmentMetadata
 
equals(Object) - Method in class com.lancedb.lance.index.Index
 
equals(Object) - Method in class com.lancedb.lance.operation.Append
 
equals(Object) - Method in class com.lancedb.lance.operation.DataReplacement.DataReplacementGroup
 
equals(Object) - Method in class com.lancedb.lance.operation.DataReplacement
 
equals(Object) - Method in class com.lancedb.lance.operation.Delete
 
equals(Object) - Method in class com.lancedb.lance.operation.Merge
 
equals(Object) - Method in class com.lancedb.lance.operation.Overwrite
 
equals(Object) - Method in class com.lancedb.lance.operation.ReserveFragments
 
equals(Object) - Method in class com.lancedb.lance.operation.Restore
 
equals(Object) - Method in class com.lancedb.lance.operation.Rewrite
 
equals(Object) - Method in class com.lancedb.lance.operation.RewriteGroup
 
equals(Object) - Method in class com.lancedb.lance.operation.RewrittenIndex
 
equals(Object) - Method in class com.lancedb.lance.operation.SchemaOperation
 
equals(Object) - Method in class com.lancedb.lance.operation.Update
 
equals(Object) - Method in class com.lancedb.lance.Tag
 
equals(Object) - Method in class com.lancedb.lance.Transaction
 
equals(Object) - Method in class com.lancedb.lance.Version
 
exportSchema(BufferAllocator) - Method in class com.lancedb.lance.operation.SchemaOperation
Export the schema to rust jni.

F

fieldMetadata(Map<Integer, Map<String, String>>) - Method in class com.lancedb.lance.operation.UpdateConfig.Builder
 
fieldMetadata() - Method in class com.lancedb.lance.operation.UpdateConfig
 
fields(List<Integer>) - Method in class com.lancedb.lance.index.Index.Builder
 
fields() - Method in class com.lancedb.lance.index.Index
Get the field id list included in the index.
fields() - Method in class com.lancedb.lance.schema.LanceSchema
 
FieldStatistics - Class in com.lancedb.lance.ipc
 
FieldStatistics(int, long) - Constructor for class com.lancedb.lance.ipc.FieldStatistics
 
filter(String) - Method in class com.lancedb.lance.ipc.ScanOptions.Builder
Set the filter.
Fragment - Class in com.lancedb.lance
Fragment operations.
Fragment(Dataset, int) - Constructor for class com.lancedb.lance.Fragment
 
Fragment(Dataset, FragmentMetadata) - Constructor for class com.lancedb.lance.Fragment
 
fragmentBitmap(byte[]) - Method in class com.lancedb.lance.index.Index.Builder
 
fragmentBitmap() - Method in class com.lancedb.lance.index.Index
 
fragmentId() - Method in class com.lancedb.lance.operation.DataReplacement.DataReplacementGroup
Get the fragment ID.
fragmentIds(List<Integer>) - Method in class com.lancedb.lance.ipc.ScanOptions.Builder
Set the fragment ids.
FragmentMetadata - Class in com.lancedb.lance
Metadata of a Fragment in the dataset.
FragmentMetadata(int, List<DataFile>, Long, DeletionFile, RowIdMeta) - Constructor for class com.lancedb.lance.FragmentMetadata
 
FragmentOperation - Class in com.lancedb.lance
Deprecated.
FragmentOperation() - Constructor for class com.lancedb.lance.FragmentOperation
Deprecated.
 
FragmentOperation.Append - Class in com.lancedb.lance
Deprecated.
Fragment append operation.
FragmentOperation.Overwrite - Class in com.lancedb.lance
Deprecated.
Fragment overwrite operation.
fragments(List<FragmentMetadata>) - Method in class com.lancedb.lance.operation.Append.Builder
 
fragments() - Method in class com.lancedb.lance.operation.Append
 
fragments(List<FragmentMetadata>) - Method in class com.lancedb.lance.operation.Merge.Builder
 
fragments() - Method in class com.lancedb.lance.operation.Merge
 
fragments(List<FragmentMetadata>) - Method in class com.lancedb.lance.operation.Overwrite.Builder
 
fragments() - Method in class com.lancedb.lance.operation.Overwrite
 
fragReuseIndex(Index) - Method in class com.lancedb.lance.operation.Rewrite.Builder
Set the fragment reuse index.
fragReuseIndex() - Method in class com.lancedb.lance.operation.Rewrite
Get the fragment reuse index.

G

getBaseId() - Method in class com.lancedb.lance.fragment.DataFile
 
getBaseId() - Method in class com.lancedb.lance.fragment.DeletionFile
 
getBatchReadahead() - Method in class com.lancedb.lance.ipc.ScanOptions
Get the batch readahead.
getBatchSize() - Method in class com.lancedb.lance.ipc.ScanOptions
Get the batch size.
getBlockSize() - Method in class com.lancedb.lance.ReadOptions
 
getChildren() - Method in class com.lancedb.lance.schema.LanceField
 
getColumn() - Method in class com.lancedb.lance.ipc.Query
 
getColumnIndices() - Method in class com.lancedb.lance.fragment.DataFile
 
getColumnName() - Method in class com.lancedb.lance.ipc.ColumnOrdering
 
getColumnOrderings() - Method in class com.lancedb.lance.ipc.ScanOptions
 
getColumns() - Method in class com.lancedb.lance.ipc.ScanOptions
Get the columns.
getConfig() - Method in class com.lancedb.lance.Dataset
Get the table config of the dataset.
getDataSize() - Method in class com.lancedb.lance.ipc.DataStatistics
 
getDataSize() - Method in class com.lancedb.lance.ipc.FieldStatistics
 
getDataTime() - Method in class com.lancedb.lance.Version
 
getDataType() - Method in class com.lancedb.lance.schema.ColumnAlteration
 
getDeletionFile() - Method in class com.lancedb.lance.FragmentMetadata
 
getDictionaryEncoding() - Method in class com.lancedb.lance.schema.LanceField
 
getDistanceType() - Method in class com.lancedb.lance.index.IndexParams
 
getDistanceType() - Method in class com.lancedb.lance.index.vector.VectorIndexParams
 
getDistanceType() - Method in class com.lancedb.lance.ipc.Query
 
getEf() - Method in class com.lancedb.lance.ipc.Query
 
getEfConstruction() - Method in class com.lancedb.lance.index.vector.HnswBuildParams
 
getEnd() - Method in class com.lancedb.lance.util.Range
 
getExpression() - Method in class com.lancedb.lance.schema.SqlExpressions.SqlExpression
 
getFields() - Method in class com.lancedb.lance.fragment.DataFile
 
getFields() - Method in class com.lancedb.lance.ipc.DataStatistics
 
getFileMajorVersion() - Method in class com.lancedb.lance.fragment.DataFile
 
getFileMinorVersion() - Method in class com.lancedb.lance.fragment.DataFile
 
getFiles() - Method in class com.lancedb.lance.FragmentMetadata
 
getFileSizeBytes() - Method in class com.lancedb.lance.fragment.DataFile
 
getFileType() - Method in class com.lancedb.lance.fragment.DeletionFile
 
getFilter() - Method in class com.lancedb.lance.ipc.ScanOptions
Get the filter.
getFragment(int) - Method in class com.lancedb.lance.Dataset
 
getFragmentIds() - Method in class com.lancedb.lance.ipc.ScanOptions
Get the fragment ids.
getFragments() - Method in class com.lancedb.lance.Dataset
Get all fragments in this dataset.
getHnswParams() - Method in class com.lancedb.lance.index.vector.VectorIndexParams
 
getId() - Method in class com.lancedb.lance.fragment.DeletionFile
 
getId() - Method in class com.lancedb.lance.Fragment
 
getId() - Method in class com.lancedb.lance.FragmentMetadata
 
getId() - Method in class com.lancedb.lance.ipc.FieldStatistics
 
getId() - Method in class com.lancedb.lance.schema.LanceField
 
getId() - Method in class com.lancedb.lance.Version
 
getIndexCacheSizeBytes() - Method in class com.lancedb.lance.ReadOptions
 
getIvfParams() - Method in class com.lancedb.lance.index.vector.VectorIndexParams
 
getK() - Method in class com.lancedb.lance.ipc.Query
 
getKey() - Method in class com.lancedb.lance.ipc.Query
 
getKmeansRedos() - Method in class com.lancedb.lance.index.vector.PQBuildParams
 
getLanceSchema() - Method in class com.lancedb.lance.Dataset
Get the LanceSchema of the dataset with field ids.
getLimit() - Method in class com.lancedb.lance.ipc.ScanOptions
Get the limit.
getM() - Method in class com.lancedb.lance.index.vector.HnswBuildParams
 
getManifestSize() - Method in class com.lancedb.lance.Tag
 
getMaxBytesPerFile() - Method in class com.lancedb.lance.WriteParams
 
getMaximumNprobes() - Method in class com.lancedb.lance.ipc.Query
 
getMaxIters() - Method in class com.lancedb.lance.index.vector.IvfBuildParams
 
getMaxIters() - Method in class com.lancedb.lance.index.vector.PQBuildParams
 
getMaxLevel() - Method in class com.lancedb.lance.index.vector.HnswBuildParams
 
getMaxRowsPerFile() - Method in class com.lancedb.lance.WriteParams
 
getMaxRowsPerGroup() - Method in class com.lancedb.lance.WriteParams
 
getMetadata() - Method in class com.lancedb.lance.fragment.RowIdMeta
 
getMetadata() - Method in class com.lancedb.lance.schema.LanceField
 
getMetadata() - Method in class com.lancedb.lance.Version
 
getMetadataCacheSizeBytes() - Method in class com.lancedb.lance.ReadOptions
 
getMinimumNprobes() - Method in class com.lancedb.lance.ipc.Query
 
getMode() - Method in class com.lancedb.lance.WriteParams
Get Mode with name.
getName() - Method in class com.lancedb.lance.schema.LanceField
 
getName() - Method in class com.lancedb.lance.schema.SqlExpressions.SqlExpression
 
getName() - Method in class com.lancedb.lance.Tag
 
getNearest() - Method in class com.lancedb.lance.ipc.ScanOptions
Get the nearest neighbor query.
getNewFragments() - Method in class com.lancedb.lance.operation.RewriteGroup
 
getNewId() - Method in class com.lancedb.lance.operation.RewrittenIndex
 
getNewIndexDetailsTypeUrl() - Method in class com.lancedb.lance.operation.RewrittenIndex
 
getNewIndexDetailsValue() - Method in class com.lancedb.lance.operation.RewrittenIndex
 
getNewIndexVersion() - Method in class com.lancedb.lance.operation.RewrittenIndex
 
getNullable() - Method in class com.lancedb.lance.schema.ColumnAlteration
 
getNumBits() - Method in class com.lancedb.lance.index.vector.PQBuildParams
 
getNumBits() - Method in class com.lancedb.lance.index.vector.SQBuildParams
 
getNumDeletedRows() - Method in class com.lancedb.lance.fragment.DeletionFile
 
getNumDeletions() - Method in class com.lancedb.lance.FragmentMetadata
 
getNumPartitions() - Method in class com.lancedb.lance.index.vector.IvfBuildParams
 
getNumRows() - Method in class com.lancedb.lance.FragmentMetadata
 
getNumSubVectors() - Method in class com.lancedb.lance.index.vector.PQBuildParams
 
getOffset() - Method in class com.lancedb.lance.ipc.ScanOptions
Get the offset.
getOldFragments() - Method in class com.lancedb.lance.operation.RewriteGroup
 
getOldId() - Method in class com.lancedb.lance.operation.RewrittenIndex
 
getParentId() - Method in class com.lancedb.lance.schema.LanceField
 
getPath() - Method in class com.lancedb.lance.fragment.DataFile
 
getPath() - Method in class com.lancedb.lance.schema.ColumnAlteration
 
getPhysicalRows() - Method in class com.lancedb.lance.FragmentMetadata
 
getPqParams() - Method in class com.lancedb.lance.index.vector.VectorIndexParams
 
getPrefetchDistance() - Method in class com.lancedb.lance.index.vector.HnswBuildParams
 
getReadVersion() - Method in class com.lancedb.lance.fragment.DeletionFile
 
getRefineFactor() - Method in class com.lancedb.lance.ipc.Query
 
getRename() - Method in class com.lancedb.lance.schema.ColumnAlteration
 
getRowIdMeta() - Method in class com.lancedb.lance.FragmentMetadata
 
getSampleRate() - Method in class com.lancedb.lance.index.vector.IvfBuildParams
 
getSampleRate() - Method in class com.lancedb.lance.index.vector.PQBuildParams
 
getSampleRate() - Method in class com.lancedb.lance.index.vector.SQBuildParams
 
getSchema() - Method in class com.lancedb.lance.Dataset
Gets the arrow schema of the dataset.
getShufflePartitionBatches() - Method in class com.lancedb.lance.index.vector.IvfBuildParams
 
getShufflePartitionConcurrency() - Method in class com.lancedb.lance.index.vector.IvfBuildParams
 
getSqlExpressions() - Method in class com.lancedb.lance.schema.SqlExpressions
 
getSqParams() - Method in class com.lancedb.lance.index.vector.VectorIndexParams
 
getStart() - Method in class com.lancedb.lance.util.Range
 
getStorageOptions() - Method in class com.lancedb.lance.ReadOptions
 
getStorageOptions() - Method in class com.lancedb.lance.WriteParams
 
getStorageType() - Method in class com.lancedb.lance.schema.LanceField
 
getSubstraitFilter() - Method in class com.lancedb.lance.ipc.ScanOptions
Get the substrait filter.
getType() - Method in class com.lancedb.lance.schema.LanceField
 
getValue() - Method in enum com.lancedb.lance.index.IndexType
 
getVectorIndexParams() - Method in class com.lancedb.lance.index.IndexParams
 
getVersion() - Method in class com.lancedb.lance.Dataset
Gets the currently checked out version of the dataset.
getVersion(String) - Method in class com.lancedb.lance.Dataset.Tags
Get the version of a tag in the dataset.
getVersion() - Method in class com.lancedb.lance.ReadOptions
 
getVersion() - Method in class com.lancedb.lance.Tag
 
groups(List<RewriteGroup>) - Method in class com.lancedb.lance.operation.Rewrite.Builder
Set the rewrite groups.
groups() - Method in class com.lancedb.lance.operation.Rewrite
Get the rewrite groups.

H

hashCode() - Method in class com.lancedb.lance.index.Index
 
hashCode() - Method in class com.lancedb.lance.operation.DataReplacement.DataReplacementGroup
 
hashCode() - Method in class com.lancedb.lance.operation.Merge
 
hashCode() - Method in class com.lancedb.lance.operation.Rewrite
 
hashCode() - Method in class com.lancedb.lance.operation.RewriteGroup
 
hashCode() - Method in class com.lancedb.lance.operation.RewrittenIndex
 
hashCode() - Method in class com.lancedb.lance.Tag
 
hashCode() - Method in class com.lancedb.lance.Version
 
HnswBuildParams - Class in com.lancedb.lance.index.vector
Parameters for building an HNSW index in each IVF partition.
HnswBuildParams.Builder - Class in com.lancedb.lance.index.vector
 

I

Index - Class in com.lancedb.lance.index
Metadata for an index in the dataset.
Index.Builder - Class in com.lancedb.lance.index
 
indexDetails(byte[]) - Method in class com.lancedb.lance.index.Index.Builder
 
indexDetails() - Method in class com.lancedb.lance.index.Index
 
IndexParams - Class in com.lancedb.lance.index
Parameters for creating an index.
IndexParams.Builder - Class in com.lancedb.lance.index
 
IndexType - Enum in com.lancedb.lance.index
 
indexVersion(int) - Method in class com.lancedb.lance.index.Index.Builder
 
indexVersion() - Method in class com.lancedb.lance.index.Index
Get the index version.
intoBatchRecords() - Method in class com.lancedb.lance.SqlQuery
 
isAscending() - Method in class com.lancedb.lance.ipc.ColumnOrdering
 
isNullable() - Method in class com.lancedb.lance.schema.LanceField
 
isNullFirst() - Method in class com.lancedb.lance.ipc.ColumnOrdering
 
isUnenforcedPrimaryKey() - Method in class com.lancedb.lance.schema.LanceField
 
isUseIndex() - Method in class com.lancedb.lance.ipc.Query
 
isWithRowAddress() - Method in class com.lancedb.lance.ipc.ScanOptions
Get whether to include the row address.
isWithRowId() - Method in class com.lancedb.lance.ipc.ScanOptions
Get whether to include the row ID.
IvfBuildParams - Class in com.lancedb.lance.index.vector
Parameters for building an IVF index.
IvfBuildParams.Builder - Class in com.lancedb.lance.index.vector
 
ivfFlat(int, DistanceType) - Static method in class com.lancedb.lance.index.vector.VectorIndexParams
Create a new IVF index with flat quantizer.
ivfPq(int, int, int, DistanceType, int) - Static method in class com.lancedb.lance.index.vector.VectorIndexParams
Create a new IVF index with PQ quantizer.

J

JniLoader - Class in com.lancedb.lance
Utility class to load the native library.
JniTestHelper - Class in com.lancedb.lance.test
Used by the JNI test to test the JNI FFI functionality.
JniTestHelper() - Constructor for class com.lancedb.lance.test.JniTestHelper
 

L

LanceField - Class in com.lancedb.lance.schema
 
LanceFileReader - Class in com.lancedb.lance.file
 
LanceFileWriter - Class in com.lancedb.lance.file
 
LanceScanner - Class in com.lancedb.lance.ipc
Scanner over a Fragment.
LanceSchema - Class in com.lancedb.lance.schema
 
latestVersion() - Method in class com.lancedb.lance.Dataset
 
limit(long) - Method in class com.lancedb.lance.ipc.ScanOptions.Builder
Set the limit.
list() - Method in class com.lancedb.lance.Dataset.Tags
List all tags of the dataset.
listIndexes() - Method in class com.lancedb.lance.Dataset
 
listVersions() - Method in class com.lancedb.lance.Dataset
Get the version history of the dataset.
LockManager - Class in com.lancedb.lance
The LockManager class provides a way to manage read and write locks.
LockManager() - Constructor for class com.lancedb.lance.LockManager
 
LockManager.ReadLock - Class in com.lancedb.lance
Represents a read lock for the LockManager.
LockManager.WriteLock - Class in com.lancedb.lance
Represents a write lock that can be acquired and released.

M

Merge - Class in com.lancedb.lance.operation
Merge operation that combines new fragments with a specific schema.
Merge(List<FragmentMetadata>, Schema) - Constructor for class com.lancedb.lance.operation.Merge
 
Merge.Builder - Class in com.lancedb.lance.operation
 
metadata() - Method in class com.lancedb.lance.Fragment
 
metadata() - Method in class com.lancedb.lance.schema.LanceSchema
 

N

name(String) - Method in class com.lancedb.lance.index.Index.Builder
 
name() - Method in class com.lancedb.lance.index.Index
Human readable index name
name() - Method in class com.lancedb.lance.operation.Append
 
name() - Method in class com.lancedb.lance.operation.DataReplacement
 
name() - Method in class com.lancedb.lance.operation.Delete
 
name() - Method in class com.lancedb.lance.operation.Merge
 
name() - Method in interface com.lancedb.lance.operation.Operation
We use this name to align with the Rust operation enum underlying in JNI.
name() - Method in class com.lancedb.lance.operation.Overwrite
 
name() - Method in class com.lancedb.lance.operation.Project
 
name() - Method in class com.lancedb.lance.operation.ReserveFragments
 
name() - Method in class com.lancedb.lance.operation.Restore
 
name() - Method in class com.lancedb.lance.operation.Rewrite
 
name() - Method in class com.lancedb.lance.operation.Update
 
name() - Method in class com.lancedb.lance.operation.UpdateConfig
 
nearest(Query) - Method in class com.lancedb.lance.ipc.ScanOptions.Builder
Set the nearest neighbor query.
newFragments(List<FragmentMetadata>) - Method in class com.lancedb.lance.operation.RewriteGroup.Builder
 
newFragments(List<FragmentMetadata>) - Method in class com.lancedb.lance.operation.Update.Builder
 
newFragments() - Method in class com.lancedb.lance.operation.Update
 
newId(UUID) - Method in class com.lancedb.lance.operation.RewrittenIndex.Builder
 
newIndexDetailsTypeUrl(String) - Method in class com.lancedb.lance.operation.RewrittenIndex.Builder
 
newIndexDetailsValue(byte[]) - Method in class com.lancedb.lance.operation.RewrittenIndex.Builder
 
newIndexVersion(int) - Method in class com.lancedb.lance.operation.RewrittenIndex.Builder
 
newScan() - Method in class com.lancedb.lance.Dataset
Create a new Dataset Scanner.
newScan(long) - Method in class com.lancedb.lance.Dataset
Create a new Dataset Scanner.
newScan(ScanOptions) - Method in class com.lancedb.lance.Dataset
Create a new Dataset Scanner.
newScan() - Method in class com.lancedb.lance.Fragment
Create a new Dataset Scanner.
newScan(long) - Method in class com.lancedb.lance.Fragment
Create a new Dataset Scanner.
newScan(ScanOptions) - Method in class com.lancedb.lance.Fragment
Create a new Dataset Scanner.
newTransactionBuilder() - Method in class com.lancedb.lance.Dataset
Create a new transaction builder at current version for the dataset.
nullable(boolean) - Method in class com.lancedb.lance.schema.ColumnAlteration.Builder
 
numFragments(int) - Method in class com.lancedb.lance.operation.ReserveFragments.Builder
 
numFragments() - Method in class com.lancedb.lance.operation.ReserveFragments
Get the number of fragments to reserve.
numRows() - Method in class com.lancedb.lance.file.LanceFileReader
Get the number of rows in the Lance file

O

of(int, int) - Static method in class com.lancedb.lance.util.Range
 
offset(long) - Method in class com.lancedb.lance.ipc.ScanOptions.Builder
Set the offset.
oldFragments(List<FragmentMetadata>) - Method in class com.lancedb.lance.operation.RewriteGroup.Builder
 
oldId(UUID) - Method in class com.lancedb.lance.operation.RewrittenIndex.Builder
 
open(String) - Static method in class com.lancedb.lance.Dataset
Open a dataset from the specified path.
open(String, ReadOptions) - Static method in class com.lancedb.lance.Dataset
Open a dataset from the specified path.
open(String, BufferAllocator) - Static method in class com.lancedb.lance.Dataset
Open a dataset from the specified path.
open(BufferAllocator, String, ReadOptions) - Static method in class com.lancedb.lance.Dataset
Open a dataset from the specified path with additional options.
open(String, BufferAllocator) - Static method in class com.lancedb.lance.file.LanceFileReader
Open a LanceFileReader from a file URI
open(String, Map<String, String>, BufferAllocator) - Static method in class com.lancedb.lance.file.LanceFileReader
Open a LanceFileReader from a file URI
open(String, BufferAllocator, DictionaryProvider) - Static method in class com.lancedb.lance.file.LanceFileWriter
Open a LanceFileWriter to write to a given file URI
open(String, BufferAllocator, DictionaryProvider, Map<String, String>) - Static method in class com.lancedb.lance.file.LanceFileWriter
Open a LanceFileWriter to write to a given file URI
Operation - Interface in com.lancedb.lance.operation
Operation interface.
operation(Operation) - Method in class com.lancedb.lance.Transaction.Builder
 
operation() - Method in class com.lancedb.lance.Transaction
 
Overwrite(List<FragmentMetadata>, Schema) - Constructor for class com.lancedb.lance.FragmentOperation.Overwrite
Deprecated.
 
Overwrite - Class in com.lancedb.lance.operation
Overwrite the dataset with new fragments.
Overwrite(List<FragmentMetadata>, Schema, Map<String, String>) - Constructor for class com.lancedb.lance.operation.Overwrite
 
Overwrite.Builder - Class in com.lancedb.lance.operation
 

P

parseIndexParams(IndexParams) - Static method in class com.lancedb.lance.test.JniTestHelper
 
parseInts(List<Integer>) - Static method in class com.lancedb.lance.test.JniTestHelper
JNI parse ints test.
parseIntsOpt(Optional<List<Integer>>) - Static method in class com.lancedb.lance.test.JniTestHelper
JNI parse ints opts test.
parseLongs(List<Long>) - Static method in class com.lancedb.lance.test.JniTestHelper
JNI parse longs test.
parseQuery(Optional<Query>) - Static method in class com.lancedb.lance.test.JniTestHelper
JNI parse query test.
PQBuildParams - Class in com.lancedb.lance.index.vector
Train a PQ model for a given column.
PQBuildParams.Builder - Class in com.lancedb.lance.index.vector
 
predicate(String) - Method in class com.lancedb.lance.operation.Delete.Builder
 
predicate() - Method in class com.lancedb.lance.operation.Delete
 
Project - Class in com.lancedb.lance.operation
Project to a new schema.
Project.Builder - Class in com.lancedb.lance.operation
 

Q

Query - Class in com.lancedb.lance.ipc
 
Query.Builder - Class in com.lancedb.lance.ipc
 

R

Range - Class in com.lancedb.lance.util
Define a range with start (include) and end (exclude).
Range(int, int) - Constructor for class com.lancedb.lance.util.Range
 
readAll(List<String>, List<Range>, int) - Method in class com.lancedb.lance.file.LanceFileReader
Read all rows from the Lance file
ReadLock() - Constructor for class com.lancedb.lance.LockManager.ReadLock
Acquires a read lock on the lock manager.
ReadOptions - Class in com.lancedb.lance
Read options for reading from a dataset.
ReadOptions.Builder - Class in com.lancedb.lance
 
readTransaction() - Method in class com.lancedb.lance.Dataset
Get the Transaction of the dataset at the current version.
readVersion(long) - Method in class com.lancedb.lance.Transaction.Builder
 
readVersion() - Method in class com.lancedb.lance.Transaction
 
release() - Method in interface com.lancedb.lance.operation.Operation
Release the underlying JNI resource like arrow c schema
release() - Method in class com.lancedb.lance.operation.SchemaOperation
 
release() - Method in class com.lancedb.lance.Transaction
 
removedFragmentIds(List<Long>) - Method in class com.lancedb.lance.operation.Update.Builder
 
removedFragmentIds() - Method in class com.lancedb.lance.operation.Update
 
rename(String) - Method in class com.lancedb.lance.schema.ColumnAlteration.Builder
 
replacedFile() - Method in class com.lancedb.lance.operation.DataReplacement.DataReplacementGroup
Get the new data file.
replaceFieldMetadata(Map<Integer, Map<String, String>>) - Method in class com.lancedb.lance.Dataset
Replace target field metadata of the dataset.
replacements(List<DataReplacement.DataReplacementGroup>) - Method in class com.lancedb.lance.operation.DataReplacement.Builder
Set the list of data replacement groups.
replacements() - Method in class com.lancedb.lance.operation.DataReplacement
Get the list of data replacement groups.
replaceSchemaMetadata(Map<String, String>) - Method in class com.lancedb.lance.Dataset
Replace the schema metadata of the dataset.
ReserveFragments - Class in com.lancedb.lance.operation
ReserveFragments operation to reserve fragment IDs for future use.
ReserveFragments.Builder - Class in com.lancedb.lance.operation
 
restore() - Method in class com.lancedb.lance.Dataset
Restore the currently checked out version of the dataset as the latest version.
Restore - Class in com.lancedb.lance.operation
Restore operation to revert a dataset to a previous version.
Restore.Builder - Class in com.lancedb.lance.operation
 
Rewrite - Class in com.lancedb.lance.operation
Rewrite operation for reorganizing data without changing content.
Rewrite.Builder - Class in com.lancedb.lance.operation
Builder for Rewrite.
RewriteGroup - Class in com.lancedb.lance.operation
A group of fragments to be rewritten.
RewriteGroup.Builder - Class in com.lancedb.lance.operation
 
RewrittenIndex - Class in com.lancedb.lance.operation
A rewritten index mapping from old index UUID to new index UUID.
RewrittenIndex.Builder - Class in com.lancedb.lance.operation
 
rewrittenIndices(List<RewrittenIndex>) - Method in class com.lancedb.lance.operation.Rewrite.Builder
Set the rewritten indices.
rewrittenIndices() - Method in class com.lancedb.lance.operation.Rewrite
Get the rewritten indices.
RowAddress - Class in com.lancedb.lance
 
RowAddress() - Constructor for class com.lancedb.lance.RowAddress
 
RowIdMeta - Class in com.lancedb.lance.fragment
 
RowIdMeta(String) - Constructor for class com.lancedb.lance.fragment.RowIdMeta
 
rowIndex(long) - Static method in class com.lancedb.lance.RowAddress
 

S

scan() - Method in class com.lancedb.lance.ipc.LanceScanner
 
scanBatches() - Method in class com.lancedb.lance.ipc.LanceScanner
 
ScanOptions - Class in com.lancedb.lance.ipc
Lance scan options.
ScanOptions(Optional<List<Integer>>, Optional<Long>, Optional<List<String>>, Optional<String>, Optional<ByteBuffer>, Optional<Long>, Optional<Long>, Optional<Query>, boolean, boolean, int, Optional<List<ColumnOrdering>>) - Constructor for class com.lancedb.lance.ipc.ScanOptions
Constructor for LanceScanOptions.
ScanOptions.Builder - Class in com.lancedb.lance.ipc
Builder for constructing LanceScanOptions.
schema() - Method in class com.lancedb.lance.file.LanceFileReader
Get the schema of the Lance file
schema() - Method in class com.lancedb.lance.ipc.LanceScanner
 
schema(Schema) - Method in class com.lancedb.lance.operation.Merge.Builder
 
schema(Schema) - Method in class com.lancedb.lance.operation.Overwrite.Builder
 
schema(Schema) - Method in class com.lancedb.lance.operation.Project.Builder
 
schema() - Method in class com.lancedb.lance.operation.SchemaOperation
 
schemaMetadata(Map<String, String>) - Method in class com.lancedb.lance.operation.UpdateConfig.Builder
 
schemaMetadata() - Method in class com.lancedb.lance.operation.UpdateConfig
 
SchemaOperation - Class in com.lancedb.lance.operation
Schema related base operation.
SchemaOperation(Schema) - Constructor for class com.lancedb.lance.operation.SchemaOperation
 
setAscending(boolean) - Method in class com.lancedb.lance.ipc.ColumnOrdering.Builder
 
setBlockSize(int) - Method in class com.lancedb.lance.ReadOptions.Builder
Block size in bytes.
setColumn(String) - Method in class com.lancedb.lance.ipc.Query.Builder
Sets the column to be searched.
setColumnName(String) - Method in class com.lancedb.lance.ipc.ColumnOrdering.Builder
 
setColumnOrderings(List<ColumnOrdering>) - Method in class com.lancedb.lance.ipc.ScanOptions.Builder
 
setDistanceType(DistanceType) - Method in class com.lancedb.lance.index.IndexParams.Builder
Set the distance type for calculating the distance between vectors.
setDistanceType(DistanceType) - Method in class com.lancedb.lance.index.vector.VectorIndexParams.Builder
 
setDistanceType(DistanceType) - Method in class com.lancedb.lance.ipc.Query.Builder
Sets the distance metric type.
setEf(int) - Method in class com.lancedb.lance.ipc.Query.Builder
Sets the number of candidates to reserve while searching.
setEfConstruction(int) - Method in class com.lancedb.lance.index.vector.HnswBuildParams.Builder
 
setExpression(String) - Method in class com.lancedb.lance.schema.SqlExpressions.SqlExpression
 
setHnswParams(HnswBuildParams) - Method in class com.lancedb.lance.index.vector.VectorIndexParams.Builder
 
setIndexCacheSize(int) - Method in class com.lancedb.lance.ReadOptions.Builder
Deprecated.
setIndexCacheSizeBytes(long) - Method in class com.lancedb.lance.ReadOptions.Builder
Index cache size in bytes.
setK(int) - Method in class com.lancedb.lance.ipc.Query.Builder
Sets the number of top results to return.
setKey(float[]) - Method in class com.lancedb.lance.ipc.Query.Builder
Sets the vector to be searched.
setKmeansRedos(int) - Method in class com.lancedb.lance.index.vector.PQBuildParams.Builder
 
setM(int) - Method in class com.lancedb.lance.index.vector.HnswBuildParams.Builder
 
setMaximumNprobes(int) - Method in class com.lancedb.lance.ipc.Query.Builder
Sets the maximum number of partitions to search.
setMaxIters(int) - Method in class com.lancedb.lance.index.vector.IvfBuildParams.Builder
 
setMaxIters(int) - Method in class com.lancedb.lance.index.vector.PQBuildParams.Builder
 
setMaxLevel(short) - Method in class com.lancedb.lance.index.vector.HnswBuildParams.Builder
 
setMetadataCacheSize(int) - Method in class com.lancedb.lance.ReadOptions.Builder
setMetadataCacheSizeBytes(long) - Method in class com.lancedb.lance.ReadOptions.Builder
Size of the metadata cache in bytes.
setMinimumNprobes(int) - Method in class com.lancedb.lance.ipc.Query.Builder
Sets the minimum number of partitions to search.
setName(String) - Method in class com.lancedb.lance.schema.SqlExpressions.SqlExpression
 
setNprobes(int) - Method in class com.lancedb.lance.ipc.Query.Builder
Sets the number of probes to load and search.
setNullFirst(boolean) - Method in class com.lancedb.lance.ipc.ColumnOrdering.Builder
 
setNumBits(int) - Method in class com.lancedb.lance.index.vector.PQBuildParams.Builder
 
setNumBits(short) - Method in class com.lancedb.lance.index.vector.SQBuildParams.Builder
 
setNumPartitions(int) - Method in class com.lancedb.lance.index.vector.IvfBuildParams.Builder
 
setNumSubVectors(int) - Method in class com.lancedb.lance.index.vector.PQBuildParams.Builder
The number of subvectors to divide the source vectors into.
setPqParams(PQBuildParams) - Method in class com.lancedb.lance.index.vector.VectorIndexParams.Builder
 
setPrefetchDistance(Integer) - Method in class com.lancedb.lance.index.vector.HnswBuildParams.Builder
 
setRefineFactor(int) - Method in class com.lancedb.lance.ipc.Query.Builder
Sets the refine factor for applying a refine step.
setSampleRate(int) - Method in class com.lancedb.lance.index.vector.IvfBuildParams.Builder
Set the sample rate for training IVF centroids IVF centroids are trained from a sample of the data (determined by the sample_rate).
setSampleRate(int) - Method in class com.lancedb.lance.index.vector.PQBuildParams.Builder
 
setSampleRate(int) - Method in class com.lancedb.lance.index.vector.SQBuildParams.Builder
 
setShufflePartitionBatches(int) - Method in class com.lancedb.lance.index.vector.IvfBuildParams.Builder
Sets the number of batches, using the row group size of the dataset, to include in each shuffle partition.
setShufflePartitionConcurrency(int) - Method in class com.lancedb.lance.index.vector.IvfBuildParams.Builder
Set the number of shuffle partitions to process concurrently.
setSqParams(SQBuildParams) - Method in class com.lancedb.lance.index.vector.VectorIndexParams.Builder
 
setStorageOptions(Map<String, String>) - Method in class com.lancedb.lance.ReadOptions.Builder
Set storage options.
setUseIndex(boolean) - Method in class com.lancedb.lance.ipc.Query.Builder
Sets whether to use an ANN index if available.
setUseResidual(boolean) - Method in class com.lancedb.lance.index.vector.IvfBuildParams.Builder
Set whether to use residual for k-means clustering.
setVectorIndexParams(VectorIndexParams) - Method in class com.lancedb.lance.index.IndexParams.Builder
Vector index parameters for creating a vector index.
setVersion(int) - Method in class com.lancedb.lance.ReadOptions.Builder
Set the version of the dataset to read.
SQBuildParams - Class in com.lancedb.lance.index.vector
Parameters for using SQ quantizer.
SQBuildParams.Builder - Class in com.lancedb.lance.index.vector
 
sql(String) - Method in class com.lancedb.lance.Dataset
Execute SQL query on the dataset.
SqlExpression() - Constructor for class com.lancedb.lance.schema.SqlExpressions.SqlExpression
 
SqlExpressions - Class in com.lancedb.lance.schema
Represents a list of SQL expressions.
SqlExpressions.Builder - Class in com.lancedb.lance.schema
 
SqlExpressions.SqlExpression - Class in com.lancedb.lance.schema
 
SqlQuery - Class in com.lancedb.lance
 
SqlQuery(Dataset, String) - Constructor for class com.lancedb.lance.SqlQuery
 
StorageType - Enum in com.lancedb.lance.schema
 
substraitFilter(ByteBuffer) - Method in class com.lancedb.lance.ipc.ScanOptions.Builder
Set the substrait filter.

T

tableName(String) - Method in class com.lancedb.lance.SqlQuery
 
Tag - Class in com.lancedb.lance
 
Tag(String, long, int) - Constructor for class com.lancedb.lance.Tag
 
tags() - Method in class com.lancedb.lance.Dataset
Returns a Dataset.Tags instance for performing tag-related operations on the dataset.
Tags() - Constructor for class com.lancedb.lance.Dataset.Tags
 
take(List<Long>, List<String>) - Method in class com.lancedb.lance.Dataset
Select rows of data by index.
toFfi(Schema, BufferAllocator) - Static method in class com.lancedb.lance.Utils
Convert schema to ArrowSchema for JNI processing.
toString() - Method in class com.lancedb.lance.fragment.DataFile
 
toString() - Method in class com.lancedb.lance.fragment.DeletionFile
 
toString() - Method in class com.lancedb.lance.fragment.RowIdMeta
 
toString() - Method in class com.lancedb.lance.FragmentMetadata
 
toString() - Method in class com.lancedb.lance.index.Index
 
toString() - Method in class com.lancedb.lance.index.IndexParams
 
toString() - Method in class com.lancedb.lance.index.vector.HnswBuildParams
 
toString() - Method in class com.lancedb.lance.index.vector.IvfBuildParams
 
toString() - Method in class com.lancedb.lance.index.vector.PQBuildParams
 
toString() - Method in class com.lancedb.lance.index.vector.SQBuildParams
 
toString() - Method in class com.lancedb.lance.index.vector.VectorIndexParams
 
toString() - Method in class com.lancedb.lance.ipc.ColumnOrdering
 
toString() - Method in class com.lancedb.lance.ipc.DataStatistics
 
toString() - Method in class com.lancedb.lance.ipc.FieldStatistics
 
toString() - Method in class com.lancedb.lance.ipc.Query
 
toString() - Method in class com.lancedb.lance.ipc.ScanOptions
 
toString() - Method in class com.lancedb.lance.operation.Append
 
toString() - Method in class com.lancedb.lance.operation.DataReplacement.DataReplacementGroup
 
toString() - Method in class com.lancedb.lance.operation.DataReplacement
 
toString() - Method in class com.lancedb.lance.operation.Delete
 
toString() - Method in class com.lancedb.lance.operation.Merge
 
toString() - Method in class com.lancedb.lance.operation.Overwrite
 
toString() - Method in class com.lancedb.lance.operation.Project
 
toString() - Method in class com.lancedb.lance.operation.ReserveFragments
 
toString() - Method in class com.lancedb.lance.operation.Restore
 
toString() - Method in class com.lancedb.lance.operation.Rewrite
 
toString() - Method in class com.lancedb.lance.operation.RewriteGroup
 
toString() - Method in class com.lancedb.lance.operation.RewrittenIndex
 
toString() - Method in class com.lancedb.lance.operation.Update
 
toString() - Method in class com.lancedb.lance.operation.UpdateConfig
 
toString() - Method in class com.lancedb.lance.ReadOptions
 
toString() - Method in class com.lancedb.lance.schema.LanceField
 
toString() - Method in class com.lancedb.lance.Tag
 
toString() - Method in class com.lancedb.lance.Transaction
 
toString() - Method in class com.lancedb.lance.Version
 
toString() - Method in class com.lancedb.lance.WriteParams
 
Transaction - Class in com.lancedb.lance
Align with the Transaction struct in rust.
Transaction.Builder - Class in com.lancedb.lance
 
transactionProperties(Map<String, String>) - Method in class com.lancedb.lance.Transaction.Builder
 
transactionProperties() - Method in class com.lancedb.lance.Transaction
 

U

update(String, long) - Method in class com.lancedb.lance.Dataset.Tags
Update a tag to a new version for the dataset.
Update - Class in com.lancedb.lance.operation
 
Update.Builder - Class in com.lancedb.lance.operation
 
updateConfig(Map<String, String>) - Method in class com.lancedb.lance.Dataset
Update the config of the dataset.
UpdateConfig - Class in com.lancedb.lance.operation
Update the dataset configuration.
UpdateConfig.Builder - Class in com.lancedb.lance.operation
 
updatedFragments(List<FragmentMetadata>) - Method in class com.lancedb.lance.operation.Delete.Builder
 
updatedFragments() - Method in class com.lancedb.lance.operation.Delete
 
updatedFragments(List<FragmentMetadata>) - Method in class com.lancedb.lance.operation.Update.Builder
 
updatedFragments() - Method in class com.lancedb.lance.operation.Update
 
upsertValues(Map<String, String>) - Method in class com.lancedb.lance.operation.UpdateConfig.Builder
 
upsertValues() - Method in class com.lancedb.lance.operation.UpdateConfig
 
uri() - Method in class com.lancedb.lance.Dataset
Gets the URI of the dataset.
useResidual() - Method in class com.lancedb.lance.index.vector.IvfBuildParams
 
Utils - Class in com.lancedb.lance
Utility.
Utils() - Constructor for class com.lancedb.lance.Utils
 
uuid(UUID) - Method in class com.lancedb.lance.index.Index.Builder
 
uuid() - Method in class com.lancedb.lance.index.Index
 
uuid() - Method in class com.lancedb.lance.Transaction
 

V

validateFragments(List<FragmentMetadata>) - Static method in class com.lancedb.lance.FragmentOperation
Deprecated.
 
valueOf(String) - Static method in enum com.lancedb.lance.fragment.DeletionFileType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.lancedb.lance.index.DistanceType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.lancedb.lance.index.IndexType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.lancedb.lance.schema.StorageType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.lancedb.lance.WriteParams.WriteMode
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.lancedb.lance.fragment.DeletionFileType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.lancedb.lance.index.DistanceType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.lancedb.lance.index.IndexType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.lancedb.lance.schema.StorageType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.lancedb.lance.WriteParams.WriteMode
Returns an array containing the constants of this enum type, in the order they are declared.
VectorIndexParams - Class in com.lancedb.lance.index.vector
Parameters for creating a vector index.
VectorIndexParams.Builder - Class in com.lancedb.lance.index.vector
 
version() - Method in class com.lancedb.lance.Dataset
Get the currently checked out version id of the dataset
version(long) - Method in class com.lancedb.lance.operation.Restore.Builder
 
version() - Method in class com.lancedb.lance.operation.Restore
Get the version to restore to.
Version - Class in com.lancedb.lance
 
Version(long, ZonedDateTime, TreeMap<String, String>) - Constructor for class com.lancedb.lance.Version
 

W

withExpression(String, String) - Method in class com.lancedb.lance.schema.SqlExpressions.Builder
 
withIvfHnswPqParams(DistanceType, IvfBuildParams, HnswBuildParams, PQBuildParams) - Static method in class com.lancedb.lance.index.vector.VectorIndexParams
Create a new IVF HNSW index with PQ quantizer.
withIvfHnswSqParams(DistanceType, IvfBuildParams, HnswBuildParams, SQBuildParams) - Static method in class com.lancedb.lance.index.vector.VectorIndexParams
Create a new IVF HNSW index with SQ quantizer.
withIvfPqParams(DistanceType, IvfBuildParams, PQBuildParams) - Static method in class com.lancedb.lance.index.vector.VectorIndexParams
Create a new IVF index with PQ quantizer.
withMaxBytesPerFile(long) - Method in class com.lancedb.lance.WriteParams.Builder
 
withMaxRowsPerFile(int) - Method in class com.lancedb.lance.WriteParams.Builder
 
withMaxRowsPerGroup(int) - Method in class com.lancedb.lance.WriteParams.Builder
 
withMode(WriteParams.WriteMode) - Method in class com.lancedb.lance.WriteParams.Builder
 
withRowAddr(boolean) - Method in class com.lancedb.lance.SqlQuery
 
withRowAddress(boolean) - Method in class com.lancedb.lance.ipc.ScanOptions.Builder
Set whether to include the row addr.
withRowId(boolean) - Method in class com.lancedb.lance.ipc.ScanOptions.Builder
Set whether to include the row ID.
withRowId(boolean) - Method in class com.lancedb.lance.SqlQuery
 
withStorageOptions(Map<String, String>) - Method in class com.lancedb.lance.WriteParams.Builder
 
write(VectorSchemaRoot) - Method in class com.lancedb.lance.file.LanceFileWriter
Write a batch of data
WriteLock() - Constructor for class com.lancedb.lance.LockManager.WriteLock
Constructs a new WriteLock and acquires the write lock.
writeParams(Map<String, String>) - Method in class com.lancedb.lance.Transaction.Builder
 
writeParams() - Method in class com.lancedb.lance.Transaction
 
WriteParams - Class in com.lancedb.lance
Write Params for Write Operations of Lance.
WriteParams.Builder - Class in com.lancedb.lance
A builder of WriteParams.
WriteParams.WriteMode - Enum in com.lancedb.lance
Write Mode.
A B C D E F G H I J L M N O P Q R S T U V W 
Skip navigation links

Copyright © 2025. All rights reserved.