com.lancedb.lance.ipc

Class ScanOptions.Builder

java.lang.Object

com.lancedb.lance.ipc.ScanOptions.Builder

Enclosing class:

ScanOptions

public static class ScanOptions.Builder
extends Object

Builder for constructing LanceScanOptions.

Constructor Summary

Constructors

Constructor and Description
Builder()
Builder(ScanOptions options) Create a builder from another scan options.

Method Summary

Modifier and Type	Method and Description
ScanOptions.Builder	batchReadahead(int batchReadahead) Set the batch readahead.
ScanOptions.Builder	batchSize(long batchSize) Set the batch size.
ScanOptions	build() Build the LanceScanOptions instance.
ScanOptions.Builder	columns(List<String> columns) Set the columns.
ScanOptions.Builder	filter(String filter) Set the filter.
ScanOptions.Builder	fragmentIds(List<Integer> fragmentIds) Set the fragment ids.
ScanOptions.Builder	limit(long limit) Set the limit.
ScanOptions.Builder	nearest(Query nearest) Set the nearest neighbor query.
ScanOptions.Builder	offset(long offset) Set the offset.
ScanOptions.Builder	setColumnOrderings(List<ColumnOrdering> columnOrderings)
ScanOptions.Builder	substraitFilter(ByteBuffer substraitFilter) Set the substrait filter.
ScanOptions.Builder	withRowAddress(boolean withRowAddress) Set whether to include the row addr.
ScanOptions.Builder	withRowId(boolean withRowId) Set whether to include the row ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Builder

public Builder(ScanOptions options)

Create a builder from another scan options.

Parameters:

options - another scan options

Method Detail

fragmentIds

public ScanOptions.Builder fragmentIds(List<Integer> fragmentIds)

Set the fragment ids.

Parameters:

fragmentIds - the id of the fragments to scan

Returns:

Builder instance for method chaining.

batchSize

public ScanOptions.Builder batchSize(long batchSize)

Set the batch size.

Parameters:

batchSize - Maximum row number of each returned ArrowRecordBatch.

Returns:

Builder instance for method chaining.

columns

public ScanOptions.Builder columns(List<String> columns)

Set the columns.

Parameters:

columns - Projected columns.

Returns:

Builder instance for method chaining.

filter

public ScanOptions.Builder filter(String filter)

Set the filter.

Parameters:

filter - Filter expression.

Returns:

Builder instance for method chaining.

substraitFilter

public ScanOptions.Builder substraitFilter(ByteBuffer substraitFilter)

Set the substrait filter.

Parameters:

substraitFilter - Substrait filter expression.

Returns:

Builder instance for method chaining.

limit

public ScanOptions.Builder limit(long limit)

Set the limit.

Parameters:

limit - Maximum number of rows to return.

Returns:

Builder instance for method chaining.

offset

public ScanOptions.Builder offset(long offset)

Set the offset.

Parameters:

offset - Number of rows to skip before returning results.

Returns:

Builder instance for method chaining.

nearest

public ScanOptions.Builder nearest(Query nearest)

Set the nearest neighbor query.

Parameters:

nearest - The nearest neighbor query.

Returns:

Builder instance for method chaining.

withRowId

public ScanOptions.Builder withRowId(boolean withRowId)

Set whether to include the row ID.

Parameters:

withRowId - true to include row ID, false otherwise.

Returns:

Builder instance for method chaining.

withRowAddress

public ScanOptions.Builder withRowAddress(boolean withRowAddress)

Set whether to include the row addr.

Parameters:

withRowAddress - true to include row ID, false otherwise.

Returns:

Builder instance for method chaining.

batchReadahead

public ScanOptions.Builder batchReadahead(int batchReadahead)

Set the batch readahead.

Parameters:

batchReadahead - Number of batches to read ahead.

Returns:

Builder instance for method chaining.

setColumnOrderings

public ScanOptions.Builder setColumnOrderings(List<ColumnOrdering> columnOrderings)

build

public ScanOptions build()

Build the LanceScanOptions instance.

Returns:

LanceScanOptions instance with the specified parameters.