org.bytedeco.arrow_dataset

Class WritePlan

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow_dataset.WritePlan

All Implemented Interfaces:

AutoCloseable

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

\brief A declarative plan for writing fragments to a partitioned directory structure.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WritePlan.FragmentOrPartitionExpression

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
WritePlan() Default native constructor.
WritePlan(long size) Native array allocator.
WritePlan(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
FileSystem	filesystem() The FileSystem and base directory for partitioned writing
WritePlan	filesystem(FileSystem setter)
FileFormat	format() The format into which fragments will be written
WritePlan	format(FileFormat setter)
WritePlan	getPointer(long i)
String	partition_base_dir()
WritePlan	partition_base_dir(String setter)
Partitioning	partitioning() The partitioning with which paths were generated
WritePlan	partitioning(Partitioning setter)
StringVector	paths() If fragment_or_partition_expressions[i] is a Fragment, that Fragment will be written to paths[i].
WritePlan	paths(StringVector setter)
WritePlan	position(long position)
Schema	schema() The schema of the Dataset which will be written
WritePlan	schema(Schema setter)

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, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, offsetof, parseBytes, physicalBytes, 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

WritePlan

public WritePlan()

Default native constructor.

WritePlan

public WritePlan(long size)

Native array allocator. Access with Pointer.position(long).

WritePlan

public WritePlan(Pointer p)

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

Method Detail

position

public WritePlan position(long position)

Overrides:

position in class Pointer

getPointer

public WritePlan getPointer(long i)

Overrides:

getPointer in class Pointer

partitioning

@SharedPtr
public Partitioning partitioning()

The partitioning with which paths were generated

partitioning

public WritePlan partitioning(Partitioning setter)

schema

@SharedPtr
 @ByRef
public Schema schema()

The schema of the Dataset which will be written

schema

public WritePlan schema(Schema setter)

format

@SharedPtr
public FileFormat format()

The format into which fragments will be written

format

public WritePlan format(FileFormat setter)

filesystem

@SharedPtr
public FileSystem filesystem()

The FileSystem and base directory for partitioned writing

filesystem

public WritePlan filesystem(FileSystem setter)

partition_base_dir

@StdString
public String partition_base_dir()

partition_base_dir

public WritePlan partition_base_dir(String setter)

paths

@ByRef
public StringVector paths()

If fragment_or_partition_expressions[i] is a Fragment, that Fragment will be written to paths[i]. If it is an Expression, a directory representing that partition expression will be created at paths[i] instead.

paths

public WritePlan paths(StringVector setter)