pyarrow.StructType¶
-
class
pyarrow.StructType¶ Bases:
pyarrow.lib.DataTypeConcrete class for struct data types.
-
__init__(*args, **kwargs)¶ Initialize self. See help(type(self)) for accurate signature.
Methods
__init__(*args, **kwargs)Initialize self.
equals(self, other)Return true if type is equivalent to passed value.
get_all_field_indices(self, name)Return sorted list of indices for fields with the given name
get_field_index(self, name)Return index of field with given unique name.
to_pandas_dtype(self)Return the equivalent NumPy / Pandas dtype.
Attributes
Number of data buffers required to construct Array type excluding children.
The number of child fields.
The number of child fields.
-
bit_width¶
-
equals(self, other)¶ Return true if type is equivalent to passed value.
- Parameters
other (DataType or string convertible to DataType) –
- Returns
is_equal (bool)
-
get_all_field_indices(self, name)¶ Return sorted list of indices for fields with the given name
-
get_field_index(self, name)¶ Return index of field with given unique name. Returns -1 if not found or if duplicated
-
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.
-