GArrowIPCFileReader

GArrowIPCFileReader — File reader class

Functions

Properties

gpointer file-reader Write / Construct Only

Types and Values

Object Hierarchy

    GObject
    ╰── GArrowIPCFileReader

Description

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

Functions

garrow_ipc_file_reader_open ()

GArrowIPCFileReader *
garrow_ipc_file_reader_open (GArrowIORandomAccessFile *file,
                             GError **error);

Parameters

file

The file to be read.

 

error

Return locatipcn for a GError or NULL.

[nullable]

Returns

A newly opened GArrowIPCFileReader or NULL on error.

[nullable][transfer full]


garrow_ipc_file_reader_get_schema ()

GArrowSchema *
garrow_ipc_file_reader_get_schema (GArrowIPCFileReader *file_reader);

Parameters

file_reader

A GArrowIPCFileReader.

 

Returns

The schema in the file.

[transfer full]


garrow_ipc_file_reader_get_n_record_batches ()

guint
garrow_ipc_file_reader_get_n_record_batches
                               (GArrowIPCFileReader *file_reader);

Parameters

file_reader

A GArrowIPCFileReader.

 

Returns

The number of record batches in the file.


garrow_ipc_file_reader_get_version ()

GArrowIPCMetadataVersion
garrow_ipc_file_reader_get_version (GArrowIPCFileReader *file_reader);

Parameters

file_reader

A GArrowIPCFileReader.

 

Returns

The format version in the file.


garrow_ipc_file_reader_get_record_batch ()

GArrowRecordBatch *
garrow_ipc_file_reader_get_record_batch
                               (GArrowIPCFileReader *file_reader,
                                guint i,
                                GError **error);

Parameters

file_reader

A GArrowIPCFileReader.

 

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 GArrowIPCFileReader

struct GArrowIPCFileReader;

It wraps arrow::ipc::FileReader.


struct GArrowIPCFileReaderClass

struct GArrowIPCFileReaderClass {
  GObjectClass parent_class;
};

Property Details

The “file-reader” property

  “file-reader”              gpointer

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

Flags: Write / Construct Only