pyarrow.UnionType

class pyarrow.UnionType

Bases: pyarrow.lib.DataType

Concrete class for struct data types.

__init__(*args, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__(*args, **kwargs)

Initialize self.

equals(self, other)

Return true if type is equivalent to passed value.

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_children

The number of child fields.

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)

Return true if type is equivalent to passed value.

Parameters

other (DataType or string convertible to DataType) –

Returns

is_equal (bool)

id
mode

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

num_buffers

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

num_children

The number of child fields.

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.