pyarrow.DictionaryScalar

class pyarrow.DictionaryScalar

Bases: Scalar

Concrete class for dictionary-encoded scalars.

__init__(*args, **kwargs)

Methods

__init__(*args, **kwargs)
as_py(self)	Return this encoded value as a Python object.
cast(self, target_type)	Attempt a safe cast to target data type.
equals(self, Scalar other)
validate(self, *[, full])	Perform validation checks.

Attributes

dictionary
index	Return this value's underlying index as a scalar.
is_valid	Holds a valid (non-null) value.
type	Data type of the Scalar object.
value	Return the encoded value as a scalar.

as_py(self)

Return this encoded 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.

dictionary

equals(self, Scalar other)

index

Return this value’s underlying index as a scalar.

is_valid

Holds a valid (non-null) value.

type

Data type of the Scalar object.

validate(self, *, full=False)

Perform validation checks. An exception is raised if validation fails.

By default only cheap validation checks are run. Pass full=True for thorough validation checks (potentially O(n)).

Parameters:

fullbool, default False

If True, run expensive checks, otherwise cheap checks only.

Raises:

ArrowInvalid

value

Return the encoded value as a scalar.

previous

pyarrow.Decimal128Scalar

next

pyarrow.ListScalar