Reader classes: Apache Arrow GLib Reference Manual

Reader classes

Functions

GArrowRecordBatchReader *	garrow_record_batch_reader_import ()
GArrowRecordBatchReader *	garrow_record_batch_reader_new ()
gpointer	garrow_record_batch_reader_export ()
GArrowSchema *	garrow_record_batch_reader_get_schema ()
GArrowRecordBatch *	garrow_record_batch_reader_get_next_record_batch ()
GArrowRecordBatch *	garrow_record_batch_reader_read_next_record_batch ()
GArrowRecordBatch *	garrow_record_batch_reader_read_next ()
GArrowTable *	garrow_record_batch_reader_read_all ()
GList *	garrow_record_batch_reader_get_sources ()
GArrowTableBatchReader *	garrow_table_batch_reader_new ()
void	garrow_table_batch_reader_set_max_chunk_size ()
GArrowRecordBatchStreamReader *	garrow_record_batch_stream_reader_new ()
GArrowRecordBatchFileReader *	garrow_record_batch_file_reader_new ()
GArrowSchema *	garrow_record_batch_file_reader_get_schema ()
guint	garrow_record_batch_file_reader_get_n_record_batches ()
GArrowMetadataVersion	garrow_record_batch_file_reader_get_version ()
GArrowRecordBatch *	garrow_record_batch_file_reader_get_record_batch ()
GArrowRecordBatch *	garrow_record_batch_file_reader_read_record_batch ()
GArrowFeatherFileReader *	garrow_feather_file_reader_new ()
gint	garrow_feather_file_reader_get_version ()
GArrowTable *	garrow_feather_file_reader_read ()
GArrowTable *	garrow_feather_file_reader_read_indices ()
GArrowTable *	garrow_feather_file_reader_read_names ()
GArrowCSVReadOptions *	garrow_csv_read_options_new ()
void	garrow_csv_read_options_add_column_type ()
void	garrow_csv_read_options_add_schema ()
GHashTable *	garrow_csv_read_options_get_column_types ()
void	garrow_csv_read_options_set_null_values ()
gchar **	garrow_csv_read_options_get_null_values ()
void	garrow_csv_read_options_add_null_value ()
void	garrow_csv_read_options_set_true_values ()
gchar **	garrow_csv_read_options_get_true_values ()
void	garrow_csv_read_options_add_true_value ()
void	garrow_csv_read_options_set_false_values ()
gchar **	garrow_csv_read_options_get_false_values ()
void	garrow_csv_read_options_add_false_value ()
void	garrow_csv_read_options_set_column_names ()
gchar **	garrow_csv_read_options_get_column_names ()
void	garrow_csv_read_options_add_column_name ()
GArrowCSVReader *	garrow_csv_reader_new ()
GArrowTable *	garrow_csv_reader_read ()
GArrowJSONReadOptions *	garrow_json_read_options_new ()
GArrowJSONReader *	garrow_json_reader_new ()
GArrowTable *	garrow_json_reader_read ()

Properties

gpointer	record-batch-file-reader	Write / Construct Only
gboolean	allow-newlines-in-values	Read / Write
gboolean	allow-null-strings	Read / Write
int	block-size	Read / Write
gboolean	check-utf8	Read / Write
char	delimiter	Read / Write
char	escape-character	Read / Write
gboolean	generate-column-names	Read / Write
gboolean	ignore-empty-lines	Read / Write
gboolean	is-double-quoted	Read / Write
gboolean	is-escaped	Read / Write
gboolean	is-quoted	Read / Write
guint	n-skip-rows	Read / Write
char	quote-character	Read / Write
gboolean	use-threads	Read / Write
gpointer	csv-table-reader	Write / Construct Only
GArrowInputStream *	input	Read / Write / Construct Only
gpointer	feather-reader	Write / Construct Only
gboolean	allow-newlines-in-values	Read / Write
int	block-size	Read / Write
GArrowSchema *	schema	Read / Write
GArrowJSONReadUnexpectedFieldBehavior	unexpected-field-behavior	Read / Write
gboolean	use-threads	Read / Write
GArrowInputStream *	input	Read / Write / Construct Only
gpointer	json-table-reader	Write / Construct Only
gpointer	record-batch-reader	Write / Construct Only
gpointer	sources	Write / Construct Only

Types and Values

#define	GARROW_TYPE_RECORD_BATCH_READER
struct	GArrowRecordBatchReaderClass
#define	GARROW_TYPE_TABLE_BATCH_READER
struct	GArrowTableBatchReaderClass
struct	GArrowRecordBatchStreamReader
struct	GArrowRecordBatchFileReader
#define	GARROW_TYPE_FEATHER_FILE_READER
struct	GArrowFeatherFileReaderClass
#define	GARROW_TYPE_CSV_READ_OPTIONS
struct	GArrowCSVReadOptionsClass
#define	GARROW_TYPE_CSV_READER
struct	GArrowCSVReaderClass
enum	GArrowJSONReadUnexpectedFieldBehavior
#define	GARROW_TYPE_JSON_READ_OPTIONS
struct	GArrowJSONReadOptionsClass
#define	GARROW_TYPE_JSON_READER
struct	GArrowJSONReaderClass
	GArrowCSVReadOptions
	GArrowCSVReader
	GArrowFeatherFileReader
	GArrowJSONReadOptions
	GArrowJSONReader
	GArrowRecordBatchReader
	GArrowTableBatchReader

Object Hierarchy

    GEnum
    ╰── GArrowJSONReadUnexpectedFieldBehavior
    GObject
    ├── GArrowCSVReadOptions
    ├── GArrowCSVReader
    ├── GArrowFeatherFileReader
    ├── GArrowJSONReadOptions
    ├── GArrowJSONReader
    ├── GArrowRecordBatchFileReader
    ╰── GArrowRecordBatchReader
        ├── GArrowRecordBatchStreamReader
        ├── GArrowTableBatchReader
        ╰── GArrowRecordBatchStreamReader

Includes

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

Description

GArrowRecordBatchReader is a base class for reading record batches in stream format from input.

GArrowRecordBatchStreamReader is a class for reading record batches in stream format from input synchronously.

GArrowRecordBatchFileReader is a class for reading record batches in file format from input.

GArrowFeatherFileReader is a class for reading columns in Feather file format from input.

GArrowCSVReader is a class for reading table in CSV format from input.

GArrowJSONReader is a class for reading table in JSON format from input.

Functions

garrow_record_batch_reader_import ()

GArrowRecordBatchReader *
garrow_record_batch_reader_import (gpointer c_abi_array_stream,
                                   GError **error);

Parameters

c_abi_array_stream	A `struct ArrowArrayStream *`.	[not nullable]
error	Return location for a GError or `NULL`.	[nullable]

Returns

An imported GArrowRecordBatchReader on success, NULL on error.

You don't need to release the passed struct ArrowArrayStream *, even if this function reports an error.

[transfer full][nullable]

Since: 6.0.0

garrow_record_batch_reader_new ()

GArrowRecordBatchReader *
garrow_record_batch_reader_new (GList *record_batches,
                                GArrowSchema *schema,
                                GError **error);

Parameters

record_batches	A list of GArrowRecordBatch.	[element-type GArrowRecordBatch]
schema	A GArrowSchema to confirm to.	[nullable]
error	Return location for a GError or `NULL`.	[nullable]

Returns

The schema in the stream on success, NULL on error.

Since: 6.0.0

garrow_record_batch_reader_export ()

gpointer
garrow_record_batch_reader_export (GArrowRecordBatchReader *reader,
                                   GError **error);

Parameters

reader	A GArrowRecordBatchReader.
error	Return location for a GError or `NULL`.	[nullable]

Returns

An exported GArrowRecordBatchReader as struct ArrowArrayStream * on success, NULL on error.

It should be freed with the ArrowArrayStream::release callback then g_free() when no longer needed.

[transfer full][nullable]

Since: 6.0.0

garrow_record_batch_reader_get_schema ()

GArrowSchema *
garrow_record_batch_reader_get_schema (GArrowRecordBatchReader *reader);

Parameters

reader

A GArrowRecordBatchReader.

Returns

The schema in the stream.

[transfer full]

Since: 0.4.0

garrow_record_batch_reader_get_next_record_batch ()

GArrowRecordBatch *
garrow_record_batch_reader_get_next_record_batch
                               (GArrowRecordBatchReader *reader,
                                GError **error);

garrow_record_batch_reader_get_next_record_batch has been deprecated since version 0.5.0 and should not be used in newly-written code.

Use garrow_record_batch_reader_read_next() instead.

Parameters

reader	A GArrowRecordBatchReader.
error	Return location for a GError or `NULL`.	[nullable]

Returns

The next record batch in the stream or NULL on end of stream.

[nullable][transfer full]

Since: 0.4.0

garrow_record_batch_reader_read_next_record_batch ()

GArrowRecordBatch *
garrow_record_batch_reader_read_next_record_batch
                               (GArrowRecordBatchReader *reader,
                                GError **error);

garrow_record_batch_reader_read_next_record_batch has been deprecated since version 0.8.0 and should not be used in newly-written code.

Use garrow_record_batch_reader_read_next() instead.

Parameters

reader	A GArrowRecordBatchReader.
error	Return location for a GError or `NULL`.	[nullable]

Returns

The next record batch in the stream or NULL on end of stream.

[nullable][transfer full]

Since: 0.5.0

garrow_record_batch_reader_read_next ()

GArrowRecordBatch *
garrow_record_batch_reader_read_next (GArrowRecordBatchReader *reader,
                                      GError **error);

Parameters

reader	A GArrowRecordBatchReader.
error	Return location for a GError or `NULL`.	[nullable]

Returns

The next record batch in the stream or NULL on end of stream.

[nullable][transfer full]

Since: 0.8.0

garrow_record_batch_reader_read_all ()

GArrowTable *
garrow_record_batch_reader_read_all (GArrowRecordBatchReader *reader,
                                     GError **error);

Parameters

reader	A GArrowRecordBatchReader.
error	Return location for a GError or `NULL`.	[nullable]

Returns

The all record batches in the stream as GArrowTable.

[nullable][transfer full]

Since: 6.0.0

garrow_record_batch_reader_get_sources ()

GList *
garrow_record_batch_reader_get_sources
                               (GArrowRecordBatchReader *reader);

Parameters

reader

A GArrowRecordBatchReader.

Returns

A list of source of this reader.

[transfer none][element-type GObject]

Since: 13.0.0

garrow_table_batch_reader_new ()

GArrowTableBatchReader *
garrow_table_batch_reader_new (GArrowTable *table);

Parameters

table

The table to be read.

Returns

A newly created GArrowTableBatchReader.

Since: 0.8.0

garrow_table_batch_reader_set_max_chunk_size ()

void
garrow_table_batch_reader_set_max_chunk_size
                               (GArrowTableBatchReader *reader,
                                gint64 max_chunk_size);

Set the desired maximum chunk size of record batches.

The actual chunk size of each record batch may be smaller, depending on actual chunking characteristics of each table column.

Parameters

reader	A GArrowTableBatchReader.
max_chunk_size	The maximum chunk size of record batches.

Since: 12.0.0

garrow_record_batch_stream_reader_new ()

GArrowRecordBatchStreamReader *
garrow_record_batch_stream_reader_new (GArrowInputStream *stream,
                                       GError **error);

Parameters

stream	The stream to be read.
error	Return location for a GError or `NULL`.	[nullable]

Returns

A newly created GArrowRecordBatchStreamReader or NULL on error.

[nullable]

Since: 0.4.0

garrow_record_batch_file_reader_new ()

GArrowRecordBatchFileReader *
garrow_record_batch_file_reader_new (GArrowSeekableInputStream *file,
                                     GError **error);

Parameters

file	The file to be read.
error	Return location for a GError or `NULL`.	[nullable]

Returns

A newly created GArrowRecordBatchFileReader or NULL on error.

[nullable]

Since: 0.4.0

garrow_record_batch_file_reader_get_schema ()

GArrowSchema *
garrow_record_batch_file_reader_get_schema
                               (GArrowRecordBatchFileReader *reader);

Parameters

reader

A GArrowRecordBatchFileReader.

Returns

The schema in the file.

[transfer full]

Since: 0.4.0

garrow_record_batch_file_reader_get_n_record_batches ()

guint
garrow_record_batch_file_reader_get_n_record_batches
                               (GArrowRecordBatchFileReader *reader);

Parameters

reader

A GArrowRecordBatchFileReader.

Returns

The number of record batches in the file.

Since: 0.4.0

garrow_record_batch_file_reader_get_version ()

GArrowMetadataVersion
garrow_record_batch_file_reader_get_version
                               (GArrowRecordBatchFileReader *reader);

Parameters

reader

A GArrowRecordBatchFileReader.

Returns

The format version in the file.

Since: 0.4.0

garrow_record_batch_file_reader_get_record_batch ()

GArrowRecordBatch *
garrow_record_batch_file_reader_get_record_batch
                               (GArrowRecordBatchFileReader *reader,
                                guint i,
                                GError **error);

garrow_record_batch_file_reader_get_record_batch has been deprecated since version 0.5.0 and should not be used in newly-written code.

Use garrow_record_batch_file_reader_read_record_batch() instead.

Parameters

reader	A GArrowRecordBatchFileReader.
i	The index of the target record batch.
error	Return location for a GError or `NULL`.	[nullable]

Returns

The i-th record batch in the file or NULL on error.

[nullable][transfer full]

Since: 0.4.0

garrow_record_batch_file_reader_read_record_batch ()

GArrowRecordBatch *
garrow_record_batch_file_reader_read_record_batch
                               (GArrowRecordBatchFileReader *reader,
                                guint i,
                                GError **error);

Parameters

reader	A GArrowRecordBatchFileReader.
i	The index of the target record batch.
error	Return location for a GError or `NULL`.	[nullable]

Returns

The i-th record batch in the file or NULL on error.

[nullable][transfer full]

Since: 0.5.0

garrow_feather_file_reader_new ()

GArrowFeatherFileReader *
garrow_feather_file_reader_new (GArrowSeekableInputStream *file,
                                GError **error);

Parameters

file	The file to be read.
error	Return location for a GError or `NULL`.	[nullable]

Returns

A newly created GArrowFeatherFileReader or NULL on error.

[nullable]

Since: 0.4.0

garrow_feather_file_reader_get_version ()

gint
garrow_feather_file_reader_get_version
                               (GArrowFeatherFileReader *reader);

Parameters

reader

A GArrowFeatherFileReader.

Returns

The format version of the file.

Since: 0.4.0

garrow_feather_file_reader_read ()

GArrowTable *
garrow_feather_file_reader_read (GArrowFeatherFileReader *reader,
                                 GError **error);

Parameters

reader	A GArrowFeatherFileReader.
error	Return location for a GError or `NULL`.	[nullable]

Returns

The table in the file that has all columns.

[transfer full]

Since: 0.12.0

garrow_feather_file_reader_read_indices ()

GArrowTable *
garrow_feather_file_reader_read_indices
                               (GArrowFeatherFileReader *reader,
                                const gint *indices,
                                guint n_indices,
                                GError **error);

Parameters

reader	A GArrowFeatherFileReader.
indices	The indices of column to be read.	[array length=n_indices]
n_indices	The number of indices.
error	Return location for a GError or `NULL`.	[nullable]

Returns

The table in the file that has only the specified columns.

[transfer full]

Since: 0.12.0

garrow_feather_file_reader_read_names ()

GArrowTable *
garrow_feather_file_reader_read_names (GArrowFeatherFileReader *reader,
                                       const gchar **names,
                                       guint n_names,
                                       GError **error);

Parameters

reader	A GArrowFeatherFileReader.
names	The names of column to be read.	[array length=n_names]
n_names	The number of names.
error	Return location for a GError or `NULL`.	[nullable]

Returns

The table in the file that has only the specified columns.

[transfer full]

Since: 0.12.0

garrow_csv_read_options_new ()

GArrowCSVReadOptions *
garrow_csv_read_options_new (void);

Returns

A newly created GArrowCSVReadOptions.

Since: 0.12.0

garrow_csv_read_options_add_column_type ()

void
garrow_csv_read_options_add_column_type
                               (GArrowCSVReadOptions *options,
                                const gchar *name,
                                GArrowDataType *data_type);

Add value type of a column.

Parameters

options	A GArrowCSVReadOptions.
name	The name of the target column.
data_type	The GArrowDataType for the column.

Since: 0.12.0

garrow_csv_read_options_add_schema ()

void
garrow_csv_read_options_add_schema (GArrowCSVReadOptions *options,
                                    GArrowSchema *schema);

Add value types for columns in the schema.

Parameters

options	A GArrowCSVReadOptions.
schema	The GArrowSchema that specifies columns and their types.

Since: 0.12.0

garrow_csv_read_options_get_column_types ()

GHashTable *
garrow_csv_read_options_get_column_types
                               (GArrowCSVReadOptions *options);

Parameters

options

A GArrowCSVReadOptions.

Returns

The column name and value type mapping of the options.

[transfer full][element-type gchar* GArrowDataType]

Since: 0.12.0

garrow_csv_read_options_set_null_values ()

void
garrow_csv_read_options_set_null_values
                               (GArrowCSVReadOptions *options,
                                const gchar **null_values,
                                gsize n_null_values);

Parameters

options	A GArrowCSVReadOptions.
null_values	The values to be processed as null.	[array length=n_null_values]
n_null_values	The number of the specified null values.

Since: 0.14.0

garrow_csv_read_options_get_null_values ()

gchar **
garrow_csv_read_options_get_null_values
                               (GArrowCSVReadOptions *options);

Parameters

options

A GArrowCSVReadOptions.

Returns

The values to be processed as null.

If the number of values is zero, this returns NULL.

It's a NULL-terminated string array. It must be freed with g_strfreev() when no longer needed.

[nullable][array zero-terminated=1][element-type utf8][transfer full]

Since: 0.14.0

garrow_csv_read_options_add_null_value ()

void
garrow_csv_read_options_add_null_value
                               (GArrowCSVReadOptions *options,
                                const gchar *null_value);

Parameters

options	A GArrowCSVReadOptions.
null_value	The value to be processed as null.

Since: 0.14.0

garrow_csv_read_options_set_true_values ()

void
garrow_csv_read_options_set_true_values
                               (GArrowCSVReadOptions *options,
                                const gchar **true_values,
                                gsize n_true_values);

Parameters

options	A GArrowCSVReadOptions.
true_values	The values to be processed as true.	[array length=n_true_values]
n_true_values	The number of the specified true values.

Since: 0.14.0

garrow_csv_read_options_get_true_values ()

gchar **
garrow_csv_read_options_get_true_values
                               (GArrowCSVReadOptions *options);

Parameters

options

A GArrowCSVReadOptions.

Returns

The values to be processed as true.

If the number of values is zero, this returns NULL.

It's a NULL-terminated string array. It must be freed with g_strfreev() when no longer needed.

[nullable][array zero-terminated=1][element-type utf8][transfer full]

Since: 0.14.0

garrow_csv_read_options_add_true_value ()

void
garrow_csv_read_options_add_true_value
                               (GArrowCSVReadOptions *options,
                                const gchar *true_value);

Parameters

options	A GArrowCSVReadOptions.
true_value	The value to be processed as true.

Since: 0.14.0

garrow_csv_read_options_set_false_values ()

void
garrow_csv_read_options_set_false_values
                               (GArrowCSVReadOptions *options,
                                const gchar **false_values,
                                gsize n_false_values);

Parameters

options	A GArrowCSVReadOptions.
false_values	The values to be processed as false.	[array length=n_false_values]
n_false_values	The number of the specified false values.

Since: 0.14.0

garrow_csv_read_options_get_false_values ()

gchar **
garrow_csv_read_options_get_false_values
                               (GArrowCSVReadOptions *options);

Parameters

options

A GArrowCSVReadOptions.

Returns

The values to be processed as false.

If the number of values is zero, this returns NULL.

It's a NULL-terminated string array. It must be freed with g_strfreev() when no longer needed.

[nullable][array zero-terminated=1][element-type utf8][transfer full]

Since: 0.14.0

garrow_csv_read_options_add_false_value ()

void
garrow_csv_read_options_add_false_value
                               (GArrowCSVReadOptions *options,
                                const gchar *false_value);

Parameters

options	A GArrowCSVReadOptions.
false_value	The value to be processed as false.

Since: 0.14.0

garrow_csv_read_options_set_column_names ()

void
garrow_csv_read_options_set_column_names
                               (GArrowCSVReadOptions *options,
                                const gchar **column_names,
                                gsize n_column_names);

Parameters

options	A GArrowCSVReadOptions.
column_names	The column names (if empty, will be read from first row after `skip_rows`).	[array length=n_column_names]
n_column_names	The number of the specified column names.

Since: 0.15.0

garrow_csv_read_options_get_column_names ()

gchar **
garrow_csv_read_options_get_column_names
                               (GArrowCSVReadOptions *options);

Parameters

options

A GArrowCSVReadOptions.

Returns

The column names.

If the number of values is zero, this returns NULL.

It's a NULL-terminated string array. It must be freed with g_strfreev() when no longer needed.

[nullable][array zero-terminated=1][element-type utf8][transfer full]

Since: 0.15.0

garrow_csv_read_options_add_column_name ()

void
garrow_csv_read_options_add_column_name
                               (GArrowCSVReadOptions *options,
                                const gchar *column_name);

garrow_csv_reader_new ()

GArrowCSVReader *
garrow_csv_reader_new (GArrowInputStream *input,
                       GArrowCSVReadOptions *options,
                       GError **error);

Parameters

input	The input to be read.
options	A GArrowCSVReadOptions.	[nullable]
error	Return location for a GError or `NULL`.	[nullable]

Returns

A newly created GArrowCSVReader or NULL on error.

[nullable]

Since: 0.12.0

garrow_csv_reader_read ()

GArrowTable *
garrow_csv_reader_read (GArrowCSVReader *reader,
                        GError **error);

Parameters

reader	A GArrowCSVReader.
error	Return location for a GError or `NULL`.	[nullable]

Returns

A read GArrowTable or NULL on error.

[nullable][transfer full]

Since: 0.12.0

garrow_json_read_options_new ()

GArrowJSONReadOptions *
garrow_json_read_options_new (void);

Returns

A newly created GArrowJSONReadOptions.

Since: 0.14.0

garrow_json_reader_new ()

GArrowJSONReader *
garrow_json_reader_new (GArrowInputStream *input,
                        GArrowJSONReadOptions *options,
                        GError **error);

Parameters

input	The input to be read.
options	A GArrowJSONReadOptions.	[nullable]
error	Return location for a GError or `NULL`.	[nullable]

Returns

A newly created GArrowJSONReader or NULL on error.

[nullable]

Since: 0.14.0

garrow_json_reader_read ()

GArrowTable *
garrow_json_reader_read (GArrowJSONReader *reader,
                         GError **error);

Parameters

reader	A GArrowJSONReader.
error	Return location for a GError or `NULL`.	[nullable]

Returns

A read GArrowTable or NULL on error.

[nullable][transfer full]

Since: 0.14.0

Types and Values

GARROW_TYPE_RECORD_BATCH_READER

#define GARROW_TYPE_RECORD_BATCH_READER (garrow_record_batch_reader_get_type())

struct GArrowRecordBatchReaderClass

struct GArrowRecordBatchReaderClass {
  GObjectClass parent_class;
};

GARROW_TYPE_TABLE_BATCH_READER

#define GARROW_TYPE_TABLE_BATCH_READER (garrow_table_batch_reader_get_type())

struct GArrowTableBatchReaderClass

struct GArrowTableBatchReaderClass {
  GArrowRecordBatchReaderClass parent_class;
};

struct GArrowRecordBatchStreamReader

struct GArrowRecordBatchStreamReader;

It wraps arrow::ipc::RecordBatchStreamReader.

struct GArrowRecordBatchFileReader

struct GArrowRecordBatchFileReader;

It wraps arrow::ipc::RecordBatchFileReader.

GARROW_TYPE_FEATHER_FILE_READER

#define GARROW_TYPE_FEATHER_FILE_READER (garrow_feather_file_reader_get_type())

struct GArrowFeatherFileReaderClass

struct GArrowFeatherFileReaderClass {
  GObjectClass parent_class;
};

GARROW_TYPE_CSV_READ_OPTIONS

#define GARROW_TYPE_CSV_READ_OPTIONS (garrow_csv_read_options_get_type())

struct GArrowCSVReadOptionsClass

struct GArrowCSVReadOptionsClass {
  GObjectClass parent_class;
};

GARROW_TYPE_CSV_READER

#define GARROW_TYPE_CSV_READER (garrow_csv_reader_get_type())

struct GArrowCSVReaderClass

struct GArrowCSVReaderClass {
  GObjectClass parent_class;
};

enum GArrowJSONReadUnexpectedFieldBehavior

They are corresponding to arrow::json::UnexpectedFieldBehavior values.

Members

GARROW_JSON_READ_IGNORE	Ignore other fields.
GARROW_JSON_READ_ERROR	Return error.
GARROW_JSON_READ_INFER_TYPE	Infer a type.

GARROW_TYPE_JSON_READ_OPTIONS

#define GARROW_TYPE_JSON_READ_OPTIONS (garrow_json_read_options_get_type())

struct GArrowJSONReadOptionsClass

struct GArrowJSONReadOptionsClass {
  GObjectClass parent_class;
};

GARROW_TYPE_JSON_READER

#define GARROW_TYPE_JSON_READER (garrow_json_reader_get_type())

struct GArrowJSONReaderClass

struct GArrowJSONReaderClass {
  GObjectClass parent_class;
};

GArrowCSVReadOptions

typedef struct _GArrowCSVReadOptions GArrowCSVReadOptions;

GArrowCSVReader

typedef struct _GArrowCSVReader GArrowCSVReader;

GArrowFeatherFileReader

typedef struct _GArrowFeatherFileReader GArrowFeatherFileReader;

GArrowJSONReadOptions

typedef struct _GArrowJSONReadOptions GArrowJSONReadOptions;

GArrowJSONReader

typedef struct _GArrowJSONReader GArrowJSONReader;

GArrowRecordBatchReader

typedef struct _GArrowRecordBatchReader GArrowRecordBatchReader;

GArrowTableBatchReader

typedef struct _GArrowTableBatchReader GArrowTableBatchReader;

Property Details

The `“record-batch-file-reader”` property

  “record-batch-file-reader” gpointer

The raw std::shared<arrow::ipc::RecordBatchFileReader> *.

Owner: GArrowRecordBatchFileReader

Flags: Write / Construct Only

The `“allow-newlines-in-values”` property

  “allow-newlines-in-values” gboolean

Whether values are allowed to contain CR (0x0d) and LF (0x0a) characters.

Owner: GArrowCSVReadOptions

Flags: Read / Write

Default value: FALSE

Since: 0.12.0

The `“allow-null-strings”` property

  “allow-null-strings”       gboolean

Whether string / binary columns can have null values. If TRUE, then strings in "null_values" are considered null for string columns. If FALSE, then all strings are valid string values.

Owner: GArrowCSVReadOptions

Flags: Read / Write

Default value: FALSE

Since: 0.14.0

The `“block-size”` property

  “block-size”               int

Block size we request from the IO layer; also determines the size of chunks when “use-threads” is TRUE.

Owner: GArrowCSVReadOptions

Flags: Read / Write

Allowed values: >= 0

Default value: 1048576

Since: 0.12.0

The `“check-utf8”` property

  “check-utf8”               gboolean

Whether to check UTF8 validity of string columns.

Owner: GArrowCSVReadOptions

Flags: Read / Write

Default value: TRUE

Since: 0.12.0

The `“delimiter”` property

  “delimiter”                char

Field delimiter character.

Owner: GArrowCSVReadOptions

Flags: Read / Write

Allowed values: >= 0

Default value: 44

Since: 0.12.0

The `“escape-character”` property

  “escape-character”         char

Escaping character. This is used only when “is-escaped” is TRUE.

Owner: GArrowCSVReadOptions

Flags: Read / Write

Allowed values: >= 0

Default value: 92

Since: 0.12.0

The `“generate-column-names”` property

  “generate-column-names”    gboolean

Whether to autogenerate column names if column-names is empty. If TRUE, column names will be of the form 'f0', 'f1'... If FALSE, column names will be read from the first CSV row after n-skip-rows.

Owner: GArrowCSVReadOptions

Flags: Read / Write

Default value: FALSE

The `“ignore-empty-lines”` property

  “ignore-empty-lines”       gboolean

Whether empty lines are ignored. If FALSE, an empty line represents a simple empty value (assuming a one-column CSV file).

Owner: GArrowCSVReadOptions

Flags: Read / Write

Default value: TRUE

Since: 0.12.0

The `“is-double-quoted”` property

  “is-double-quoted”         gboolean

Whether a quote inside a value is double quoted.

Owner: GArrowCSVReadOptions

Flags: Read / Write

Default value: TRUE

Since: 0.12.0

The `“is-escaped”` property

  “is-escaped”               gboolean

Whether escaping is used.

Owner: GArrowCSVReadOptions

Flags: Read / Write

Default value: FALSE

Since: 0.12.0

The `“is-quoted”` property

  “is-quoted”                gboolean

Whether quoting is used.

Owner: GArrowCSVReadOptions

Flags: Read / Write

Default value: TRUE

Since: 0.12.0

The `“n-skip-rows”` property

  “n-skip-rows”              guint

The number of header rows to skip (not including the row of column names, if any)

Owner: GArrowCSVReadOptions

Flags: Read / Write

Default value: 0

Since: 0.15.0

The `“quote-character”` property

  “quote-character”          char

Quoting character. This is used only when “is-quoted” is TRUE.

Owner: GArrowCSVReadOptions

Flags: Read / Write

Allowed values: >= 0

Default value: 34

Since: 0.12.0

The `“use-threads”` property

  “use-threads”              gboolean

Whether to use the global CPU thread pool.

Owner: GArrowCSVReadOptions

Flags: Read / Write

Default value: TRUE

Since: 0.12.0

The `“csv-table-reader”` property

  “csv-table-reader”         gpointer

The raw std::shared<arrow::csv::TableReader> *.

Owner: GArrowCSVReader

Flags: Write / Construct Only

The `“input”` property

  “input”                    GArrowInputStream *

The input stream to be read.

Owner: GArrowCSVReader

Flags: Read / Write / Construct Only

The `“feather-reader”` property

  “feather-reader”           gpointer

The raw std::shared<arrow::ipc::feather::Reader> *.

Owner: GArrowFeatherFileReader

Flags: Write / Construct Only

The `“allow-newlines-in-values”` property

  “allow-newlines-in-values” gboolean

Whether objects may be printed across multiple lines (for example pretty printed). if FALSE, input must end with an empty line.

Owner: GArrowJSONReadOptions

Flags: Read / Write

Default value: FALSE

Since: 0.14.0

The `“block-size”` property

  “block-size”               int

Block size we request from the IO layer; also determines the size of chunks when “use-threads” is TRUE.

Owner: GArrowJSONReadOptions

Flags: Read / Write

Allowed values: >= 0

Default value: 1048576

Since: 0.14.0

The `“schema”` property

  “schema”                   GArrowSchema *

Schema for passing custom conversion rules.

Owner: GArrowJSONReadOptions

Flags: Read / Write

Since: 0.14.0

The `“unexpected-field-behavior”` property

  “unexpected-field-behavior” GArrowJSONReadUnexpectedFieldBehavior

How to parse handle fields outside the explicit schema.

Owner: GArrowJSONReadOptions

Flags: Read / Write

Default value: GARROW_JSON_READ_INFER_TYPE

Since: 0.14.0

The `“use-threads”` property

  “use-threads”              gboolean

Whether to use the global CPU thread pool.

Owner: GArrowJSONReadOptions

Flags: Read / Write

Default value: TRUE

Since: 0.14.0

The `“input”` property

  “input”                    GArrowInputStream *

The input stream to be read.

Owner: GArrowJSONReader

Flags: Read / Write / Construct Only

The `“json-table-reader”` property

  “json-table-reader”        gpointer

The raw std::shared<arrow::json::TableReader> *.

Owner: GArrowJSONReader

Flags: Write / Construct Only

The `“record-batch-reader”` property

  “record-batch-reader”      gpointer

The raw std::shared<arrow::ipc::RecordBatchRecordBatchReader> *.

Owner: GArrowRecordBatchReader

Flags: Write / Construct Only

The `“sources”` property

  “sources”                  gpointer

The sources of this reader.

Owner: GArrowRecordBatchReader

Flags: Write / Construct Only