pyarrow.DictionaryType

class pyarrow.DictionaryType

Bases: DataType

Concrete class for dictionary 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)
to_pandas_dtype(self)	Return the equivalent NumPy / Pandas dtype.

Attributes

bit_width
id
index_type	The data type of dictionary indices (a signed integer type).
num_buffers	Number of data buffers required to construct Array type excluding children.
num_fields	The number of child fields.
ordered	Whether the dictionary is ordered, i.e. whether the ordering of values in the dictionary is important.
value_type	The dictionary value type.

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

id

index_type

The data type of dictionary indices (a signed integer type).

num_buffers

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

num_fields

The number of child fields.

ordered

Whether the dictionary is ordered, i.e. whether the ordering of values in the dictionary is important.

to_pandas_dtype(self)

Return the equivalent NumPy / Pandas dtype.

value_type

The dictionary value type.

The dictionary values are found in an instance of DictionaryArray.

previous

pyarrow.DataType

next

pyarrow.ListType