org.bytedeco.arrow_dataset

Class Partitioning

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow_dataset.Partitioning

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

FunctionPartitioning, KeyValuePartitioning

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

\defgroup dataset-partitioning Partitioning API \{

\brief Interface for parsing partition expressions from string partition identifiers. For example, the identifier "foo=5" might be parsed to an equality expression between the "foo" field and the value 5. Some partitionings may store the field names in a metadata store instead of in file paths, for example dataset_root/2009/11/... could be used when the partition fields are "year" and "month" Paths are consumed from left to right. Paths must be relative to the root of a partition; path prefixes must be removed before passing the path to a partitioning for parsing.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Partitioning.PartitionedBatches \brief If the input batch shares any fields with this partitioning, produce sub-batches which satisfy mutually exclusive Expressions.

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

Method Summary

Modifier and Type	Method and Description
static Partitioning	Default() \brief A default Partitioning which always yields scalar(true)
StringResult	Format(Expression expr)
ExpressionResult	Parse(BytePointer path)
ExpressionResult	Parse(String path) \brief Parse a path into a partition expression
PartitionedBatchesResult	Partition(RecordBatch batch)
Schema	schema() \brief The partition schema.
String	type_name() \brief The name identifying the kind of partitioning

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

Partitioning

public Partitioning(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

type_name

@StdString
public String type_name()

\brief The name identifying the kind of partitioning

Partition

@ByVal
public PartitionedBatchesResult Partition(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::RecordBatch>"})
                                                  RecordBatch batch)

Parse

@ByVal
public ExpressionResult Parse(@StdString
                                      String path)

\brief Parse a path into a partition expression

Parse

@ByVal
public ExpressionResult Parse(@StdString
                                      BytePointer path)

Format

@ByVal
public StringResult Format(@Const @ByRef
                                   Expression expr)

Default

@SharedPtr
public static Partitioning Default()

\brief A default Partitioning which always yields scalar(true)

schema

@Const
 @SharedPtr
 @ByRef
public Schema schema()

\brief The partition schema.