GArrowField

GArrowField — Field class

Functions

Properties

gpointer field Write / Construct Only

Types and Values

struct GArrowField

Object Hierarchy

    GObject
    ╰── GArrowField

Description

GArrowField is a class for field. Field is metadata of a column. It has name, data type (GArrowDataType) and nullable information of the column.

Functions

garrow_field_new ()

GArrowField *
garrow_field_new (const gchar *name,
                  GArrowDataType *data_type);

Parameters

name

The name of the field.

 

data_type

The data type of the field.

 

Returns

A newly created GArrowField.


garrow_field_new_full ()

GArrowField *
garrow_field_new_full (const gchar *name,
                       GArrowDataType *data_type,
                       gboolean nullable);

Parameters

name

The name of the field.

 

data_type

The data type of the field.

 

nullable

Whether null may be included or not.

 

Returns

A newly created GArrowField.


garrow_field_get_name ()

const gchar *
garrow_field_get_name (GArrowField *field);

Parameters

field

A GArrowField.

 

Returns

The name of the field.


garrow_field_get_data_type ()

GArrowDataType *
garrow_field_get_data_type (GArrowField *field);

Parameters

field

A GArrowField.

 

Returns

The data type of the field.

[transfer full]


garrow_field_is_nullable ()

gboolean
garrow_field_is_nullable (GArrowField *field);

Parameters

field

A GArrowField.

 

Returns

Whether the filed may include null or not.


garrow_field_equal ()

gboolean
garrow_field_equal (GArrowField *field,
                    GArrowField *other_field);

Parameters

field

A GArrowField.

 

other_field

A GArrowField to be compared.

 

Returns

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


garrow_field_to_string ()

gchar *
garrow_field_to_string (GArrowField *field);

Parameters

field

A GArrowField.

 

Returns

The string representation of the field.

Types and Values

struct GArrowField

struct GArrowField;

It wraps arrow::Field.

Property Details

The “field” property

  “field”                    gpointer

The raw std::shared<arrow::Field> *.

Flags: Write / Construct Only