GArrowStreamReader

GArrowStreamReader — Stream reader class

Functions

Properties

gpointer stream-reader Write / Construct Only

Types and Values

Object Hierarchy

    GObject
    ╰── GArrowStreamReader

Description

GArrowStreamReader is a class for receiving data by stream based IPC.

Functions

garrow_stream_reader_open ()

GArrowStreamReader *
garrow_stream_reader_open (GArrowInputStream *stream,
                           GError **error);

Parameters

stream

The stream to be read.

 

error

Return locatipcn for a GError or NULL.

[nullable]

Returns

A newly opened GArrowStreamReader or NULL on error.

[nullable][transfer full]


garrow_stream_reader_get_schema ()

GArrowSchema *
garrow_stream_reader_get_schema (GArrowStreamReader *stream_reader);

Parameters

stream_reader

A GArrowStreamReader.

 

Returns

The schema in the stream.

[transfer full]


garrow_stream_reader_get_next_record_batch ()

GArrowRecordBatch *
garrow_stream_reader_get_next_record_batch
                               (GArrowStreamReader *stream_reader,
                                GError **error);

Parameters

stream_reader

A GArrowStreamReader.

 

error

Return locatipcn for a GError or NULL.

[nullable]

Returns

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

[nullable][transfer full]

Types and Values

struct GArrowStreamReader

struct GArrowStreamReader;

It wraps arrow::ipc::StreamReader.

Property Details

The “stream-reader” property

  “stream-reader”            gpointer

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

Flags: Write / Construct Only