Projector classes: Gandiva GLib Reference Manual

Projector classes

Functions

GGandivaProjector *	ggandiva_projector_new ()
GList *	ggandiva_projector_evaluate ()
GGandivaSelectableProjector *	ggandiva_selectable_projector_new ()
GList *	ggandiva_selectable_projector_evaluate ()

Properties

gpointer	expressions	Write / Construct Only
gpointer	projector	Write / Construct Only
GArrowSchema *	schema	Read / Write / Construct Only

Types and Values

#define	GGANDIVA_TYPE_PROJECTOR
struct	GGandivaProjectorClass
#define	GGANDIVA_TYPE_SELECTABLE_PROJECTOR
struct	GGandivaSelectableProjectorClass
	GGandivaProjector
	GGandivaSelectableProjector

Object Hierarchy

    GObject
    ╰── GGandivaProjector
        ╰── GGandivaSelectableProjector

Includes

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

Description

GGandivaProjector is a class that evaluates given expressions against the given record batches.

GGandivaSelectableProjector is a class that evaluates given expressions against the given selected records in the given record batches.

Functions

ggandiva_projector_new ()

GGandivaProjector *
ggandiva_projector_new (GArrowSchema *schema,
                        GList *expressions,
                        GError **error);

Parameters

schema	A GArrowSchema.
expressions	The built expressions.	[element-type GGandivaExpression]
error	Return location for a GError or `NULL`.	[nullable]

Returns

A newly created GGandivaProjector on success, NULL on error.

[nullable]

Since: 0.12.0

ggandiva_projector_evaluate ()

GList *
ggandiva_projector_evaluate (GGandivaProjector *projector,
                             GArrowRecordBatch *record_batch,
                             GError **error);

Parameters

projector	A GGandivaProjector.
record_batch	A GArrowRecordBatch.
error	Return location for a GError or `NULL`.	[nullable]

Returns

The GArrowArray as the result evaluated on success, NULL on error.

[element-type GArrowArray][nullable][transfer full]

Since: 0.12.0

ggandiva_selectable_projector_new ()

GGandivaSelectableProjector *
ggandiva_selectable_projector_new (GArrowSchema *schema,
                                   GList *expressions,
                                   GGandivaSelectionVectorMode mode,
                                   GError **error);

Parameters

schema	A GArrowSchema.
expressions	The built expressions.	[element-type GGandivaExpression]
mode	A GGandivaSelectionVectorMode to be used.
error	Return location for a GError or `NULL`.	[nullable]

Returns

A newly created GGandivaProjector on success, NULL on error.

[nullable]

Since: 4.0.0

ggandiva_selectable_projector_evaluate ()

GList *
ggandiva_selectable_projector_evaluate
                               (GGandivaSelectableProjector *projector,
                                GArrowRecordBatch *record_batch,
                                GGandivaSelectionVector *selection_vector,
                                GError **error);

Parameters

projector	A GGandivaSelectableProjector.
record_batch	A GArrowRecordBatch.
selection_vector	A GGandivaSelectionVector that specifies the filtered row positions.
error	Return location for a GError or `NULL`.	[nullable]

Returns

The GArrowArray as the result evaluated on success, NULL on error.

[element-type GArrowArray][nullable][transfer full]

Since: 4.0.0

Types and Values

GGANDIVA_TYPE_PROJECTOR

#define GGANDIVA_TYPE_PROJECTOR (ggandiva_projector_get_type())

struct GGandivaProjectorClass

struct GGandivaProjectorClass {
  GObjectClass parent_class;
};

GGANDIVA_TYPE_SELECTABLE_PROJECTOR

#define             GGANDIVA_TYPE_SELECTABLE_PROJECTOR

struct GGandivaSelectableProjectorClass

struct GGandivaSelectableProjectorClass {
  GGandivaProjectorClass parent_class;
};

GGandivaProjector

typedef struct _GGandivaProjector GGandivaProjector;

GGandivaSelectableProjector

typedef struct _GGandivaSelectableProjector GGandivaSelectableProjector;

Property Details

The `“expressions”` property

  “expressions”              gpointer

The expressions for the projector.

Owner: GGandivaProjector

Flags: Write / Construct Only

The `“projector”` property

  “projector”                gpointer

The raw std::shared<gandiva::Projector> *.

Owner: GGandivaProjector

Flags: Write / Construct Only

The `“schema”` property

  “schema”                   GArrowSchema *

The schema of the projector.

Owner: GGandivaProjector

Flags: Read / Write / Construct Only