IPC options classes: Apache Arrow GLib Reference Manual

IPC options classes

Functions

GArrowReadOptions *	garrow_read_options_new ()
int *	garrow_read_options_get_included_fields ()
void	garrow_read_options_set_included_fields ()
GArrowWriteOptions *	garrow_write_options_new ()

Properties

gint	max-recursion-depth	Read / Write
gboolean	use-threads	Read / Write
gint	alignment	Read / Write
gboolean	allow-64bit	Read / Write
GArrowCodec *	codec	Read / Write
gint	max-recursion-depth	Read / Write
gboolean	use-threads	Read / Write
gboolean	write-legacy-ipc-format	Read / Write

Types and Values

#define	GARROW_TYPE_READ_OPTIONS
struct	GArrowReadOptionsClass
#define	GARROW_TYPE_WRITE_OPTIONS
struct	GArrowWriteOptionsClass
	GArrowReadOptions
	GArrowWriteOptions

Object Hierarchy

    GObject
    ├── GArrowReadOptions
    ╰── GArrowWriteOptions

Includes

#include <arrow-glib/arrow-glib.h>

Description

GArrowReadOptions provides options for reading data.

GArrowWriteOptions provides options for writing data.

Functions

garrow_read_options_new ()

GArrowReadOptions *
garrow_read_options_new (void);

Returns

A newly created GArrowReadOptions.

Since: 1.0.0

garrow_read_options_get_included_fields ()

int *
garrow_read_options_get_included_fields
                               (GArrowReadOptions *options,
                                gsize *n_fields);

Parameters

options	A GArrowReadOptions.
n_fields	The number of included fields.	[out]

Returns

Top-level schema fields to include when deserializing RecordBatch. If empty, return all deserialized fields.

It should be freed with g_free() when no longer needed.

[array length=n_fields][transfer full]

Since: 1.0.0

garrow_read_options_set_included_fields ()

void
garrow_read_options_set_included_fields
                               (GArrowReadOptions *options,
                                int *fields,
                                gsize n_fields);

Parameters

options	A GArrowReadOptions.
fields	Top-level schema fields to include when deserializing RecordBatch. If empty, return all deserialized fields.	[array length=n_fields]
n_fields	The number of included fields.

Since: 1.0.0

garrow_write_options_new ()

GArrowWriteOptions *
garrow_write_options_new (void);

Returns

A newly created GArrowWriteOptions.

Since: 1.0.0

Types and Values

GARROW_TYPE_READ_OPTIONS

#define GARROW_TYPE_READ_OPTIONS (garrow_read_options_get_type())

struct GArrowReadOptionsClass

struct GArrowReadOptionsClass {
  GObjectClass parent_class;
};

GARROW_TYPE_WRITE_OPTIONS

#define GARROW_TYPE_WRITE_OPTIONS (garrow_write_options_get_type())

struct GArrowWriteOptionsClass

struct GArrowWriteOptionsClass {
  GObjectClass parent_class;
};

GArrowReadOptions

typedef struct _GArrowReadOptions GArrowReadOptions;

GArrowWriteOptions

typedef struct _GArrowWriteOptions GArrowWriteOptions;

Property Details

The `“max-recursion-depth”` property

  “max-recursion-depth”      gint

The maximum permitted schema nesting depth.

Owner: GArrowReadOptions

Flags: Read / Write

Allowed values: [0,64]

Default value: 64

Since: 1.0.0

The `“use-threads”` property

  “use-threads”              gboolean

Whether to use the global CPU thread pool.

Owner: GArrowReadOptions

Flags: Read / Write

Default value: TRUE

Since: 1.0.0

The `“alignment”` property

  “alignment”                gint

Write padding after memory buffers to this multiple of bytes. Generally 8 or 64.

Owner: GArrowWriteOptions

Flags: Read / Write

Allowed values: >= 0

Default value: 8

Since: 1.0.0

The `“allow-64bit”` property

  “allow-64bit”              gboolean

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.

Owner: GArrowWriteOptions

Flags: Read / Write

Default value: FALSE

Since: 1.0.0

The `“codec”` property

  “codec”                    GArrowCodec *

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

May only be UNCOMPRESSED, LZ4_FRAME and ZSTD.

Owner: GArrowWriteOptions

Flags: Read / Write

Since: 2.0.0

The `“max-recursion-depth”` property

  “max-recursion-depth”      gint

The maximum permitted schema nesting depth.

Owner: GArrowWriteOptions

Flags: Read / Write

Allowed values: [0,64]

Default value: 64

Since: 1.0.0

The `“use-threads”` property

  “use-threads”              gboolean

Whether to use the global CPU thread pool.

Owner: GArrowWriteOptions

Flags: Read / Write

Default value: TRUE

Since: 1.0.0

The `“write-legacy-ipc-format”` property

  “write-legacy-ipc-format”  gboolean

Whether to write the pre-0.15.0 encapsulated IPC message format consisting of a 4-byte prefix instead of 8 byte.

Owner: GArrowWriteOptions

Flags: Read / Write

Default value: FALSE

Since: 1.0.0