View Source arrow_ipc_schema (arrow v0.1.0)
Provides a record and functions to deal with Schemas
A Schema[1] represents a table, or a list of arrays of equal length. This module provides a record and a function to manage all the metadata required to represent a schema. Metadata such as:
endianness: The Endianness of the table. One oflittleorbig. Defaults tolittle.fields: The list of fields[2] in a table.type: The Layout of the columncustom_metadata: A list of custom metadata in key-value formatfeatures: Any features used by the table which may not be present in other implementations of Arrow.
Currently, big endianness, custom metadata and features are not supported, but they have been added for forwards comapatibility.
You can find Schemas in the Arrow spec here[3].
[3]: https://arrow.apache.org/docs/format/Columnar.html#schema-messageLink to this section Summary
Types
Endianness of the data. Either
little or big.Features used in the data which may not be present in other implementations. See the definition: https://github.com/apache/arrow/blob/3456131ab7350bee5d9569ffd63d3f0ee713991c/format/Schema.fbs#L51-L78
Functions
Creates a Schema given an ordered list of fields.
Link to this section Types
-type endianness() :: little | big.
little or big.
-type feature() :: unused | dictionary_replacement | compressed_body.
Link to this section Functions
-spec from_erlang(Fields :: [#field{}]) -> Schema :: #schema{}.