API reference
python:irx:irx.record_batch.RecordBatchSchema.add_list_field
method add_list_field
add_list_field(name: str, elem_type: IrxColumnType, nullable: bool = True) -> 'RecordBatchSchema'
Source: packages/irx/src/irx/record_batch.py:680
Add a list column with the given fixed-width element type.
elem_type must be one of the fixed-width primitive or temporal types (see _LIST_ELEM_CTYPE); bool, utf8, and nested element types are not supported yet.
Parameters
-
name โ Name identifying the declaration or operation.; Type: str
-
elem_type โ Type of elem.; Type: IrxColumnType
-
nullable โ Whether null values are permitted.; Type: bool
Returns
Result of this operation: add a list column with the given fixed-width element type.; Type: 'RecordBatchSchema'