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, safe, options, ...])

Cast scalar value to another data type.

equals(self, Scalar other)

Parameters:

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=None, safe=None, options=None, memory_pool=None)

Cast scalar value to another data type.

See pyarrow.compute.cast() for usage.

Parameters:
target_typeDataType, default None

Type to cast scalar to.

safebool, default True

Whether to check for conversion errors such as overflow.

optionsCastOptions, default None

Additional checks pass by CastOptions

memory_poolMemoryPool, optional

memory pool to use for allocations during function execution.

Returns:
scalarA Scalar of the given target data type.
dictionary
equals(self, Scalar other)
Parameters:
otherpyarrow.Scalar
Returns:
bool
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.