-
Notifications
You must be signed in to change notification settings - Fork 892
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
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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) | ||
/// 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: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||
|
@@ -68,7 +72,7 @@ pub enum DataType { | |
/// | ||
/// Time is measured as a Unix epoch, counting the seconds from | ||
/// 00:00:00.000 on 1 January 1970, excluding leap seconds, | ||
/// as a 64-bit integer. | ||
/// as a signed 64-bit integer. | ||
/// | ||
/// The time zone is a string indicating the name of a time zone, one of: | ||
/// | ||
|
@@ -140,15 +144,17 @@ pub enum DataType { | |
/// DataType::Timestamp(TimeUnit::Second, Some("string".to_string().into())); | ||
/// ``` | ||
Timestamp(TimeUnit, Option<Arc<str>>), | ||
/// A 32-bit date representing the elapsed time since UNIX epoch (1970-01-01) | ||
/// A signed 32-bit date representing the elapsed time since UNIX epoch (1970-01-01) | ||
/// in days (32 bits). | ||
Date32, | ||
/// A 64-bit date representing the elapsed time since UNIX epoch (1970-01-01) | ||
/// A signed 64-bit date representing the elapsed time since UNIX epoch (1970-01-01) | ||
/// 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`. | ||
/// A signed 32-bit time representing the elapsed time since midnight in the unit of `TimeUnit`. | ||
/// Must be either seconds or milliseconds. | ||
Time32(TimeUnit), | ||
/// A 64-bit time representing the elapsed time since midnight in the unit of `TimeUnit`. | ||
/// A signed 64-bit time representing the elapsed time since midnight in the unit of `TimeUnit`. | ||
/// Must be either microseconds or nanoseconds. | ||
Time64(TimeUnit), | ||
/// Measure of elapsed time in either seconds, milliseconds, microseconds or nanoseconds. | ||
Duration(TimeUnit), | ||
|
@@ -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), | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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:
So just change to main