com.lancedb.lance

Class ReadOptions.Builder

java.lang.Object

com.lancedb.lance.ReadOptions.Builder

Enclosing class:

ReadOptions

public static class ReadOptions.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ReadOptions	build()
ReadOptions.Builder	setBlockSize(int blockSize) Block size in bytes.
ReadOptions.Builder	setIndexCacheSize(int indexCacheSize) Deprecated.
ReadOptions.Builder	setIndexCacheSizeBytes(long indexCacheSizeBytes) Index cache size in bytes.
ReadOptions.Builder	setMetadataCacheSize(int metadataCacheSize) Deprecated. Use setMetadataCacheSizeBytes(long) instead
ReadOptions.Builder	setMetadataCacheSizeBytes(long metadataCacheSizeBytes) Size of the metadata cache in bytes.
ReadOptions.Builder	setS3CredentialsRefreshOffsetSeconds(long s3CredentialsRefreshOffsetSeconds) Set the number of seconds before credential expiration to trigger a refresh.
ReadOptions.Builder	setSerializedManifest(ByteBuffer serializedManifest) Use a serialized manifest instead of loading it from the object store.
ReadOptions.Builder	setStorageOptions(Map<String,String> storageOptions) Set storage options.
ReadOptions.Builder	setStorageOptionsProvider(StorageOptionsProvider storageOptionsProvider) Set a custom storage options provider for automatic storage options refresh.
ReadOptions.Builder	setVersion(int version) Set the version of the dataset to read.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

setVersion

public ReadOptions.Builder setVersion(int version)

Set the version of the dataset to read. If not set, read from latest version.

Parameters:

version - the version of the dataset

Returns:

this builder

setBlockSize

public ReadOptions.Builder setBlockSize(int blockSize)

Block size in bytes. Provide a hint for the size of the minimal I/O request. Recommended to be set to value bigger than 4KB.

Parameters:

blockSize - the block size in bytes

Returns:

this builder

setIndexCacheSizeBytes

public ReadOptions.Builder setIndexCacheSizeBytes(long indexCacheSizeBytes)

Index cache size in bytes. Index cache is a LRU cache with TTL. This number specifies the size of the index cache in bytes. Default is 6 GiB.

Parameters:

indexCacheSizeBytes - the index cache size in bytes

Returns:

this builder

setIndexCacheSize

@Deprecated
public ReadOptions.Builder setIndexCacheSize(int indexCacheSize)

Deprecated.

Index cache size. Index cache is a LRU cache with TTL. This number specifies the number of index pages, for example, IVF partitions, to be cached in the host memory. Roughly, for an IVF_PQ partition with n rows, the size of each index page equals the combination of the pq code (nd.array([n,pq], dtype=uint8)) and the row ids (nd.array([n], dtype=uint64)). Approximately, n = Total Rows / number of IVF partitions. pq = number of PQ sub-vectors. Default is 256.

Parameters:

indexCacheSize - the index cache size

Returns:

this builder

setMetadataCacheSizeBytes

public ReadOptions.Builder setMetadataCacheSizeBytes(long metadataCacheSizeBytes)

Size of the metadata cache in bytes. This cache stores metadata in memory for faster open table and scans. If it is zero, metadata cache is disabled. Default is 1 GiB.

Parameters:

metadataCacheSizeBytes - the metadata cache size in bytes

Returns:

this builder

setMetadataCacheSize

@Deprecated
public ReadOptions.Builder setMetadataCacheSize(int metadataCacheSize)

Deprecated. Use setMetadataCacheSizeBytes(long) instead

Metadata cache size for the fragment metadata. If it is zero, metadata cache is disabled. This method is deprecated. Use setMetadataCacheSizeBytes(long) instead.

Parameters:

metadataCacheSize - the metadata cache size (entry count)

Returns:

this builder

setStorageOptions

public ReadOptions.Builder setStorageOptions(Map<String,String> storageOptions)

Set storage options. Extra options that make sense for a particular storage connection. This is used to store connection parameters like credentials, endpoint, etc.

Parameters:

storageOptions - the storage options

Returns:

this builder

setSerializedManifest

public ReadOptions.Builder setSerializedManifest(ByteBuffer serializedManifest)

Use a serialized manifest instead of loading it from the object store. This is common when transferring a dataset across IPC boundaries.

Parameters:

serializedManifest - the serialized manifest as a ByteBuffer

Returns:

this builder

setStorageOptionsProvider

public ReadOptions.Builder setStorageOptionsProvider(StorageOptionsProvider storageOptionsProvider)

Set a custom storage options provider for automatic storage options refresh.

The storage options provider will be called automatically before storage options expire, enabling long-running operations on cloud storage without interruption. This is currently only used for refreshing AWS temporary access credentials.

Parameters:

storageOptionsProvider - the storage options provider implementation

Returns:

this builder

setS3CredentialsRefreshOffsetSeconds

public ReadOptions.Builder setS3CredentialsRefreshOffsetSeconds(long s3CredentialsRefreshOffsetSeconds)

Set the number of seconds before credential expiration to trigger a refresh.

Default is 60 seconds. Only applicable when using AWS S3 with temporary credentials. For example, if set to 60, credentials will be refreshed when they have less than 60 seconds remaining before expiration. This should be set shorter than the credential lifetime to avoid using expired credentials.

Parameters:

s3CredentialsRefreshOffsetSeconds - the refresh offset in seconds

Returns:

this builder

build

public ReadOptions build()