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

Better document implications of offsets (#3228) #3243

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 17 additions & 1 deletion arrow-schema/src/datatype.rs
Original file line number Diff line number Diff line change
Expand Up @@ -149,21 +149,37 @@ pub enum DataType {
/// days can differ in length during day light savings time transitions).
Interval(IntervalUnit),
/// Opaque binary data of variable length.
///
/// A single Binary array can store up to [`i32::MAX`] bytes
/// 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
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
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
LargeUtf8,
/// A list of some logical data type with variable length.
///
/// A single List array can store up to [`i32::MAX`] elements in total
List(Box<Field>),
/// A list of some logical data type with fixed length.
FixedSizeList(Box<Field>, 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
LargeList(Box<Field>),
/// A nested datatype that contains a number of sub-fields.
Struct(Vec<Field>),
Expand Down