arrow.write_options

Module for [WriteOptions] class

Types 3

Methods
GType _gType() @property
WriteOptions self()Returns `this`, for use in `with` statements.
WriteOptionsGidBuilder builder()Get builder for [arrow.write_options.WriteOptions] Returns: New builder object
int alignment() @propertyGet `alignment` property. Returns: Write padding after memory buffers to this multiple of bytes. Generally 8 or 64.
void alignment(int propval) @propertySet `alignment` property. Params: propval = Write padding after memory buffers to this multiple of bytes. Generally 8 or 64.
bool allow64bit() @propertyGet `allow64bit` property. Returns: Whether to allow field lengths that don't fit in a signed 32-bit int. Some implementations may not be able to parse such streams.
void allow64bit(bool propval) @propertySet `allow64bit` property. Params: propval = Whether to allow field lengths that don't fit in a signed 32-bit int. Some implementations may not be able to parse such streams.
arrow.codec.Codec codec() @propertyGet `codec` property. Returns: Codec to use for compressing and decompressing record batch body buffers. This is not part of the Arrow IPC protocol and only for internal use (e.g. Feather files).
void codec(arrow.codec.Codec propval) @propertySet `codec` property. Params: propval = Codec to use for compressing and decompressing record batch body buffers. This is not part of the Arrow IPC protocol and only for internal use (e.g. Feather ...
int maxRecursionDepth() @propertyGet `maxRecursionDepth` property. Returns: The maximum permitted schema nesting depth.
void maxRecursionDepth(int propval) @propertySet `maxRecursionDepth` property. Params: propval = The maximum permitted schema nesting depth.
bool useThreads() @propertyGet `useThreads` property. Returns: Whether to use the global CPU thread pool.
void useThreads(bool propval) @propertySet `useThreads` property. Params: propval = Whether to use the global CPU thread pool.
bool writeLegacyIpcFormat() @propertyGet `writeLegacyIpcFormat` property. Returns: Whether to write the pre-0.15.0 encapsulated IPC message format consisting of a 4-byte prefix instead of 8 byte.
void writeLegacyIpcFormat(bool propval) @propertySet `writeLegacyIpcFormat` property. Params: propval = Whether to write the pre-0.15.0 encapsulated IPC message format consisting of a 4-byte prefix instead of 8 byte.
Constructors
this(void * ptr, Flag!"Take" take)
Methods
T alignment(int propval)Set `alignment` property. Params: propval = Write padding after memory buffers to this multiple of bytes. Generally 8 or 64. Returns: Builder instance for fluent chaining
T allow64bit(bool propval)Set `allow64bit` property. Params: propval = Whether to allow field lengths that don't fit in a signed 32-bit int. Some implementations may not be able to parse such streams. Returns: Builder insta...
T codec(arrow.codec.Codec propval)Set `codec` property. Params: propval = Codec to use for compressing and decompressing record batch body buffers. This is not part of the Arrow IPC protocol and only for internal use (e.g. Feather ...
T maxRecursionDepth(int propval)Set `maxRecursionDepth` property. Params: propval = The maximum permitted schema nesting depth. Returns: Builder instance for fluent chaining
T useThreads(bool propval)Set `useThreads` property. Params: propval = Whether to use the global CPU thread pool. Returns: Builder instance for fluent chaining
T writeLegacyIpcFormat(bool propval)Set `writeLegacyIpcFormat` property. Params: propval = Whether to write the pre-0.15.0 encapsulated IPC message format consisting of a 4-byte prefix instead of 8 byte. Returns: Builder instance for...

Fluent builder for [arrow.write_options.WriteOptions]