Schema description for a single Arrow array/column. More...

#include <arrow_bridge.hpp>

Public Attributes
const char *	format
	Arrow format string (e.g. "f" = float32)

const char *	name
	Column/field name (may be null)

const char *	metadata
	Arrow key-value metadata (may be null)

int64_t	flags
	Bitfield: bit 1 = nullable, bit 2 = dict-ordered.

int64_t	n_children
	Number of child schemas (0 for primitives)

ArrowSchema **	children
	Child schema pointers (null if n_children == 0)

ArrowSchema *	dictionary
	Dictionary schema (null if not dict-encoded)

void(*	release )(ArrowSchema *)
	Release callback (null = already released)

void *	private_data
	Opaque data for the release callback.

Detailed Description

Schema description for a single Arrow array/column.

Describes the logical type, name, and structure of an Arrow column. The release callback must be called exactly once when the consumer is finished with the schema; a null release pointer indicates the schema has already been released.

Note: This is a C struct with C linkage – safe to pass across FFI boundaries.

See also: https://arrow.apache.org/docs/format/CDataInterface.html#the-arrowschema-structure

Definition at line 50 of file arrow_bridge.hpp.

Member Data Documentation

◆ children

ArrowSchema** ArrowSchema::children

Child schema pointers (null if n_children == 0)

Definition at line 56 of file arrow_bridge.hpp.

◆ dictionary

ArrowSchema* ArrowSchema::dictionary

Dictionary schema (null if not dict-encoded)

Definition at line 57 of file arrow_bridge.hpp.

◆ flags

int64_t ArrowSchema::flags

Bitfield: bit 1 = nullable, bit 2 = dict-ordered.

Definition at line 54 of file arrow_bridge.hpp.

◆ format

const char* ArrowSchema::format

Arrow format string (e.g. "f" = float32)

Definition at line 51 of file arrow_bridge.hpp.

◆ metadata

const char* ArrowSchema::metadata

Arrow key-value metadata (may be null)

Definition at line 53 of file arrow_bridge.hpp.

◆ n_children

int64_t ArrowSchema::n_children

Number of child schemas (0 for primitives)

Definition at line 55 of file arrow_bridge.hpp.

◆ name

const char* ArrowSchema::name

Column/field name (may be null)

Definition at line 52 of file arrow_bridge.hpp.

◆ private_data

void* ArrowSchema::private_data

Opaque data for the release callback.

Definition at line 59 of file arrow_bridge.hpp.

◆ release

void(* ArrowSchema::release) (ArrowSchema *)

Release callback (null = already released)

Definition at line 58 of file arrow_bridge.hpp.

The documentation for this struct was generated from the following file:

include/signet/interop/arrow_bridge.hpp

Public Attributes