pyarrow.Decimal256Type#
- class pyarrow.Decimal256Type#
Bases:
FixedSizeBinaryType
Concrete class for decimal256 data types.
Examples
Create an instance of decimal256 type:
>>> import pyarrow as pa >>> pa.decimal256(76, 38) Decimal256Type(decimal256(76, 38))
- __init__(*args, **kwargs)#
Methods
__init__
(*args, **kwargs)equals
(self, other, *[, check_metadata])Return true if type is equivalent to passed value.
field
(self, i)- Parameters:
to_pandas_dtype
(self)Return the equivalent NumPy / Pandas dtype.
Attributes
Bit width for fixed width type.
Byte width for fixed width type.
Number of data buffers required to construct Array type excluding children.
The number of child fields.
The decimal precision, in number of decimal digits (an integer).
The decimal scale (an integer).
- bit_width#
Bit width for fixed width type.
Examples
>>> import pyarrow as pa >>> pa.int64() DataType(int64) >>> pa.int64().bit_width 64
- byte_width#
Byte width for fixed width type.
Examples
>>> import pyarrow as pa >>> pa.int64() DataType(int64) >>> pa.int64().byte_width 8
- equals(self, other, *, check_metadata=False)#
Return true if type is equivalent to passed value.
- Parameters:
- Returns:
- is_equalbool
Examples
>>> import pyarrow as pa >>> pa.int64().equals(pa.string()) False >>> pa.int64().equals(pa.int64()) True
- id#
- num_buffers#
Number of data buffers required to construct Array type excluding children.
Examples
>>> import pyarrow as pa >>> pa.int64().num_buffers 2 >>> pa.string().num_buffers 3
- num_fields#
The number of child fields.
Examples
>>> import pyarrow as pa >>> pa.int64() DataType(int64) >>> pa.int64().num_fields 0 >>> pa.list_(pa.string()) ListType(list<item: string>) >>> pa.list_(pa.string()).num_fields 1 >>> struct = pa.struct({'x': pa.int32(), 'y': pa.string()}) >>> struct.num_fields 2
- precision#
The decimal precision, in number of decimal digits (an integer).
Examples
>>> import pyarrow as pa >>> t = pa.decimal256(76, 38) >>> t.precision 76
- scale#
The decimal scale (an integer).
Examples
>>> import pyarrow as pa >>> t = pa.decimal256(76, 38) >>> t.scale 38
- to_pandas_dtype(self)#
Return the equivalent NumPy / Pandas dtype.
Examples
>>> import pyarrow as pa >>> pa.int64().to_pandas_dtype() <class 'numpy.int64'>