pyarrow.MapType

class pyarrow.MapType

Bases: DataType

Concrete class for map 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

item_field

The field for items in the map entries.

item_type

The data type of items in the map entries.

key_field

The field for keys in the map entries.

key_type

The data type of keys in the map entries.

num_buffers

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

num_fields

The number of child fields.

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
item_field

The field for items in the map entries.

item_type

The data type of items in the map entries.

key_field

The field for keys in the map entries.

key_type

The data type of keys in the map entries.

num_buffers

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

num_fields

The number of child fields.

to_pandas_dtype(self)

Return the equivalent NumPy / Pandas dtype.