GArrowStreamWriter

GArrowStreamWriter — Stream writer class

Functions

Properties

gpointer stream-writer Write / Construct Only

Types and Values

Object Hierarchy

    GObject
    ╰── GArrowStreamWriter
        ╰── GArrowFileWriter

Description

GArrowStreamWriter is a class for sending data by stream based IPC.

Functions

garrow_stream_writer_open ()

GArrowStreamWriter *
garrow_stream_writer_open (GArrowOutputStream *sink,
                           GArrowSchema *schema,
                           GError **error);

Parameters

sink

The output of the writer.

 

schema

The schema of the writer.

 

error

Return locatipcn for a GError or NULL.

[nullable]

Returns

A newly opened GArrowStreamWriter or NULL on error.

[nullable][transfer full]


garrow_stream_writer_write_record_batch ()

gboolean
garrow_stream_writer_write_record_batch
                               (GArrowStreamWriter *stream_writer,
                                GArrowRecordBatch *record_batch,
                                GError **error);

Parameters

stream_writer

A GArrowStreamWriter.

 

record_batch

The record batch to be written.

 

error

Return locatipcn for a GError or NULL.

[nullable]

Returns

TRUE on success, FALSE if there was an error.


garrow_stream_writer_close ()

gboolean
garrow_stream_writer_close (GArrowStreamWriter *stream_writer,
                            GError **error);

Parameters

stream_writer

A GArrowStreamWriter.

 

error

Return locatipcn for a GError or NULL.

[nullable]

Returns

TRUE on success, FALSE if there was an error.

Types and Values

struct GArrowStreamWriter

struct GArrowStreamWriter;

It wraps arrow::ipc::StreamWriter.

Property Details

The “stream-writer” property

  “stream-writer”            gpointer

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

Flags: Write / Construct Only