package
16.1.0
Repository: https://github.com/apache/arrow.git
Documentation: pkg.go.dev

# Functions

ApproxEqual reports whether the two provided arrays are approximately equal.
ChunkedApproxEqual reports whether two chunked arrays are approximately equal regardless of their chunkings for non-floating point arrays, this is equivalent to ChunkedEqual.
ChunkedEqual reports whether two chunked arrays are equal regardless of their chunkings.
No description provided by the author
Concatenate creates a new arrow.Array which is the concatenation of the passed in arrays.
No description provided by the author
Diff compares two arrays, returning an edit script which expresses the difference between them.
Equal reports whether the two provided arrays are equal.
FromJSON creates an arrow.Array from a corresponding JSON stream and defined data type.
No description provided by the author
No description provided by the author
No description provided by the author
MakeArrayOfNull creates an array of size length which is all null of the given data type.
MakeFromData constructs a strongly-typed array instance from generic Data.
NewBinaryBuilder can be used for any of the variable length binary types, Binary, LargeBinary, String, LargeString by passing the appropriate data type.
NewBinaryData constructs a new Binary array from data.
NewBinaryDictionaryUnifier constructs and returns a new dictionary unifier for dictionaries of binary values, using the provided allocator for allocating the unified dictionary and the memotable used for building it.
No description provided by the author
No description provided by the author
NewBoolean creates a boolean array from the data memory.Buffer and contains length elements.
No description provided by the author
No description provided by the author
No description provided by the author
NewChunkedSlice constructs a zero-copy slice of the chunked array with the indicated indices i and j, corresponding to array[i:j].
NewColumnSlice returns a new zero-copy slice of the column with the indicated indices i and j, corresponding to the column's array[i:j].
NewData creates a new Data.
NewDataWithDictionary creates a new data object, but also sets the provided dictionary into the data if it's not nil.
No description provided by the author
NewDate32Data creates a new Date32.
No description provided by the author
NewDate64Data creates a new Date64.
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
NewDenseUnion constructs a union array using the given type, length, list of children and buffers of typeIDs and offsets, with the given array offset.
NewDenseUnionBuilder constructs a new DenseUnionBuilder with the provided children and type codes.
NewDenseUnionWithBuilders returns a new DenseUnionBuilder using the provided type and builders.
NewDenseUnionData constructs a DenseUnion array from the given ArrayData object.
NewDenseUnionFromArrays constructs a new DenseUnion array with the provided values.
NewDenseUnionFromArraysWithFieldCodes combines the other constructors for constructing a new DenseUnion array with the provided field names and type codes, along with children and type ids.
NewDenseUnionFromArrayWithFields constructs a new DenseUnion array like NewDenseUnionFromArrays, but allows specifying the field names.
NewDictionaryArray constructs a dictionary array with the provided indices and dictionary using the given type.
No description provided by the author
NewDictionaryBuilderWithDict initializes a dictionary builder and inserts the values from `init` as the first values in the dictionary, but does not insert them as values into the array.
NewDictionaryData creates a strongly typed Dictionary array from an ArrayData object with a datatype of arrow.Dictionary and a dictionary.
NewDictionaryUnifier constructs and returns a new dictionary unifier for dictionaries of valueType, using the provided allocator for allocating the unified dictionary and the memotable used for building it.
No description provided by the author
NewDurationData creates a new Duration.
NewEmptyDenseUnionBuilder is a helper to construct a DenseUnionBuilder without having to predefine the union types.
NewEmptySparseUnionBuilder is a helper to construct a SparseUnionBuilder without having to predefine the union types.
NewExtensionArrayWithStorage constructs a new ExtensionArray from the provided ExtensionType and uses the provided storage interface as the underlying storage.
NewExtensionBuilder returns a builder using the provided memory allocator for the desired extension type.
NewExtensionData expects a data with a datatype of arrow.ExtensionType and underlying data built for the storage array.
No description provided by the author
NewFixedSizeBinaryData constructs a new fixed-size binary array from data.
NewFixedSizeListBuilder returns a builder, using the provided memory allocator.
NewFixedSizeListData returns a new List array value, from data.
No description provided by the author
No description provided by the author
No description provided by the author
NewFloat32Data creates a new Float32.
No description provided by the author
NewFloat64Data creates a new Float64.
No description provided by the author
NewInt16Data creates a new Int16.
No description provided by the author
NewInt32Data creates a new Int32.
No description provided by the author
NewInt64Data creates a new Int64.
No description provided by the author
NewInt8Data creates a new Int8.
No description provided by the author
NewJSONReader returns a json RecordReader which expects to find one json object per row of dataset.
No description provided by the author
NewLargeListBuilder returns a builder, using the provided memory allocator.
NewLargeListBuilderWithField takes a field rather than just an element type to allow for more customization of the final type of the LargeList Array.
NewLargeListData returns a new LargeList array value, from data.
NewLargeListViewBuilder returns a builder, using the provided memory allocator.
NewLargeListViewBuilderWithField takes a field rather than just an element type to allow for more customization of the final type of the LargeListView Array.
NewLargeListViewData returns a new LargeListView array value, from data.
NewStringBuilder creates a new StringBuilder.
NewStringData constructs a new String array from data.
NewListBuilder returns a builder, using the provided memory allocator.
NewListBuilderWithField takes a field to use for the child rather than just a datatype to allow for more customization.
NewListData returns a new List array value, from data.
NewListViewBuilder returns a builder, using the provided memory allocator.
NewListViewBuilderWithField takes a field to use for the child rather than just a datatype to allow for more customization.
No description provided by the author
NewMapBuilder returns a builder, using the provided memory allocator.
No description provided by the author
NewMapData returns a new Map array value, from data.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewNull returns a new Null array value of size n.
NewNullBuilder returns a builder, using the provided memory allocator.
NewNullData returns a new Null array value, from data.
NewRecord returns a basic, non-lazy in-memory record batch.
NewRecordBuilder returns a builder, using the provided memory allocator and a schema.
NewRecordReader returns a simple iterator over the given slice of records.
No description provided by the author
No description provided by the author
No description provided by the author
NewSlice constructs a zero-copy slice of the array with the indicated indices i and j, corresponding to array[i:j].
NewSliceData returns a new slice that shares backing data with the input.
NewSparseUnion constructs a union array using the given type, length, list of children and buffer of typeIDs with the given offset.
NewSparseUnionBuilder constructs a new SparseUnionBuilder with the provided children and type codes.
NewSparseUnionWithBuilders returns a new SparseUnionBuilder using the provided type and builders.
NewSparseUnionData constructs a SparseUnion array from the given ArrayData object.
NewSparseUnionFromArrays constructs a new SparseUnion array with the provided values.
NewSparseUnionFromArraysWithFieldCodes combines the other constructors for constructing a new SparseUnion array with the provided field names and type codes, along with children and type ids.
NewSparseUnionFromArrayWithFields constructs a new SparseUnion array like NewSparseUnionFromArrays, but allows specifying the field names.
NewStringBuilder creates a new StringBuilder.
NewStringData constructs a new String array from data.
No description provided by the author
No description provided by the author
NewStructArray constructs a new Struct Array out of the columns passed in and the field names.
NewStructArrayWithNulls is like NewStructArray as a convenience function, but also takes in a null bitmap, the number of nulls, and an optional offset to use for creating the Struct Array.
NewStructBuilder returns a builder, using the provided memory allocator.
NewStructData returns a new Struct array value from data.
NewTable returns a new basic, non-lazy in-memory table.
NewTableFromRecords returns a new basic, non-lazy in-memory table.
NewTableFromSlice is a convenience function to create a table from a slice of slices of arrow.Array.
NewTableReader returns a new TableReader to iterate over the (possibly chunked) Table.
No description provided by the author
NewTime32Data creates a new Time32.
No description provided by the author
NewTime64Data creates a new Time64.
No description provided by the author
NewTimestampData creates a new Timestamp from Data.
No description provided by the author
NewUint16Data creates a new Uint16.
No description provided by the author
NewUint32Data creates a new Uint32.
No description provided by the author
NewUint64Data creates a new Uint64.
No description provided by the author
NewUint8Data creates a new Uint8.
NewValidatedDictionaryArray constructs a dictionary array from the provided indices and dictionary arrays, while also performing validation checks to ensure correctness such as bounds checking at are usually skipped for performance.
Returns the smallest contiguous range of values of the child array that are referenced by all the list values in the input array.
RecordApproxEqual reports whether the two provided records are approximately equal.
RecordEqual reports whether the two provided records are equal.
RecordFromJSON creates a record batch from JSON data.
RecordFromStructArray is a convenience function for converting a struct array into a record batch without copying the data.
RecordToJSON writes out the given record following the format of each row is a single object on a single line of the output.
RecordToStructArray constructs a struct array from the columns of the record batch by referencing them, zero-copy.
SliceApproxEqual reports whether slices left[lbeg:lend] and right[rbeg:rend] are approximately equal.
SliceEqual reports whether slices left[lbeg:lend] and right[rbeg:rend] are equal.
TableEqual returns if the two tables have the approximately equal data in the same schema.
TableEqual returns if the two tables have the same data in the same schema.
No description provided by the author
No description provided by the author
UnifyChunkedDicts takes a chunked array of dictionary type and will unify the dictionary across all of the chunks with the returned chunked array having all chunks share the same dictionary.
UnifyTableDicts performs UnifyChunkedDicts on each column of the table so that any dictionary column will have the dictionaries of its chunks unified.
WithAbsTolerance configures the comparison functions so that 2 floating point values v1 and v2 are considered equal if |v1-v2| <= atol.
WithAllocator specifies the allocator to use for creating the record batches, if it is not called, then memory.DefaultAllocator will be used.
WithChunk sets the chunk size for reading in json records.
No description provided by the author
WithNaNsEqual configures the comparison functions so that NaNs are considered equal.
WithStartOffset attempts to start decoding from the reader at the offset passed in.
WithUnorderedMapKeys configures the comparison functions so that Map with different entries order are considered equal.
WithUseNumber enables the 'UseNumber' option on the json decoder, using the json.Number type instead of assuming float64 for numbers.

# Constants

NullValueStr represents a null value in arrow.Array.ValueStr and in Builder.AppendValueFromString.
UnknownNullCount specifies the NullN should be calculated from the null bitmap buffer.

# Structs

A type which represents an immutable sequence of variable-length binary strings.
A BinaryBuilder is used to build a Binary array using the Append methods.
No description provided by the author
No description provided by the author
No description provided by the author
A type which represents an immutable sequence of boolean values.
No description provided by the author
Data represents the memory and metadata of an Arrow array.
A type which represents an immutable sequence of arrow.Date32 values.
No description provided by the author
No description provided by the author
A type which represents an immutable sequence of arrow.Date64 values.
No description provided by the author
No description provided by the author
No description provided by the author
A type which represents an immutable sequence of arrow.DayTimeInterval values.
No description provided by the author
A type which represents an immutable sequence of 128-bit decimal values.
No description provided by the author
No description provided by the author
Decimal256 is a type that represents an immutable sequence of 256-bit decimal values.
No description provided by the author
No description provided by the author
DenseUnion represents an array where each logical value is taken from a single child, at a specific offset.
DenseUnionBuilder is used to build a Dense Union array using the Append methods.
Dictionary represents the type for dictionary-encoded data with a data dependent dictionary.
A type which represents an immutable sequence of arrow.Duration values.
No description provided by the author
No description provided by the author
Edit represents one entry in the edit script to compare two arrays.
ExtensionArrayBase is the base struct for user-defined Extension Array types and must be embedded in any user-defined extension arrays like so: type UserDefinedArray struct { array.ExtensionArrayBase }.
ExtensionBuilder is a convenience builder so that NewBuilder and such will still work with extension types properly.
A type which represents an immutable sequence of fixed-length binary strings.
A FixedSizeBinaryBuilder is used to build a FixedSizeBinary array using the Append methods.
No description provided by the author
FixedSizeList represents an immutable sequence of N array values.
No description provided by the author
A type which represents an immutable sequence of Float16 values.
No description provided by the author
No description provided by the author
A type which represents an immutable sequence of float32 values.
No description provided by the author
No description provided by the author
A type which represents an immutable sequence of float64 values.
No description provided by the author
No description provided by the author
helper for building the properly typed indices of the dictionary builder.
A type which represents an immutable sequence of int16 values.
No description provided by the author
No description provided by the author
A type which represents an immutable sequence of int32 values.
No description provided by the author
No description provided by the author
A type which represents an immutable sequence of int64 values.
No description provided by the author
No description provided by the author
A type which represents an immutable sequence of int8 values.
No description provided by the author
No description provided by the author
JSONReader is a json reader that meets the RecordReader interface definition.
No description provided by the author
LargeList represents an immutable sequence of array values.
No description provided by the author
LargeListView represents an immutable sequence of array values defined by an offset into a child array and a length.
No description provided by the author
String represents an immutable sequence of variable-length UTF-8 strings.
A LargeStringBuilder is used to build a LargeString array using the Append methods.
List represents an immutable sequence of array values.
No description provided by the author
ListView represents an immutable sequence of array values defined by an offset into a child array and a length.
No description provided by the author
Map represents an immutable sequence of Key/Value structs.
No description provided by the author
No description provided by the author
A type which represents an immutable sequence of arrow.DayTimeInterval values.
No description provided by the author
A type which represents an immutable sequence of arrow.MonthInterval values.
No description provided by the author
No description provided by the author
Null represents an immutable, degenerate array with no physical storage.
No description provided by the author
No description provided by the author
RecordBuilder eases the process of building a Record, iteratively, from a known Schema.
RunEndEncoded represents an array containing two children: an array of int32 values defining the ends of each run of values and an array of values.
No description provided by the author
SparseUnion represents an array where each logical value is taken from a single child.
SparseUnionBuilder is used to build a Sparse Union array using the Append methods.
String represents an immutable sequence of variable-length UTF-8 strings.
A StringBuilder is used to build a String array using the Append methods.
No description provided by the author
No description provided by the author
Struct represents an ordered sequence of relative types.
No description provided by the author
TableReader is a Record iterator over a (possibly chunked) Table.
A type which represents an immutable sequence of arrow.Time32 values.
No description provided by the author
No description provided by the author
A type which represents an immutable sequence of arrow.Time64 values.
No description provided by the author
No description provided by the author
Timestamp represents an immutable sequence of arrow.Timestamp values.
No description provided by the author
No description provided by the author
A type which represents an immutable sequence of uint16 values.
No description provided by the author
No description provided by the author
A type which represents an immutable sequence of uint32 values.
No description provided by the author
No description provided by the author
A type which represents an immutable sequence of uint64 values.
No description provided by the author
No description provided by the author
A type which represents an immutable sequence of uint8 values.
No description provided by the author
No description provided by the author

# Interfaces

No description provided by the author
Builder provides an interface to build arrow arrays.
No description provided by the author
DictionaryUnifier defines the interface used for unifying, and optionally producing transposition maps for, multiple dictionary arrays incrementally.
ExtensionArray is the interface that needs to be implemented to handle user-defined extension type arrays.
ExtensionBuilderWrapper is an interface that you need to implement in your custom extension type if you want to provide a customer builder as well.
No description provided by the author
No description provided by the author
RecordReader reads a stream of records.
No description provided by the author
No description provided by the author
Union is a convenience interface to encompass both Sparse and Dense union array types.
UnionBuilder is a convenience interface for building Union arrays of either Dense or Sparse mode.
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

Edits is a slice of Edit structs that represents an edit script to compare two arrays.
EqualOption is a functional option type used to configure how Records and Arrays are compared.
No description provided by the author
No description provided by the author