GArrowFileReader

GArrowFileReader — File reader class

Functions

Properties

gpointer file-reader Write / Construct Only

Types and Values

Object Hierarchy

    GObject
    ╰── GArrowFileReader

Description

GArrowFileReader is a class for receiving data by file based IPC.

Functions

garrow_file_reader_open ()

GArrowFileReader *
garrow_file_reader_open (GArrowRandomAccessFile *file,
                         GError **error);

Parameters

file

The file to be read.

 

error

Return locatipcn for a GError or NULL.

[nullable]

Returns

A newly opened GArrowFileReader or NULL on error.

[nullable][transfer full]


garrow_file_reader_get_schema ()

GArrowSchema *
garrow_file_reader_get_schema (GArrowFileReader *file_reader);

Parameters

file_reader

A GArrowFileReader.

 

Returns

The schema in the file.

[transfer full]


garrow_file_reader_get_n_record_batches ()

guint
garrow_file_reader_get_n_record_batches
                               (GArrowFileReader *file_reader);

Parameters

file_reader

A GArrowFileReader.

 

Returns

The number of record batches in the file.


garrow_file_reader_get_version ()

GArrowMetadataVersion
garrow_file_reader_get_version (GArrowFileReader *file_reader);

Parameters

file_reader

A GArrowFileReader.

 

Returns

The format version in the file.


garrow_file_reader_get_record_batch ()

GArrowRecordBatch *
garrow_file_reader_get_record_batch (GArrowFileReader *file_reader,
                                     guint i,
                                     GError **error);

Parameters

file_reader

A GArrowFileReader.

 

i

The index of the target record batch.

 

error

Return locatipcn for a GError or NULL.

[nullable]

Returns

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

[nullable][transfer full]

Types and Values

struct GArrowFileReader

struct GArrowFileReader;

It wraps arrow::ipc::FileReader.

Property Details

The “file-reader” property

  “file-reader”              gpointer

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

Flags: Write / Construct Only