org.bytedeco.arrow_dataset

Class Scanner

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow_dataset.Scanner

All Implemented Interfaces:

AutoCloseable

@Namespace(value="arrow::dataset")
 @NoOffset
 @Properties(inherit=arrow_dataset.class)
public class Scanner
extends Pointer

\brief Scanner is a materialized scan operation with context and options bound. A scanner is the class that glues ScanTask, Fragment, and Dataset. In python pseudo code, it performs the following: def Scan(): for fragment in self.dataset.GetFragments(this.options.filter): for scan_task in fragment.Scan(this.options): yield scan_task

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
Scanner(Dataset dataset, ScanOptions scan_options, ScanContext scan_context)
Scanner(Fragment fragment, ScanOptions scan_options, ScanContext scan_context)
Scanner(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
ScanContext	context()
FragmentIteratorResult	GetFragments() \brief GetFragments returns an iterator over all Fragments in this scan.
ScanOptions	options()
ScanTaskIteratorResult	Scan() \brief The Scan operator returns a stream of ScanTask.
Schema	schema()
TableResult	ToTable() \brief Convert a Scanner into a Table.

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getPointer, getPointer, getPointer, getPointer, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, offsetof, parseBytes, physicalBytes, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Scanner

public Scanner(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Scanner

public Scanner(@SharedPtr @ByVal
               Dataset dataset,
               @SharedPtr
               ScanOptions scan_options,
               @SharedPtr
               ScanContext scan_context)

Scanner

public Scanner(@SharedPtr @ByVal
               Fragment fragment,
               @SharedPtr
               ScanOptions scan_options,
               @SharedPtr
               ScanContext scan_context)

Method Detail

Scan

@ByVal
public ScanTaskIteratorResult Scan()

\brief The Scan operator returns a stream of ScanTask. The caller is responsible to dispatch/schedule said tasks. Tasks should be safe to run in a concurrent fashion and outlive the iterator.

ToTable

@ByVal
public TableResult ToTable()

\brief Convert a Scanner into a Table. Use this convenience utility with care. This will serially materialize the Scan result in memory before creating the Table.

GetFragments

@ByVal
public FragmentIteratorResult GetFragments()

\brief GetFragments returns an iterator over all Fragments in this scan.

schema

@Const
 @SharedPtr
 @ByRef
public Schema schema()

options

@SharedPtr
public ScanOptions options()

context

@SharedPtr
public ScanContext context()