Datum classes

Datum classes

Functions

gboolean garrow_datum_is_array ()
gboolean garrow_datum_is_array_like ()
gboolean garrow_datum_is_scalar ()
gboolean garrow_datum_is_value ()
gboolean garrow_datum_equal ()
gchar * garrow_datum_to_string ()
GArrowScalarDatum * garrow_scalar_datum_new ()
GArrowArrayDatum * garrow_array_datum_new ()
GArrowChunkedArrayDatum * garrow_chunked_array_datum_new ()
GArrowRecordBatchDatum * garrow_record_batch_datum_new ()
GArrowTableDatum * garrow_table_datum_new ()

Properties

GArrowArray * value Read / Write / Construct Only
GArrowChunkedArray * value Read / Write / Construct Only
gpointer datum Write / Construct Only
GArrowRecordBatch * value Read / Write / Construct Only
GArrowScalar * value Read / Write / Construct Only
GArrowTable * value Read / Write / Construct Only

Types and Values

#define GARROW_TYPE_DATUM
struct GArrowDatumClass
#define GARROW_TYPE_SCALAR_DATUM
struct GArrowScalarDatumClass
#define GARROW_TYPE_ARRAY_DATUM
struct GArrowArrayDatumClass
#define GARROW_TYPE_CHUNKED_ARRAY_DATUM
struct GArrowChunkedArrayDatumClass
#define GARROW_TYPE_RECORD_BATCH_DATUM
struct GArrowRecordBatchDatumClass
#define GARROW_TYPE_TABLE_DATUM
struct GArrowTableDatumClass
  GArrowArrayDatum
  GArrowChunkedArrayDatum
  GArrowDatum
  GArrowRecordBatchDatum
  GArrowScalarDatum
  GArrowTableDatum

Object Hierarchy

    GObject
    ╰── GArrowDatum
        ├── GArrowArrayDatum
        ├── GArrowChunkedArrayDatum
        ├── GArrowRecordBatchDatum
        ├── GArrowScalarDatum
        ├── GArrowTableDatum
        ├── GArrowArrayDatum
        ╰── GArrowChunkedArrayDatum

Includes

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

Description

GArrowDatum is an abstract class to hold a datum. Subclasses such as GArrowArrayDatum and GArrowTableDatum can hold a specific datum.

GArrowArrayDatum is a class to hold an GArrowArray.

GArrowChunkedArrayDatum is a class to hold an GArrowChunkedArray.

GArrowRecordBatchDatum is a class to hold an GArrowRecordBatch.

GArrowTableDatum is a class to hold an GArrowTable.

Functions

garrow_datum_is_array ()

gboolean
garrow_datum_is_array (GArrowDatum *datum);

Parameters

datum

A GArrowDatum.

  

Returns

TRUE if the datum holds a GArrowArray, FALSE otherwise.

Since: 1.0.0

garrow_datum_is_array_like ()

gboolean
garrow_datum_is_array_like (GArrowDatum *datum);

Parameters

datum

A GArrowDatum.

  

Returns

TRUE if the datum holds a GArrowArray or GArrowChunkedArray, FALSE otherwise.

Since: 1.0.0

garrow_datum_is_scalar ()

gboolean
garrow_datum_is_scalar (GArrowDatum *datum);

Parameters

datum

A GArrowDatum.

  

Returns

TRUE if the datum holds a GArrowScalar, FALSE otherwise.

Since: 5.0.0

garrow_datum_is_value ()

gboolean
garrow_datum_is_value (GArrowDatum *datum);

Parameters

datum

A GArrowDatum.

  

Returns

TRUE if the datum holds a GArrowArray, GArrowChunkedArray or GArrowScalar, FALSE otherwise.

Since: 5.0.0

garrow_datum_equal ()

gboolean
garrow_datum_equal (GArrowDatum *datum,
                    GArrowDatum *other_datum);

Parameters

datum

A GArrowDatum.

  

other_datum

A GArrowDatum to be compared.

  

Returns

TRUE if both of them have the same datum, FALSE otherwise.

Since: 1.0.0

garrow_datum_to_string ()

gchar *
garrow_datum_to_string (GArrowDatum *datum);

Parameters

datum

A GArrowDatum.

  

Returns

The formatted datum content.

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

Since: 1.0.0

garrow_scalar_datum_new ()

GArrowScalarDatum *
garrow_scalar_datum_new (GArrowScalar *value);

Parameters

value

A GArrowScalar.

  

Returns

A newly created GArrowScalarDatum.

Since: 5.0.0

garrow_array_datum_new ()

GArrowArrayDatum *
garrow_array_datum_new (GArrowArray *value);

Parameters

value

A GArrowArray.

  

Returns

A newly created GArrowArrayDatum.

Since: 1.0.0

garrow_chunked_array_datum_new ()

GArrowChunkedArrayDatum *
garrow_chunked_array_datum_new (GArrowChunkedArray *value);

Parameters

value

A GArrowChunkedArray.

  

Returns

A newly created GArrowChunkedArrayDatum.

Since: 1.0.0

garrow_record_batch_datum_new ()

GArrowRecordBatchDatum *
garrow_record_batch_datum_new (GArrowRecordBatch *value);

Parameters

value

A GArrowRecordBatch.

  

Returns

A newly created GArrowRecordBatchDatum.

Since: 1.0.0

garrow_table_datum_new ()

GArrowTableDatum *
garrow_table_datum_new (GArrowTable *value);

Parameters

value

A GArrowTable.

  

Returns

A newly created GArrowTableDatum.

Since: 1.0.0

Types and Values

GARROW_TYPE_DATUM

#define GARROW_TYPE_DATUM (garrow_datum_get_type())

struct GArrowDatumClass

struct GArrowDatumClass {
  GObjectClass parent_class;
};

GARROW_TYPE_SCALAR_DATUM

#define GARROW_TYPE_SCALAR_DATUM (garrow_scalar_datum_get_type())

struct GArrowScalarDatumClass

struct GArrowScalarDatumClass {
  GArrowDatumClass parent_class;
};

GARROW_TYPE_ARRAY_DATUM

#define GARROW_TYPE_ARRAY_DATUM (garrow_array_datum_get_type())

struct GArrowArrayDatumClass

struct GArrowArrayDatumClass {
  GArrowDatumClass parent_class;
};

GARROW_TYPE_CHUNKED_ARRAY_DATUM

#define GARROW_TYPE_CHUNKED_ARRAY_DATUM (garrow_chunked_array_datum_get_type())

struct GArrowChunkedArrayDatumClass

struct GArrowChunkedArrayDatumClass {
  GArrowDatumClass parent_class;
};

GARROW_TYPE_RECORD_BATCH_DATUM

#define GARROW_TYPE_RECORD_BATCH_DATUM (garrow_record_batch_datum_get_type())

struct GArrowRecordBatchDatumClass

struct GArrowRecordBatchDatumClass {
  GArrowDatumClass parent_class;
};

GARROW_TYPE_TABLE_DATUM

#define GARROW_TYPE_TABLE_DATUM (garrow_table_datum_get_type())

struct GArrowTableDatumClass

struct GArrowTableDatumClass {
  GArrowDatumClass parent_class;
};

GArrowArrayDatum

typedef struct _GArrowArrayDatum GArrowArrayDatum;

GArrowChunkedArrayDatum

typedef struct _GArrowChunkedArrayDatum GArrowChunkedArrayDatum;

GArrowDatum

typedef struct _GArrowDatum GArrowDatum;

GArrowRecordBatchDatum

typedef struct _GArrowRecordBatchDatum GArrowRecordBatchDatum;

GArrowScalarDatum

typedef struct _GArrowScalarDatum GArrowScalarDatum;

GArrowTableDatum

typedef struct _GArrowTableDatum GArrowTableDatum;

Property Details

The “value” property

  “value”                    GArrowArray *

The array held by this datum.

Owner: GArrowArrayDatum

Flags: Read / Write / Construct Only

The “value” property

  “value”                    GArrowChunkedArray *

The chunked array held by this datum.

Owner: GArrowChunkedArrayDatum

Flags: Read / Write / Construct Only

The “datum” property

  “datum”                    gpointer

The raw arrow::Datum *.

Owner: GArrowDatum

Flags: Write / Construct Only

The “value” property

  “value”                    GArrowRecordBatch *

The chunked array held by this datum.

Owner: GArrowRecordBatchDatum

Flags: Read / Write / Construct Only

The “value” property

  “value”                    GArrowScalar *

The scalar held by this datum.

Owner: GArrowScalarDatum

Flags: Read / Write / Construct Only

The “value” property

  “value”                    GArrowTable *

The table held by this datum.

Owner: GArrowTableDatum

Flags: Read / Write / Construct Only

Generated by GTK-Doc V1.32