pyarrow.UnionScalar

class pyarrow.UnionScalar

Bases: Scalar

Concrete class for Union scalars.

__init__(*args, **kwargs)

Methods

__init__(*args, **kwargs)
as_py(self)	Return underlying value as a Python object.
cast(self, target_type)	Attempt a safe cast to target data type.
equals(self, Scalar other)

Attributes

is_valid	Holds a valid (non-null) value.
type	Data type of the Scalar object.
type_code	Return the union type code for this scalar.
value	Return underlying value as a scalar.

as_py(self)

Return underlying value as a Python object.

cast(self, target_type)

Attempt a safe cast to target data type.

Parameters:

target_typeDataType or str coercible to DataType

The type to cast the scalar to.

Returns:

scalarA Scalar of the given target data type.

equals(self, Scalar other)

is_valid

Holds a valid (non-null) value.

type

Data type of the Scalar object.

type_code

Return the union type code for this scalar.

value

Return underlying value as a scalar.

previous

pyarrow.StructScalar

next

pyarrow.ExtensionScalar