GParquetArrowFileReader

GParquetArrowFileReader — Arrow file reader class

Functions

GParquetArrowFileReader * gparquet_arrow_file_reader_new_arrow ()
GParquetArrowFileReader * gparquet_arrow_file_reader_new_path ()
GArrowTable * gparquet_arrow_file_reader_read_table ()
GArrowTable * gparquet_arrow_file_reader_read_row_group ()
GArrowSchema * gparquet_arrow_file_reader_get_schema ()
GArrowChunkedArray * gparquet_arrow_file_reader_read_column_data ()
gint gparquet_arrow_file_reader_get_n_row_groups ()
gint64 gparquet_arrow_file_reader_get_n_rows ()
void gparquet_arrow_file_reader_set_use_threads ()
GParquetFileMetadata * gparquet_arrow_file_reader_get_metadata ()

Properties

gpointer arrow-file-reader Write / Construct Only

Types and Values

#define GPARQUET_TYPE_ARROW_FILE_READER
struct GParquetArrowFileReaderClass
  GParquetArrowFileReader

Object Hierarchy

    GObject
    ╰── GParquetArrowFileReader

Includes

#include <parquet-glib/parquet-glib.h>

Description

GParquetArrowFileReader is a class for reading Apache Parquet data from file and returns them as Apache Arrow data.

Functions

gparquet_arrow_file_reader_new_arrow ()

GParquetArrowFileReader *
gparquet_arrow_file_reader_new_arrow (GArrowSeekableInputStream *source,
                                      GError **error);

Parameters

source

Arrow source to be read.

  

error

Return locatipcn for a GError or NULL.

[nullable]

Returns

A newly created GParquetArrowFileReader.

[nullable]

Since: 0.11.0

gparquet_arrow_file_reader_new_path ()

GParquetArrowFileReader *
gparquet_arrow_file_reader_new_path (const gchar *path,
                                     GError **error);

Parameters

path

Path to be read.

  

error

Return locatipcn for a GError or NULL.

[nullable]

Returns

A newly created GParquetArrowFileReader.

[nullable]

Since: 0.11.0

gparquet_arrow_file_reader_read_table ()

GArrowTable *
gparquet_arrow_file_reader_read_table (GParquetArrowFileReader *reader,
                                       GError **error);

Parameters

reader

A GParquetArrowFileReader.

  

error

Return locatipcn for a GError or NULL.

[nullable]

Returns

A read GArrowTable.

[transfer full][nullable]

Since: 0.11.0

gparquet_arrow_file_reader_read_row_group ()

GArrowTable *
gparquet_arrow_file_reader_read_row_group
                               (GParquetArrowFileReader *reader,
                                gint row_group_index,
                                gint *column_indices,
                                gsize n_column_indices,
                                GError **error);

Parameters

reader

A GParquetArrowFileReader.

  

row_group_index

A row group index to be read.

  

column_indices

Column indices to be read. NULL means that all columns are read. If an index is negative, the index is counted backward from the end of the columns. -1 means the last column.

[array length=n_column_indices][nullable]

n_column_indices

The number of elements of column_indices .

  

error

Return locatipcn for a GError or NULL.

[nullable]

Returns

A read GArrowTable.

[transfer full][nullable]

Since: 1.0.0

gparquet_arrow_file_reader_get_schema ()

GArrowSchema *
gparquet_arrow_file_reader_get_schema (GParquetArrowFileReader *reader,
                                       GError **error);

Parameters

reader

A GParquetArrowFileReader.

  

error

Return locatipcn for a GError or NULL.

[nullable]

Returns

A got GArrowSchema.

[transfer full][nullable]

Since: 0.12.0

gparquet_arrow_file_reader_read_column_data ()

GArrowChunkedArray *
gparquet_arrow_file_reader_read_column_data
                               (GParquetArrowFileReader *reader,
                                gint i,
                                GError **error);

Parameters

reader

A GParquetArrowFileReader.

  

i

The index of the column to be read. If an index is negative, the index is counted backward from the end of the columns. -1 means the last column.

  

error

Return locatipcn for a GError or NULL.

[nullable]

Returns

A read GArrowChunkedArray.

[transfer full][nullable]

Since: 0.15.0

gparquet_arrow_file_reader_get_n_row_groups ()

gint
gparquet_arrow_file_reader_get_n_row_groups
                               (GParquetArrowFileReader *reader);

Parameters

reader

A GParquetArrowFileReader.

  

Returns

The number of row groups.

Since: 0.11.0

gparquet_arrow_file_reader_get_n_rows ()

gint64
gparquet_arrow_file_reader_get_n_rows (GParquetArrowFileReader *reader);

Parameters

reader

A GParquetArrowFileReader.

  

Returns

The number of rows.

Since: 6.0.0

gparquet_arrow_file_reader_set_use_threads ()

void
gparquet_arrow_file_reader_set_use_threads
                               (GParquetArrowFileReader *reader,
                                gboolean use_threads);

gparquet_arrow_file_reader_get_metadata ()

GParquetFileMetadata *
gparquet_arrow_file_reader_get_metadata
                               (GParquetArrowFileReader *reader);

Parameters

reader

A GParquetArrowFileReader.

  

Returns

The metadata.

[transfer full]

Since: 8.0.0

Types and Values

GPARQUET_TYPE_ARROW_FILE_READER

#define GPARQUET_TYPE_ARROW_FILE_READER (gparquet_arrow_file_reader_get_type())

struct GParquetArrowFileReaderClass

struct GParquetArrowFileReaderClass {
  GObjectClass parent_class;
};

GParquetArrowFileReader

typedef struct _GParquetArrowFileReader GParquetArrowFileReader;

Property Details

The “arrow-file-reader” property

  “arrow-file-reader”        gpointer

The raw parquet::arrow::FileReader *.

Owner: GParquetArrowFileReader

Flags: Write / Construct Only

Generated by GTK-Doc V1.32