com.lancedb.lance.ipc

Class ScanOptions

java.lang.Object

com.lancedb.lance.ipc.ScanOptions

public class ScanOptions
extends Object

Lance scan options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScanOptions.Builder Builder for constructing LanceScanOptions.

Constructor Summary

Constructors

Constructor and Description
ScanOptions(Optional<List<Integer>> fragmentIds, Optional<Long> batchSize, Optional<List<String>> columns, Optional<String> filter, Optional<ByteBuffer> substraitFilter, Optional<Long> limit, Optional<Long> offset, Optional<Query> nearest, boolean withRowId, boolean withRowAddress, int batchReadahead, Optional<List<ColumnOrdering>> columnOrderings) Constructor for LanceScanOptions.

Method Summary

Modifier and Type	Method and Description
int	getBatchReadahead() Get the batch readahead.
Optional<Long>	getBatchSize() Get the batch size.
Optional<List<ColumnOrdering>>	getColumnOrderings()
Optional<List<String>>	getColumns() Get the columns.
Optional<String>	getFilter() Get the filter.
Optional<List<Integer>>	getFragmentIds() Get the fragment ids.
Optional<Long>	getLimit() Get the limit.
Optional<Query>	getNearest() Get the nearest neighbor query.
Optional<Long>	getOffset() Get the offset.
Optional<ByteBuffer>	getSubstraitFilter() Get the substrait filter.
boolean	isWithRowAddress() Get whether to include the row address.
boolean	isWithRowId() Get whether to include the row ID.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ScanOptions

public ScanOptions(Optional<List<Integer>> fragmentIds,
                   Optional<Long> batchSize,
                   Optional<List<String>> columns,
                   Optional<String> filter,
                   Optional<ByteBuffer> substraitFilter,
                   Optional<Long> limit,
                   Optional<Long> offset,
                   Optional<Query> nearest,
                   boolean withRowId,
                   boolean withRowAddress,
                   int batchReadahead,
                   Optional<List<ColumnOrdering>> columnOrderings)

Constructor for LanceScanOptions.

Parameters:

fragmentIds - the id of the fragments to scan

batchSize - Maximum row number of each returned ArrowRecordBatch. Optional, use Optional.empty() if unspecified.

columns - (Optional) Projected columns. Optional.empty() for scanning all columns. Otherwise, only columns present in the List will be scanned.

filter - (Optional) Filter expression. Optional.empty() for no filter.

substraitFilter - (Optional) Substrait filter expression.

limit - (Optional) Maximum number of rows to return.

offset - (Optional) Number of rows to skip before returning results.

withRowId - Whether to include the row ID in the results.

withRowAddress - Whether to include the row address in the results.

nearest - (Optional) Nearest neighbor query.

batchReadahead - Number of batches to read ahead.

Method Detail

getFragmentIds

public Optional<List<Integer>> getFragmentIds()

Get the fragment ids.

Returns:

Optional containing the fragment ids if specified, otherwise empty.

getBatchSize

public Optional<Long> getBatchSize()

Get the batch size.

Returns:

Optional containing the batch size if specified, otherwise empty.

getColumns

public Optional<List<String>> getColumns()

Get the columns.

Returns:

Optional containing the columns if specified, otherwise empty.

getFilter

public Optional<String> getFilter()

Get the filter.

Returns:

Optional containing the filter if specified, otherwise empty.

getSubstraitFilter

public Optional<ByteBuffer> getSubstraitFilter()

Get the substrait filter.

Returns:

Optional containing the substrait filter if specified, otherwise empty.

getLimit

public Optional<Long> getLimit()

Get the limit.

Returns:

Optional containing the limit if specified, otherwise empty.

getOffset

public Optional<Long> getOffset()

Get the offset.

Returns:

Optional containing the offset if specified, otherwise empty.

getNearest

public Optional<Query> getNearest()

Get the nearest neighbor query.

Returns:

Optional containing the nearest neighbor query if specified, otherwise empty.

isWithRowId

public boolean isWithRowId()

Get whether to include the row ID.

Returns:

true if row ID should be included, false otherwise.

isWithRowAddress

public boolean isWithRowAddress()

Get whether to include the row address.

Returns:

true if row address should be included, false otherwise.

getBatchReadahead

public int getBatchReadahead()

Get the batch readahead.

Returns:

the number of batches to read ahead.

getColumnOrderings

public Optional<List<ColumnOrdering>> getColumnOrderings()

toString

public String toString()

Overrides:

toString in class Object