File format classes

File format classes

Functions

Properties

gpointer format Write / Construct Only
gpointer options Write / Construct Only
gpointer writer Write / Construct Only

Types and Values

Object Hierarchy

    GObject
    ├── GADatasetFileFormat
       ├── GADatasetCSVFileFormat
       ├── GADatasetIPCFileFormat
       ├── GADatasetParquetFileFormat
       ╰── GADatasetCSVFileFormat
    ├── GADatasetFileWriteOptions
    ╰── GADatasetFileWriter

Includes

#include <arrow-dataset-glib/arrow-dataset-glib.h>

Description

GADatasetFileWriteOptions is a class for options to write a file of this format.

GADatasetFileWriter is a class for writing a file of this format.

GADatasetFileFormat is a base class for file format classes.

GADatasetCSVFileFormat is a class for CSV file format.

GADatasetIPCFileFormat is a class for IPC file format.

GADatasetParquetFileFormat is a class for Parquet file format.

Functions

gadataset_file_writer_write_record_batch ()

gboolean
gadataset_file_writer_write_record_batch
                               (GADatasetFileWriter *writer,
                                GArrowRecordBatch *record_batch,
                                GError **error);

Parameters

writer

A GADatasetFileWriter.

 

record_batch

A GArrowRecordBatch to be written.

 

error

Return location for a GError or NULL.

[nullable]

Returns

TRUE on success, FALSE on error.

Since: 6.0.0

gadataset_file_writer_write_record_batch_reader ()

gboolean
gadataset_file_writer_write_record_batch_reader
                               (GADatasetFileWriter *writer,
                                GArrowRecordBatchReader *reader,
                                GError **error);

Parameters

writer

A GADatasetFileWriter.

 

reader

A GArrowRecordBatchReader to be written.

 

error

Return location for a GError or NULL.

[nullable]

Returns

TRUE on success, FALSE on error.

Since: 6.0.0

gadataset_file_writer_finish ()

gboolean
gadataset_file_writer_finish (GADatasetFileWriter *writer,
                              GError **error);

Parameters

writer

A GADatasetFileWriter.

 

error

Return location for a GError or NULL.

[nullable]

Returns

TRUE on success, FALSE on error.

Since: 6.0.0

gadataset_file_format_get_type_name ()

gchar *
gadataset_file_format_get_type_name (GADatasetFileFormat *format);

Parameters

format

A GADatasetFileFormat.

 

Returns

The type name of format .

It should be freed with g_free() when no longer needed.

Since: 3.0.0

gadataset_file_format_get_default_write_options ()

GADatasetFileWriteOptions *
gadataset_file_format_get_default_write_options
                               (GADatasetFileFormat *format);

Parameters

format

A GADatasetFileFormat.

 

Returns

The default GADatasetFileWriteOptions of format .

[transfer full]

Since: 6.0.0

gadataset_file_format_open_writer ()

GADatasetFileWriter *
gadataset_file_format_open_writer (GADatasetFileFormat *format,
                                   GArrowOutputStream *destination,
                                   GArrowFileSystem *file_system,
                                   const gchar *path,
                                   GArrowSchema *schema,
                                   GADatasetFileWriteOptions *options,
                                   GError **error);

Parameters

format

A GADatasetFileFormat.

 

destination

A GArrowOutputStream.

 

file_system

The GArrowFileSystem of destination .

 

path

The path of destination .

 

schema

A GArrowSchema that is used by written record batches.

 

options

A GADatasetFileWriteOptions.

 

error

Return location for a GError or NULL.

[nullable]

Returns

The newly created GADatasetFileWriter of format on success, NULL on error.

[transfer full]

Since: 6.0.0

gadataset_file_format_equal ()

gboolean
gadataset_file_format_equal (GADatasetFileFormat *format,
                             GADatasetFileFormat *other_format);

Parameters

format

A GADatasetFileFormat.

 

other_format

A GADatasetFileFormat to be compared.

 

Returns

TRUE if they are the same content file format, FALSE otherwise.

Since: 3.0.0

gadataset_csv_file_format_new ()

GADatasetCSVFileFormat *
gadataset_csv_file_format_new (void);

Returns

The newly created CSV file format.

Since: 3.0.0

gadataset_ipc_file_format_new ()

GADatasetIPCFileFormat *
gadataset_ipc_file_format_new (void);

Returns

The newly created IPC file format.

Since: 3.0.0

gadataset_parquet_file_format_new ()

GADatasetParquetFileFormat *
gadataset_parquet_file_format_new (void);

Returns

The newly created Parquet file format.

Since: 3.0.0

Types and Values

GADATASET_TYPE_FILE_WRITE_OPTIONS

#define             GADATASET_TYPE_FILE_WRITE_OPTIONS

struct GADatasetFileWriteOptionsClass

struct GADatasetFileWriteOptionsClass {
  GObjectClass parent_class;
};

GADATASET_TYPE_FILE_WRITER

#define             GADATASET_TYPE_FILE_WRITER

struct GADatasetFileWriterClass

struct GADatasetFileWriterClass {
  GObjectClass parent_class;
};

GADATASET_TYPE_FILE_FORMAT

#define GADATASET_TYPE_FILE_FORMAT (gadataset_file_format_get_type())

struct GADatasetFileFormatClass

struct GADatasetFileFormatClass {
  GObjectClass parent_class;
};

GADATASET_TYPE_CSV_FILE_FORMAT

#define GADATASET_TYPE_CSV_FILE_FORMAT (gadataset_csv_file_format_get_type())

struct GADatasetCSVFileFormatClass

struct GADatasetCSVFileFormatClass {
  GADatasetFileFormatClass parent_class;
};

GADATASET_TYPE_IPC_FILE_FORMAT

#define GADATASET_TYPE_IPC_FILE_FORMAT (gadataset_ipc_file_format_get_type())

struct GADatasetIPCFileFormatClass

struct GADatasetIPCFileFormatClass {
  GADatasetFileFormatClass parent_class;
};

GADATASET_TYPE_PARQUET_FILE_FORMAT

#define             GADATASET_TYPE_PARQUET_FILE_FORMAT

struct GADatasetParquetFileFormatClass

struct GADatasetParquetFileFormatClass {
  GADatasetFileFormatClass parent_class;
};

GADatasetCSVFileFormat

typedef struct _GADatasetCSVFileFormat GADatasetCSVFileFormat;

GADatasetFileFormat

typedef struct _GADatasetFileFormat GADatasetFileFormat;

GADatasetFileWriteOptions

typedef struct _GADatasetFileWriteOptions GADatasetFileWriteOptions;

GADatasetFileWriter

typedef struct _GADatasetFileWriter GADatasetFileWriter;

GADatasetIPCFileFormat

typedef struct _GADatasetIPCFileFormat GADatasetIPCFileFormat;

GADatasetParquetFileFormat

typedef struct _GADatasetParquetFileFormat GADatasetParquetFileFormat;

Property Details

The “format” property

  “format”                   gpointer

The raw std::shared<arrow::dataset::FileFormat> *.

Owner: GADatasetFileFormat

Flags: Write / Construct Only

The “options” property

  “options”                  gpointer

The raw std::shared<arrow::dataset::FileWriteOptions> *.

Owner: GADatasetFileWriteOptions

Flags: Write / Construct Only

The “writer” property

  “writer”                   gpointer

The raw std::shared<arrow::dataset::FileWriter> *.

Owner: GADatasetFileWriter

Flags: Write / Construct Only