API reference

python:irx:irx.record_batch.RecordBatchSchema.add_struct_field

method add_struct_field

add_struct_field(name: str, fields: Sequence[tuple[str, IrxColumnType]], nullable: bool = True) -> 'RecordBatchSchema'

Source: packages/irx/src/irx/record_batch.py:758

Add a struct column with the given named fixed-width fields.

Each field is a (name, type) pair whose type must be one of the fixed-width primitive or temporal types (see _STRUCT_FIELD_CTYPE); bool, utf8, and nested field types are not supported yet.

Parameters

Returns

Type: RecordBatchSchema

Search documentation

Type to search.