Reference Manual: GArrowFileWriter

GArrowFileWriter

GArrowFileWriter — File writer class

Functions

GArrowFileWriter *	garrow_file_writer_open ()
gboolean	garrow_file_writer_write_record_batch ()
gboolean	garrow_file_writer_close ()

Types and Values

struct

GArrowFileWriter

Object Hierarchy

    GObject
    ╰── GArrowStreamWriter
        ╰── GArrowFileWriter

Description

GArrowFileWriter is a class for sending data by file based IPC.

Functions

garrow_file_writer_open ()

GArrowFileWriter *
garrow_file_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 GArrowFileWriter or NULL on error.

[nullable][transfer full]

garrow_file_writer_write_record_batch ()

gboolean
garrow_file_writer_write_record_batch (GArrowFileWriter *file_writer,
                                       GArrowRecordBatch *record_batch,
                                       GError **error);

Parameters

file_writer	A GArrowFileWriter.
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_file_writer_close ()

gboolean
garrow_file_writer_close (GArrowFileWriter *file_writer,
                          GError **error);

Parameters

file_writer	A GArrowFileWriter.
error	Return locatipcn for a GError or `NULL`.	[nullable]

Returns

TRUE on success, FALSE if there was an error.

Types and Values

struct GArrowFileWriter

struct GArrowFileWriter;

It wraps arrow::ipc::FileWriter.