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.
FileSystem	filesystem() \brief Return the filesystem.
FileFormat	format() \brief Return the format.
static FileSystemDatasetResult	Make(Schema schema, Expression root_partition, FileFormat format, FileSystem filesystem, FileFragmentVector fragments)
static FileSystemDatasetResult	Make(Schema schema, Expression root_partition, FileFormat format, FileSystem filesystem, FileFragmentVector fragments, Partitioning partitioning) \brief Create a FileSystemDataset.
Partitioning	partitioning() \brief Return the partitioning.
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 Status	Write(FileSystemDatasetWriteOptions write_options, Scanner scanner) \brief Write a dataset.

Methods inherited from class org.bytedeco.arrow_dataset.Dataset

GetFragments, GetFragments, 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, getDirectBufferAddress, getPointer, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, 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).

Method Detail

Make

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

\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.

filesystem - [in] the filesystem of each FileFragment, or nullptr if the fragments wrap buffers.

fragments - [in] list of fragments to create the dataset from.

partitioning - [in] the Partitioning object in case the dataset is created with a known partitioning (e.g. from a discovered partitioning through a DatasetFactory), or nullptr if not known. Note that fragments wrapping files resident in differing filesystems are not permitted; to work with multiple filesystems use a UnionDataset.

Returns:

A constructed dataset.

Make

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

Write

@ByVal
public static Status Write(@Const @ByRef
                                   FileSystemDatasetWriteOptions write_options,
                                   @SharedPtr @ByVal
                                   Scanner scanner)

\brief Write a dataset.

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.

filesystem

@SharedPtr
public FileSystem filesystem()

\brief Return the filesystem. May be nullptr if the fragments wrap buffers.

partitioning

@SharedPtr
public Partitioning partitioning()

\brief Return the partitioning. May be nullptr if the dataset was not constructed with a partitioning.

ToString

@StdString
public String ToString()