Core API

The root import for geoarrow. This import is intended for those working with geoarrow at a low level; most users should use the pyarrow integration as import geoarrow.pyarrow as ga.

Examples

>>> import geoarrow.c as ga

class AggregateFunction(name, **options)

A callable aggregate GeoArrow C function.

Each call creates a new kernel using the input array or stream’s schema, accumulates all input batches, and returns the aggregate result array.

Parameters

namestr

The registered C aggregate kernel name.

**options

Kernel options. None values are omitted.

property name

The C kernel name.

class ScalarFunction(name, **options)

A callable scalar GeoArrow C function.

Each call creates a new kernel using the input array or stream’s schema.

Parameters

namestr

The registered C kernel name.

**options

Kernel options. None values are omitted.

property name

The C kernel name.

arrow_to_type_spec(obj)

Create a geoarrow.types.TypeSpec from an Arrow schema provider.

type_spec_to_arrow(spec)

Create a SchemaHolder from a geoarrow.types.TypeSpec.

The returned object implements the Arrow PyCapsule protocol and is importable as a field in PyArrow and elsewhere.

Constants