ORC reader

ORC reader

Functions

GArrowORCFileReader * garrow_orc_file_reader_new ()
void garrow_orc_file_reader_set_field_indexes ()
void garrow_orc_file_reader_set_field_indices ()
const gint * garrow_orc_file_reader_get_field_indexes ()
const gint * garrow_orc_file_reader_get_field_indices ()
GArrowSchema * garrow_orc_file_reader_read_type ()
GArrowTable * garrow_orc_file_reader_read_stripes ()
GArrowRecordBatch * garrow_orc_file_reader_read_stripe ()
gint64 garrow_orc_file_reader_get_n_stripes ()
gint64 garrow_orc_file_reader_get_n_rows ()

Properties

GArrowSeekableInputStream * input Read / Write / Construct Only
gpointer orc-file-reader Write / Construct Only

Types and Values

#define GARROW_TYPE_ORC_FILE_READER
struct GArrowORCFileReaderClass
  GArrowORCFileReader

Object Hierarchy

    GObject
    ╰── GArrowORCFileReader

Includes

#include <arrow-glib/orc-file-reader.h>

Description

GArrowORCFileReader is a class for reading stripes in ORC file format from input.

Functions

garrow_orc_file_reader_new ()

GArrowORCFileReader *
garrow_orc_file_reader_new (GArrowSeekableInputStream *file,
                            GError **error);

Parameters

file

The file to be read.

  

error

Return location for a GError or NULL.

[nullable]

Returns

A newly created GArrowORCFileReader or NULL on error.

[nullable]

Since: 0.10.0

garrow_orc_file_reader_set_field_indexes ()

void
garrow_orc_file_reader_set_field_indexes
                               (GArrowORCFileReader *reader,
                                const gint *field_indexes,
                                guint n_field_indexes);

garrow_orc_file_reader_set_field_indexes has been deprecated since version 0.12.0 and should not be used in newly-written code.

Use garrow_orc_file_reader_set_field_indices() instead.

Parameters

reader

A GArrowORCFileReader.

  

field_indexes

The field indexes to be read.

[nullable][array length=n_field_indexes]

n_field_indexes

The number of the specified indexes.

  

Since: 0.10.0

garrow_orc_file_reader_set_field_indices ()

void
garrow_orc_file_reader_set_field_indices
                               (GArrowORCFileReader *reader,
                                const gint *field_indices,
                                guint n_field_indices);

Parameters

reader

A GArrowORCFileReader.

  

field_indices

The field indices to be read.

[nullable][array length=n_field_indices]

n_field_indices

The number of the specified indices.

  

Since: 0.12.0

garrow_orc_file_reader_get_field_indexes ()

const gint *
garrow_orc_file_reader_get_field_indexes
                               (GArrowORCFileReader *reader,
                                guint *n_field_indexes);

garrow_orc_file_reader_get_field_indexes has been deprecated since version 0.12.0 and should not be used in newly-written code.

Use garrow_orc_file_reader_get_field_indices() instead.

Parameters

reader

A GArrowORCFileReader.

  

n_field_indexes

The number of the specified indexes.

  

Returns

The field indexes to be read.

[nullable][array length=n_field_indexes][transfer none]

Since: 0.10.0

garrow_orc_file_reader_get_field_indices ()

const gint *
garrow_orc_file_reader_get_field_indices
                               (GArrowORCFileReader *reader,
                                guint *n_field_indices);

Parameters

reader

A GArrowORCFileReader.

  

n_field_indices

The number of the specified indices.

  

Returns

The field indices to be read.

[nullable][array length=n_field_indices][transfer none]

Since: 0.12.0

garrow_orc_file_reader_read_type ()

GArrowSchema *
garrow_orc_file_reader_read_type (GArrowORCFileReader *reader,
                                  GError **error);

Parameters

reader

A GArrowORCFileReader.

  

error

Return location for a GError or NULL.

[nullable]

Returns

A newly read type as GArrowSchema or NULL on error.

[nullable][transfer full]

Since: 0.10.0

garrow_orc_file_reader_read_stripes ()

GArrowTable *
garrow_orc_file_reader_read_stripes (GArrowORCFileReader *reader,
                                     GError **error);

Parameters

reader

A GArrowORCFileReader.

  

error

Return location for a GError or NULL.

[nullable]

Returns

A newly read stripes as GArrowTable or NULL on error.

[nullable][transfer full]

Since: 0.10.0

garrow_orc_file_reader_read_stripe ()

GArrowRecordBatch *
garrow_orc_file_reader_read_stripe (GArrowORCFileReader *reader,
                                    gint64 i,
                                    GError **error);

Parameters

reader

A GArrowORCFileReader.

  

i

The stripe index to be read.

  

error

Return location for a GError or NULL.

[nullable]

Returns

A newly read stripe as GArrowRecordBatch or NULL on error.

[nullable][transfer full]

Since: 0.10.0

garrow_orc_file_reader_get_n_stripes ()

gint64
garrow_orc_file_reader_get_n_stripes (GArrowORCFileReader *reader);

Parameters

reader

A GArrowORCFileReader.

  

Returns

The number of stripes in the file.

Since: 0.10.0

garrow_orc_file_reader_get_n_rows ()

gint64
garrow_orc_file_reader_get_n_rows (GArrowORCFileReader *reader);

Parameters

reader

A GArrowORCFileReader.

  

Returns

The number of rows in the file.

Since: 0.10.0

Types and Values

GARROW_TYPE_ORC_FILE_READER

#define GARROW_TYPE_ORC_FILE_READER (garrow_orc_file_reader_get_type())

struct GArrowORCFileReaderClass

struct GArrowORCFileReaderClass {
  GObjectClass parent_class;
};

GArrowORCFileReader

typedef struct _GArrowORCFileReader GArrowORCFileReader;

Property Details

The “input” property

  “input”                    GArrowSeekableInputStream *

The input stream.

Owner: GArrowORCFileReader

Flags: Read / Write / Construct Only

The “orc-file-reader” property

  “orc-file-reader”          gpointer

The raw arrow::adapters::orc::ORCFileReader *.

Owner: GArrowORCFileReader

Flags: Write / Construct Only

Generated by GTK-Doc V1.32