org.bytedeco.arrow_dataset

Class FileSystemDataset

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow_dataset.Dataset

org.bytedeco.arrow_dataset.FileSystemDataset

All Implemented Interfaces:

AutoCloseable

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

\brief A Dataset of FileFragments. A FileSystemDataset is composed of one or more FileFragment. The fragments are independent and don't need to share the same format and/or filesystem.

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
FileSystemDataset(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
StringVector	files() \brief Return the path of files.
FileFormat	format() \brief Return the format.
static FileSystemDatasetResult	Make(Schema schema, Expression root_partition, FileFormat format, FileFragmentVector fragments) \brief Create a FileSystemDataset.
DatasetResult	ReplaceSchema(Schema schema) \brief Replace the schema of the dataset.
String	ToString()
String	type_name() \brief Return the type name of the dataset.
static FileSystemDatasetResult	Write(WritePlan plan, ScanOptions scan_options, ScanContext scan_context) \brief Write to a new format and filesystem location, preserving partitioning.

Methods inherited from class org.bytedeco.arrow_dataset.Dataset

GetFragments, GetFragments, NewScan, NewScan, partition_expression, schema

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

FileSystemDataset

public FileSystemDataset(Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

Method Detail

Make

@ByVal
public static FileSystemDatasetResult Make(@SharedPtr @ByVal
                                                   Schema schema,
                                                   @SharedPtr @ByVal
                                                   Expression root_partition,
                                                   @SharedPtr
                                                   FileFormat format,
                                                   @ByVal
                                                   FileFragmentVector fragments)

\brief Create a FileSystemDataset.

Parameters:

schema - [in] the schema of the dataset

root_partition - [in] the partition expression of the dataset

format - [in] the format of each FileFragment.

fragments - [in] list of fragments to create the dataset from Note that all fragment must be of FileFragment type. The type are erased to simplify callers.

Returns:

A constructed dataset.

Write

@ByVal
public static FileSystemDatasetResult Write(@Const @ByRef
                                                    WritePlan plan,
                                                    @SharedPtr
                                                    ScanOptions scan_options,
                                                    @SharedPtr
                                                    ScanContext scan_context)

\brief Write to a new format and filesystem location, preserving partitioning.

Parameters:

plan - [in] the WritePlan to execute.

scan_options - [in] options in which to scan fragments

scan_context - [in] context in which to scan fragments before writing.

type_name

@StdString
public String type_name()

\brief Return the type name of the dataset.

Overrides:

type_name in class Dataset

ReplaceSchema

@ByVal
public DatasetResult ReplaceSchema(@SharedPtr @ByVal
                                           Schema schema)

\brief Replace the schema of the dataset.

Overrides:

ReplaceSchema in class Dataset

files

@ByVal
public StringVector files()

\brief Return the path of files.

format

@SharedPtr
public FileFormat format()

\brief Return the format.

ToString

@StdString
public String ToString()