Module arrow::datatypes

source ·
Expand description

Defines the logical data types of Arrow arrays.

The most important things you might be looking for are:

  • Schema to describe a schema.
  • Field to describe one field within a schema.
  • DataType to describe the type of a field.

Structs

BooleanType
Date32Type
Date64Type
Decimal128Type
The decimal type for a Decimal128Array
Decimal256Type
The decimal type for a Decimal256Array
DurationMicrosecondType
DurationMillisecondType
DurationNanosecondType
DurationSecondType
Field
Describes a single column in a Schema.
Float16Type
Float32Type
Float64Type
GenericBinaryType
ByteArrayType for binary arrays
GenericStringType
ByteArrayType for string arrays
Int8Type
Int16Type
Int32Type
Int64Type
IntervalDayTimeType
IntervalMonthDayNanoType
IntervalYearMonthType
Schema
Describes the meta-data of an ordered sequence of relative types.
Time32MillisecondType
Time32SecondType
Time64MicrosecondType
Time64NanosecondType
TimestampMicrosecondType
TimestampMillisecondType
TimestampNanosecondType
TimestampSecondType
UInt8Type
UInt16Type
UInt32Type
UInt64Type

Enums

DataType
The set of datatypes that are supported by this implementation of Apache Arrow.
IntervalUnit
YEAR_MONTH, DAY_TIME, MONTH_DAY_NANO interval in SQL style.
TimeUnit
An absolute length of time in seconds, milliseconds, microseconds or nanoseconds.
UnionMode

Constants

DECIMAL128_MAX_PRECISION
The maximum precision for arrow_schema::DataType::Decimal128 values
DECIMAL128_MAX_SCALE
The maximum scale for arrow_schema::DataType::Decimal128 values
DECIMAL256_MAX_PRECISION
The maximum precision for arrow_schema::DataType::Decimal256 values
DECIMAL256_MAX_SCALE
The maximum scale for arrow_schema::DataType::Decimal256 values
DECIMAL_DEFAULT_SCALE
The default scale for arrow_schema::DataType::Decimal128 and arrow_schema::DataType::Decimal256 values
MAX_DECIMAL_FOR_EACH_PRECISION
MAX_DECIMAL_FOR_EACH_PRECISION[p] holds the maximum i128 value that can be stored in arrow_schema::DataType::Decimal128 value of precision p
MIN_DECIMAL_FOR_EACH_PRECISION
MIN_DECIMAL_FOR_EACH_PRECISION[p] holds the minimum i128 value that can be stored in a arrow_schema::DataType::Decimal128 value of precision p

Traits

ArrowDictionaryKeyType
A subtype of primitive type that represents legal dictionary keys. See https://arrow.apache.org/docs/format/Columnar.html
ArrowFloatNumericType
ArrowNativeType
Trait expressing a Rust type that has the same in-memory representation as Arrow. This includes i16, f32, but excludes bool (which in arrow is represented in bits).
ArrowNativeTypeOp
Trait for ArrowNativeType that adds checked and unchecked arithmetic operations, and totally ordered comparison operations
ArrowNumericType
ArrowPrimitiveType
Trait bridging the dynamic-typed nature of Arrow (via DataType) with the static-typed nature of rust types (ArrowNativeType) for all types that implement ArrowNativeType.
ArrowTemporalType
A subtype of primitive type that represents temporal values.
ArrowTimestampType
A timestamp type allows us to create array builders that take a timestamp.
ByteArrayType
A trait over the variable-size byte array types
DecimalType
A trait over the decimal types, used by DecimalArray to provide a generic implementation across the various decimal types
ToByteSlice
Allows conversion from supported Arrow types to a byte slice.

Functions

singed_cmp_le_bytes
validate_decimal256_precision_with_lt_bytes
Validates that the specified byte_array of little-endian format value can be properly interpreted as a Decimal256 number with precision precision
validate_decimal_precision
Validates that the specified i128 value can be properly interpreted as a Decimal number with precision precision

Type Definitions

BinaryType
LargeBinaryType
LargeUtf8Type
SchemaRef
A reference-counted reference to a Schema.
Utf8Type