# Packages
Package array provides implementations of various Arrow array types.
Package arrio exposes functions to manipulate records, exposing and using interfaces not unlike the ones defined in the stdlib io package.
No description provided by the author
Package csv reads CSV files and presents the extracted data as records, also writes data as record into CSV files.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Package math provides optimized mathematical functions for processing Arrow arrays.
Package memory provides support for allocating and manipulating memory at a low level.
No description provided by the author
Package tensor provides types that implement n-dimensional arrays.
# Functions
CheckMetadata is an option for TypeEqual that allows checking for metadata equality besides type equality.
No description provided by the author
Date32FromTime returns a Date32 value from a time object.
Date64FromTime returns a Date64 value from a time object.
DenseUnionFromArrays enables creating a union type from a list of Arrays, field names, and type codes.
DenseUnionOf is equivalent to UnionOf(arrow.DenseMode, fields, typeCodes), constructing a SparseUnionType from a list of fields and type codes.
FixedSizeListOf returns the list type with element type t.
No description provided by the author
FixedSizeListOfNonNullable is like FixedSizeListOf but NullableElem defaults to false indicating that the child type should be marked as non-nullable.
GetExtensionType retrieves and returns the extension type of the given name from the global extension type registry.
No description provided by the author
No description provided by the author
IsBaseBinary returns true for Binary/String and their LARGE variants.
IsBinaryLike returns true for only BINARY and STRING.
IsDecimal returns true for Decimal128 and Decimal256.
IsFixedSizeBinary returns true for Decimal128/256 and FixedSizeBinary.
IsInteger is a helper to return true if the type ID provided is one of the integral types of uint or int with the varying sizes.
IsLargeBinaryLike returns true for only LARGE_BINARY and LARGE_STRING.
IsListLike returns true for List, LargeList, FixedSizeList, and Map.
IsNested returns true for List, LargeList, FixedSizeList, Map, Struct, and Unions.
IsPrimitive returns true if the provided type ID represents a fixed width primitive type.
IsUnion returns true for Sparse and Dense Unions.
IsUnsignedInteger is a helper that returns true if the type ID provided is one of the uint integral types (uint8, uint16, uint32, uint64).
ListOf returns the list type with element type t.
No description provided by the author
ListOfNonNullable is like ListOf but NullableElem defaults to false, indicating that the child type should be marked as non-nullable.
ListOf returns the list type with element type t.
No description provided by the author
ListOfNonNullable is like ListOf but NullableElem defaults to false, indicating that the child type should be marked as non-nullable.
No description provided by the author
No description provided by the author
NewChunked returns a new chunked array from the slice of arrays.
NewColumn returns a column from a field and a chunked data array.
NewColumnFromArr is a convenience function to create a column from a field and a non-chunked array.
No description provided by the author
NewSchema returns a new Schema value from the slice of fields and metadata.
No description provided by the author
RegisterExtensionType registers the provided ExtensionType by calling ExtensionName to use as a Key for registrying the type.
SparseUnionFromArrays enables creating a union type from a list of Arrays, field names, and type codes.
SparseUnionOf is equivalent to UnionOf(arrow.SparseMode, fields, typeCodes), constructing a SparseUnionType from a list of fields and type codes.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
StructOf returns the struct type with fields fs.
Time32FromString parses a string to return a Time32 value in the given unit, unit needs to be only seconds or milliseconds and the string should be in the form of HH:MM or HH:MM:SS[.zzz] where the fractions of a second are optional.
Time64FromString parses a string to return a Time64 value in the given unit, unit needs to be only microseconds or nanoseconds and the string should be in the form of HH:MM or HH:MM:SS[.zzzzzzzzz] where the fractions of a second are optional.
TimestampFromString parses a string and returns a timestamp for the given unit level.
TimestampFromStringInLocation is like TimestampFromString, but treats the time instant as if it were in the passed timezone before converting to UTC for internal representation.
TypeEqual checks if two DataType are the same, optionally checking metadata equality for STRUCT types.
TypesToString is a convenience function to create a list of types which are comma delimited as a string.
UnionOf returns an appropriate union type for the given Mode (Sparse or Dense), child fields, and type codes.
UnregisterExtensionType removes the type with the given name from the registry causing any messages with that type which come in to be expressed with their metadata and underlying type instead of the extension type that isn't known.
# Constants
BINARY is a Variable-length byte type (no guarantee of UTF8-ness).
BOOL is a 1 bit, LSB bit-packed ordering.
No description provided by the author
No description provided by the author
DATE32 is int32 days since the UNIX epoch.
Date32SizeBytes specifies the number of bytes required to store a single Date32 in memory.
DATE64 is int64 milliseconds since the UNIX epoch.
Date64SizeBytes specifies the number of bytes required to store a single Date64 in memory.
DayTimeIntervalSizeBytes specifies the number of bytes required to store a single DayTimeInterval in memory.
Alias to ensure we do not break any consumers.
DECIMAL128 is a precision- and scale-based decimal type.
Decimal128SizeBytes specifies the number of bytes required to store a single decimal128 in memory.
DECIMAL256 is a precision and scale based decimal type, with 256 bit max.
No description provided by the author
DENSE_UNION of logical types.
DENSE.
DICTIONARY aka Category type.
Measure of elapsed time in either seconds, milliseconds, microseconds or nanoseconds.
DurationSizeBytes specifies the number of bytes required to store a single Duration in memory.
Custom data type, implemented by user.
FIXED_SIZE_BINARY is a binary where each value occupies the same number of bytes.
Fixed size list of some logical type.
FLOAT16 is a 2-byte floating point value.
Float16SizeBytes specifies the number of bytes required to store a single float16 in memory.
FLOAT32 is a 4-byte floating point value.
Float32SizeBytes specifies the number of bytes required to store a single float32 in memory.
FLOAT64 is an 8-byte floating point value.
Float64SizeBytes specifies the number of bytes required to store a single float64 in memory.
INT16 is a Signed 16-bit little-endian integer.
Int16SizeBytes specifies the number of bytes required to store a single int16 in memory.
INT32 is a Signed 32-bit little-endian integer.
Int32SizeBytes specifies the number of bytes required to store a single int32 in memory.
INT64 is a Signed 64-bit little-endian integer.
Int64SizeBytes specifies the number of bytes required to store a single int64 in memory.
INT8 is a Signed 8-bit little-endian integer.
Int8SizeBytes specifies the number of bytes required to store a single int8 in memory.
INTERVAL could be any of the interval types, kept to avoid breaking anyone after switching to individual type ids for the interval types that were using it when calling MakeFromData or NewBuilder
Deprecated and will be removed in the next major version release.
INTERVAL_DAY_TIME is DAY_TIME in SQL Style.
calendar interval with three fields.
INTERVAL_MONTHS is YEAR_MONTH interval in SQL style.
No description provided by the author
The expected types of buffers.
The expected types of buffers.
The expected types of buffers.
The expected types of buffers.
like BINARY but with 64-bit offsets, not yet implemented.
like LIST but with 64-bit offsets.
like STRING, but 64-bit offsets.
LIST is a list of some logical data type.
MAP is a repeated struct logical type.
No description provided by the author
No description provided by the author
No description provided by the author
MonthDayNanoIntervalSizeBytes specifies the number of bytes required to store a single DayTimeInterval in memory.
MonthIntervalSizeBytes specifies the number of bytes required to store a single MonthInterval in memory.
No description provided by the author
NULL type having no physical storage.
No description provided by the author
No description provided by the author
SPARSE_UNION of logical types.
SPARSE.
STRING is a UTF8 variable-length string.
STRUCT of logical types.
TIME32 is a signed 32-bit integer, representing either seconds or milliseconds since midnight.
Time32SizeBytes specifies the number of bytes required to store a single Time32 in memory.
TIME64 is a signed 64-bit integer, representing either microseconds or nanoseconds since midnight.
Time64SizeBytes specifies the number of bytes required to store a single Time64 in memory.
TIMESTAMP is an exact timestamp encoded with int64 since UNIX epoch Default unit millisecond.
TimestampSizeBytes specifies the number of bytes required to store a single Timestamp in memory.
UINT16 is an Unsigned 16-bit little-endian integer.
Uint16SizeBytes specifies the number of bytes required to store a single uint16 in memory.
UINT32 is an Unsigned 32-bit little-endian integer.
Uint32SizeBytes specifies the number of bytes required to store a single uint32 in memory.
UINT64 is an Unsigned 64-bit little-endian integer.
Uint64SizeBytes specifies the number of bytes required to store a single uint64 in memory.
UINT8 is an Unsigned 8-bit little-endian integer.
Uint8SizeBytes specifies the number of bytes required to store a single uint8 in memory.
# Variables
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Decimal128 traits.
Decimal256 traits.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Float16 traits.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
No description provided by the author
No description provided by the author
BufferSpec provides a specification for the buffers of a particular datatype.
Chunked manages a collection of primitives arrays as one logical large array.
Column is an immutable column data structure consisting of a field (type metadata) and a chunked data array.
DataTypeLayout represents the physical layout of a datatype's buffers including the number of and types of those binary buffers.
No description provided by the author
No description provided by the author
DayTimeInterval represents a number of days and milliseconds (fraction of day).
DayTimeIntervalType is encoded as a pair of 32-bit signed integer, representing a number of days and milliseconds (fraction of day).
Decimal128Type represents a fixed-size 128-bit decimal type.
Decimal256Type represents a fixed-size 256-bit decimal type.
DenseUnionType is the concrete type for dense union data.
DictionaryType represents categorical or dictionary-encoded in-memory data It contains a dictionary-encoded value type (any type) and an index type (any integer type).
DurationType is encoded as a 64-bit signed integer, representing an amount of elapsed time without any relation to a calendar artifact.
ExtensionBase is the base struct for user-defined Extension Types which must be embedded in any user-defined types like so:
type UserDefinedType struct { arrow.ExtensionBase // any other data }
.
No description provided by the author
No description provided by the author
FixedSizeListType describes a nested type in which each array slot contains a fixed-size sequence of values, all having the same relative type.
Float16Type represents a floating point value encoded with a 16-bit precision.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ListType describes a nested type in which each array slot contains a variable-size sequence of values, all having the same relative type.
No description provided by the author
No description provided by the author
MonthDayNanoInterval represents a number of months, days and nanoseconds (fraction of day).
MonthDayNanoIntervalType is encoded as two signed 32-bit integers representing a number of months and a number of days, followed by a 64-bit integer representing the number of nanoseconds since midnight for fractions of a day.
MonthIntervalType is encoded as a 32-bit signed integer, representing a number of months.
NullType describes a degenerate array, with zero physical storage.
Schema is a sequence of Field values, describing the columns of a table or a record batch.
SparseUnionType is the concrete type for Sparse union data.
No description provided by the author
StructType describes a nested type parameterized by an ordered sequence of relative types, called its fields.
Time32Type is encoded as a 32-bit signed integer, representing either seconds or milliseconds since midnight.
Time64Type is encoded as a 64-bit signed integer, representing either microseconds or nanoseconds since midnight.
TimestampType is encoded as a 64-bit signed integer since the UNIX epoch (2017-01-01T00:00:00Z).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Interfaces
Array represents an immutable sequence of values using the Arrow in-memory format.
ArrayData is the underlying memory and metadata of an Arrow array, corresponding to the same-named object in the C++ implementation.
No description provided by the author
DataType is the representation of an Arrow type.
ExtensionType is an interface for handling user-defined types.
FixedWidthDataType is the representation of an Arrow type that requires a fixed number of bits in memory for each element.
No description provided by the author
No description provided by the author
OffsetTraits is a convenient interface over the various type traits constants such as arrow.Int32Traits allowing types with offsets, like BinaryType, StringType, LargeBinaryType and LargeStringType to have a method to return information about their offset type and how many bytes would be required to allocate an offset buffer for them.
Record is a collection of equal-length arrays matching a particular Schema.
Table represents a logical sequence of chunked arrays of equal length.
No description provided by the author
UnionType is an interface to encompass both Dense and Sparse Union types.
# Type aliases
BufferKind describes the type of buffer expected when defining a layout specification.
No description provided by the author
No description provided by the author
No description provided by the author
MonthInterval represents a number of months.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Type is a logical type.
TypeEqualOption is a functional option type used for configuring type equality checks.
No description provided by the author
No description provided by the author