Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs for datatypes #5260

Merged
merged 4 commits into from
Dec 31, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 15 additions & 9 deletions arrow-schema/src/datatype.rs
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,18 @@ use crate::{Field, FieldRef, Fields, UnionFields};
/// The set of datatypes that are supported by this implementation of Apache Arrow.
///
/// The Arrow specification on data types includes some more types.
/// See also [`Schema.fbs`](https://github.com/apache/arrow/blob/master/format/Schema.fbs)
/// See also [`Schema.fbs`](https://github.com/apache/arrow/blob/main/format/Schema.fbs)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Current link works but shows popup everytime:

image

So just change to main

/// for Arrow's specification.
///
/// The variants of this enum include primitive fixed size types as well as parametric or
/// nested types.
/// Currently the Rust implementation supports the following nested types:
/// Currently the Rust implementation supports the following nested types:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

/// - `List<T>`
/// - `LargeList<T>`
/// - `FixedSizeList<T>`
/// - `Struct<T, U, V, ...>`
/// - `Union<T, U, V, ...>`
/// - `Map<K, V>`
///
/// Nested types can themselves be nested within other arrays.
/// For more information on these types please see
Expand Down Expand Up @@ -147,8 +151,10 @@ pub enum DataType {
/// in milliseconds (64 bits). Values are evenly divisible by 86400000.
Date64,
/// A 32-bit time representing the elapsed time since midnight in the unit of `TimeUnit`.
/// Must be either seconds or millieseconds.
Time32(TimeUnit),
/// A 64-bit time representing the elapsed time since midnight in the unit of `TimeUnit`.
/// Must be either microseconds or nanoseconds.
Time64(TimeUnit),
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Want to be explicit here as in isolation it can imply Time64 could take on seconds/milliseconds and Time32 could take on microseconds/nanoseconds based on TimeUnit enum alone

/// Measure of elapsed time in either seconds, milliseconds, microseconds or nanoseconds.
Duration(TimeUnit),
Expand All @@ -159,35 +165,35 @@ pub enum DataType {
/// Opaque binary data of variable length.
///
/// A single Binary array can store up to [`i32::MAX`] bytes
/// of binary data in total
/// of binary data in total.
Binary,
/// Opaque binary data of fixed size.
/// Enum parameter specifies the number of bytes per value.
FixedSizeBinary(i32),
/// Opaque binary data of variable length and 64-bit offsets.
///
/// A single LargeBinary array can store up to [`i64::MAX`] bytes
/// of binary data in total
/// of binary data in total.
LargeBinary,
/// A variable-length string in Unicode with UTF-8 encoding
/// A variable-length string in Unicode with UTF-8 encoding.
///
/// A single Utf8 array can store up to [`i32::MAX`] bytes
/// of string data in total
/// of string data in total.
Utf8,
/// A variable-length string in Unicode with UFT-8 encoding and 64-bit offsets.
///
/// A single LargeUtf8 array can store up to [`i64::MAX`] bytes
/// of string data in total
/// of string data in total.
LargeUtf8,
/// A list of some logical data type with variable length.
///
/// A single List array can store up to [`i32::MAX`] elements in total
/// A single List array can store up to [`i32::MAX`] elements in total.
List(FieldRef),
/// A list of some logical data type with fixed length.
FixedSizeList(FieldRef, i32),
/// A list of some logical data type with variable length and 64-bit offsets.
///
/// A single LargeList array can store up to [`i64::MAX`] elements in total
/// A single LargeList array can store up to [`i64::MAX`] elements in total.
LargeList(FieldRef),
/// A nested datatype that contains a number of sub-fields.
Struct(Fields),
Expand Down