pyarrow.UnionType

class pyarrow.UnionType

Bases: DataType

Base class for union data types.

__init__(*args, **kwargs)

Methods

__init__(*args, **kwargs)
equals(self, other, *[, check_metadata])	Return true if type is equivalent to passed value.
field(self, i)	Return a child field by its numeric index.
to_pandas_dtype(self)	Return the equivalent NumPy / Pandas dtype.

Attributes

bit_width
id
mode	The mode of the union ("dense" or "sparse").
num_buffers	Number of data buffers required to construct Array type excluding children.
num_fields	The number of child fields.
type_codes	The type code to indicate each data type in this union.

bit_width

equals(self, other, *, check_metadata=False)

Return true if type is equivalent to passed value.

Parameters:

otherDataType or str convertible to DataType

check_metadatabool

Whether nested Field metadata equality should be checked as well.

Returns:

is_equalbool

field(self, i) → Field

Return a child field by its numeric index.

Parameters:

iint

Returns:

pyarrow.Field

id

mode

The mode of the union (“dense” or “sparse”).

num_buffers

Number of data buffers required to construct Array type excluding children.

num_fields

The number of child fields.

to_pandas_dtype(self)

Return the equivalent NumPy / Pandas dtype.

type_codes

The type code to indicate each data type in this union.

previous

pyarrow.StructType

next

pyarrow.TimestampType