Composite data type classes: arrow-glib Reference Manual

Composite data type classes

Functions

GArrowListDataType *	garrow_list_data_type_new ()
GArrowField *	garrow_list_data_type_get_value_field ()
GArrowStructDataType *	garrow_struct_data_type_new ()
GArrowDictionaryDataType *	garrow_dictionary_data_type_new ()
GArrowDataType *	garrow_dictionary_data_type_get_index_data_type ()
GArrowArray *	garrow_dictionary_data_type_get_dictionary ()
gboolean	garrow_dictionary_data_type_is_ordered ()

Types and Values

struct	GArrowListDataType
struct	GArrowStructDataType
#define	GARROW_TYPE_DICTIONARY_DATA_TYPE
struct	GArrowDictionaryDataTypeClass
	GArrowDictionaryDataType

Object Hierarchy

    GObject
    ╰── GArrowDataType
        ├── GArrowFixedWidthDataType
        │   ╰── GArrowDictionaryDataType
        ├── GArrowListDataType
        ╰── GArrowStructDataType

Includes

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

Description

GArrowListDataType is a class for list data type.

GArrowStructDataType is a class for struct data type.

GArrowDictionaryDataType is a class for dictionary data type.

Functions

garrow_list_data_type_new ()

GArrowListDataType *
garrow_list_data_type_new (GArrowField *field);

Parameters

field

The field of elements

Returns

The newly created list data type.

garrow_list_data_type_get_value_field ()

GArrowField *
garrow_list_data_type_get_value_field (GArrowListDataType *list_data_type);

Parameters

list_data_type

A GArrowListDataType.

Returns

The field of value.

[transfer full]

garrow_struct_data_type_new ()

GArrowStructDataType *
garrow_struct_data_type_new (GList *fields);

Parameters

fields

The fields of the struct.

[element-type GArrowField]

Returns

The newly created struct data type.

garrow_dictionary_data_type_new ()

GArrowDictionaryDataType *
garrow_dictionary_data_type_new (GArrowDataType *index_data_type,
                                 GArrowArray *dictionary,
                                 gboolean ordered);

Parameters

index_data_type	The data type of index.
dictionary	The dictionary.
ordered	Whether dictionary contents are ordered or not.

Returns

The newly created dictionary data type.

Since: 0.8.0

garrow_dictionary_data_type_get_index_data_type ()

GArrowDataType *
garrow_dictionary_data_type_get_index_data_type
                               (GArrowDictionaryDataType *data_type);

Parameters

data_type

The GArrowDictionaryDataType.

Returns

The GArrowDataType of index.

[transfer full]

Since: 0.8.0

garrow_dictionary_data_type_get_dictionary ()

GArrowArray *
garrow_dictionary_data_type_get_dictionary
                               (GArrowDictionaryDataType *data_type);

Parameters

data_type

The GArrowDictionaryDataType.

Returns

The dictionary as GArrowArray.

[transfer full]

Since: 0.8.0

garrow_dictionary_data_type_is_ordered ()

gboolean
garrow_dictionary_data_type_is_ordered
                               (GArrowDictionaryDataType *data_type);

Parameters

data_type

The GArrowDictionaryDataType.

Returns

Whether dictionary contents are ordered or not.

Since: 0.8.0

Types and Values

struct GArrowListDataType

struct GArrowListDataType;

It wraps arrow::ListType.

struct GArrowStructDataType

struct GArrowStructDataType;

It wraps arrow::StructType.

GARROW_TYPE_DICTIONARY_DATA_TYPE

#define GARROW_TYPE_DICTIONARY_DATA_TYPE (garrow_dictionary_data_type_get_type())

struct GArrowDictionaryDataTypeClass

struct GArrowDictionaryDataTypeClass {
  GArrowFixedWidthDataTypeClass parent_class;
};

GArrowDictionaryDataType

typedef struct _GArrowDictionaryDataType GArrowDictionaryDataType;