com.lancedb.lance.ipc

Class LanceScanner

java.lang.Object

com.lancedb.lance.ipc.LanceScanner

All Implemented Interfaces:

AutoCloseable, org.apache.arrow.dataset.scanner.Scanner

public class LanceScanner
extends Object
implements org.apache.arrow.dataset.scanner.Scanner

Scanner over a Fragment.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this scanner and releases any system resources associated with it.
long	countRows() Scan and return the number of matching rows (fulfill the given scan options).
static LanceScanner	create(Dataset dataset, ScanOptions options, org.apache.arrow.memory.BufferAllocator allocator) Create a Scanner.
Iterable<? extends org.apache.arrow.dataset.scanner.ScanTask>	scan()
org.apache.arrow.vector.ipc.ArrowReader	scanBatches()
org.apache.arrow.vector.types.pojo.Schema	schema()

Methods inherited from class java.lang.Object

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

Method Detail

create

public static LanceScanner create(Dataset dataset,
                                  ScanOptions options,
                                  org.apache.arrow.memory.BufferAllocator allocator)

Create a Scanner.

Parameters:

dataset - the dataset to scan

options - scan options

allocator - allocator

Returns:

a Scanner

close

public void close()
           throws Exception

Closes this scanner and releases any system resources associated with it. If the scanner is already closed, then invoking this method has no effect.

Specified by:

close in interface AutoCloseable

Throws:

Exception

scanBatches

public org.apache.arrow.vector.ipc.ArrowReader scanBatches()

Specified by:

scanBatches in interface org.apache.arrow.dataset.scanner.Scanner

scan

public Iterable<? extends org.apache.arrow.dataset.scanner.ScanTask> scan()

Specified by:

scan in interface org.apache.arrow.dataset.scanner.Scanner

schema

public org.apache.arrow.vector.types.pojo.Schema schema()

Specified by:

schema in interface org.apache.arrow.dataset.scanner.Scanner

countRows

public long countRows()

Scan and return the number of matching rows (fulfill the given scan options).

Returns:

num of rows.