pyarrow.StructType

class pyarrow.StructType

Bases: pyarrow.lib.DataType

Concrete class for struct data types.

__init__(*args, **kwargs)

Methods

__init__(*args, **kwargs)
equals(self, other)	Return true if type is equivalent to passed value.
get_all_field_indices(self, name)	Return sorted list of indices for the fields with the given name.
get_field_index(self, name)	Return index of the unique field with the given name.
to_pandas_dtype(self)	Return the equivalent NumPy / Pandas dtype.

Attributes

bit_width
id
num_buffers	Number of data buffers required to construct Array type excluding children.
num_children	The number of child fields.
num_fields	The number of child fields.

bit_width

equals(self, other)

Return true if type is equivalent to passed value.

Parameters

otherDataType or str convertible to DataType

Returns

is_equalbool

get_all_field_indices(self, name)

Return sorted list of indices for the fields with the given name.

Parameters

namestr

The name of the field to look up.

Returns

indicesList[int]

get_field_index(self, name)

Return index of the unique field with the given name.

Parameters

namestr

The name of the field to look up.

Returns

indexint

The index of the field with the given name; -1 if the name isn’t found or there are several fields with the given name.

id

num_buffers

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

num_children

The number of child fields.

num_fields

The number of child fields.

to_pandas_dtype(self)

Return the equivalent NumPy / Pandas dtype.

previous

pyarrow.MapType

next

pyarrow.UnionType