GArrowSchema

GArrowSchema — Schema class

Functions

Properties

gpointer schema Write / Construct Only

Types and Values

struct GArrowSchema

Object Hierarchy

    GObject
    ╰── GArrowSchema

Description

GArrowSchema is a class for schema. Schema is metadata of a table. It has zero or more GArrowFields.

Functions

garrow_schema_new ()

GArrowSchema *
garrow_schema_new (GList *fields);

Parameters

fields

The fields of the schema.

[element-type GArrowField]

Returns

A newly created GArrowSchema.


garrow_schema_get_field ()

GArrowField *
garrow_schema_get_field (GArrowSchema *schema,
                         guint i);

Parameters

schema

A GArrowSchema.

 

i

The index of the target field.

 

Returns

The i-th field of the schema.

[transfer full]


garrow_schema_get_field_by_name ()

GArrowField *
garrow_schema_get_field_by_name (GArrowSchema *schema,
                                 const gchar *name);

Parameters

schema

A GArrowSchema.

 

name

The name of the field to be found.

 

Returns

The found field or NULL.

[transfer full]


garrow_schema_n_fields ()

guint
garrow_schema_n_fields (GArrowSchema *schema);

Parameters

schema

A GArrowSchema.

 

Returns

The number of fields of the schema.


garrow_schema_get_fields ()

GList *
garrow_schema_get_fields (GArrowSchema *schema);

Parameters

schema

A GArrowSchema.

 

Returns

The fields of the schema.

[element-type GArrowField][transfer full]


garrow_schema_to_string ()

gchar *
garrow_schema_to_string (GArrowSchema *schema);

Parameters

schema

A GArrowSchema.

 

Returns

The string representation of the schema.

Types and Values

struct GArrowSchema

struct GArrowSchema;

It wraps arrow::Schema.

Property Details

The “schema” property

  “schema”                   gpointer

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

Flags: Write / Construct Only