You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by "tustvold (via GitHub)" <gi...@apache.org> on 2023/04/12 13:59:16 UTC
[GitHub] [arrow-rs] tustvold opened a new pull request, #4064: Add StructArray Constructors (#3879)
tustvold opened a new pull request, #4064:
URL: https://github.com/apache/arrow-rs/pull/4064
_Draft as builds on #4061_
# Which issue does this PR close?
<!--
We generally require a GitHub issue to be filed for all bug fixes and enhancements and this helps us generate change logs for our releases. You can link an issue to this PR using the GitHub syntax. For example `Closes #123` indicates that this PR will close issue #123.
-->
Part of #3879
# Rationale for this change
<!--
Why are you proposing this change? If this is already explained clearly in the issue then this section is not needed.
Explaining clearly why changes are proposed helps reviewers understand your changes and offer better suggestions for fixes.
-->
# What changes are included in this PR?
<!--
There is no need to duplicate the description in the issue here but it is sometimes worth providing a summary of the individual changes in this PR.
-->
# Are there any user-facing changes?
<!--
If there are user-facing changes then we may require documentation to be updated before approving the PR.
-->
<!---
If there are any breaking changes to public APIs, please add the `breaking change` label.
-->
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-rs] tustvold commented on pull request #4064: Add StructArray Constructors (#3879)
Posted by "tustvold (via GitHub)" <gi...@apache.org>.
tustvold commented on PR #4064:
URL: https://github.com/apache/arrow-rs/pull/4064#issuecomment-1522004795
I've added tests, well re-used the existing tests :smile:
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-rs] tustvold merged pull request #4064: Add StructArray Constructors (#3879)
Posted by "tustvold (via GitHub)" <gi...@apache.org>.
tustvold merged PR #4064:
URL: https://github.com/apache/arrow-rs/pull/4064
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-rs] tustvold commented on a diff in pull request #4064: Add StructArray Constructors (#3879)
Posted by "tustvold (via GitHub)" <gi...@apache.org>.
tustvold commented on code in PR #4064:
URL: https://github.com/apache/arrow-rs/pull/4064#discussion_r1176696424
##########
arrow-array/src/array/struct_array.rs:
##########
@@ -309,66 +309,18 @@ impl TryFrom<Vec<(&str, ArrayRef)>> for StructArray {
type Error = ArrowError;
/// builds a StructArray from a vector of names and arrays.
- /// This errors if the values have a different length.
- /// An entry is set to Null when all values are null.
Review Comment:
This doc comment isn't rendered in docs.rs so this somewhat peculiar behaviour was effectively not documented
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add StructArray Constructors (#3879) [arrow-rs]
Posted by "klion26 (via GitHub)" <gi...@apache.org>.
klion26 commented on code in PR #4064:
URL: https://github.com/apache/arrow-rs/pull/4064#discussion_r2004742125
##########
arrow-array/src/array/struct_array.rs:
##########
@@ -77,10 +77,136 @@ pub struct StructArray {
len: usize,
data_type: DataType,
nulls: Option<NullBuffer>,
- pub(crate) fields: Vec<ArrayRef>,
+ fields: Vec<ArrayRef>,
}
impl StructArray {
+ /// Create a new [`StructArray`] from the provided parts, panicking on failure
+ ///
+ /// # Panics
+ ///
+ /// Panics if [`Self::try_new`] returns an error
+ pub fn new(fields: Fields, arrays: Vec<ArrayRef>, nulls: Option<NullBuffer>) -> Self {
+ Self::try_new(fields, arrays, nulls).unwrap()
+ }
+
+ /// Create a new [`StructArray`] from the provided parts, returning an error on failure
+ ///
+ /// # Errors
+ ///
+ /// Errors if
+ ///
+ /// * `fields.len() != arrays.len()`
+ /// * `fields[i].data_type() != arrays[i].data_type()`
+ /// * `arrays[i].len() != arrays[j].len()`
+ /// * `arrays[i].len() != nulls.len()`
+ /// * `!fields[i].is_nullable() && !nulls.contains(arrays[i].nulls())`
+ pub fn try_new(
+ fields: Fields,
+ arrays: Vec<ArrayRef>,
+ nulls: Option<NullBuffer>,
+ ) -> Result<Self, ArrowError> {
+ if fields.len() != arrays.len() {
+ return Err(ArrowError::InvalidArgumentError(format!(
+ "Incorrect number of arrays for StructArray fields, expected {} got {}",
+ fields.len(),
+ arrays.len()
+ )));
+ }
+ let len = arrays.first().map(|x| x.len()).unwrap_or_default();
+
+ if let Some(n) = nulls.as_ref() {
+ if n.len() != len {
+ return Err(ArrowError::InvalidArgumentError(format!(
+ "Incorrect number of nulls for StructArray, expected {len} got {}",
+ n.len(),
+ )));
+ }
+ }
+
+ for (f, a) in fields.iter().zip(&arrays) {
+ if f.data_type() != a.data_type() {
+ return Err(ArrowError::InvalidArgumentError(format!(
+ "Incorrect datatype for StructArray field {:?}, expected {} got {}",
+ f.name(),
+ f.data_type(),
+ a.data_type()
+ )));
+ }
+
+ if a.len() != len {
+ return Err(ArrowError::InvalidArgumentError(format!(
+ "Incorrect array length for StructArray field {:?}, expected {} got {}",
Review Comment:
@tustvold, could you please share why we added a check to validate that all the fields of the `record` type have the same length here? Thanks.
I'm asking this because when playing with [an Avro file](https://github.com/user-attachments/files/19124467/56f216f3-7e24-40b0-a76a-87a63a5bc254-m0.avro.txt) with arrow-rs, it will panic there, after adding some debug message with the code `println!("Field:{f}, len:{:?} array:{:?}/{:?}", len, a.data_type(), a.len());` before line 137, the result showed as below
```
Field:Field { name: "content", data_type: Int32, nullable: false, dict_id: 0, dict_is_ordered: false, metadata: {} }, len:1 array:Int32/1
Field:Field { name: "file_path", data_type: Utf8, nullable: false, dict_id: 0, dict_is_ordered: false, metadata: {} }, len:1 array:Utf8/1
Field:Field { name: "file_format", data_type: Utf8, nullable: false, dict_id: 0, dict_is_ordered: false, metadata: {} }, len:1 array:Utf8/1
Field:Field { name: "partition", data_type: Struct([]), nullable: false, dict_id: 0, dict_is_ordered: false, metadata: {} }, len:1 array:Struct([])/0
Field:Field { name: "record_count", data_type: Int64, nullable: false, dict_id: 0, dict_is_ordered: false, metadata: {} }, len:1 array:Int64/1
Field:Field { name: "file_size_in_bytes", data_type: Int64, nullable: false, dict_id: 0, dict_is_ordered: false, metadata: {} }, len:1 array:Int64/1
Field:Field { name: "column_sizes", data_type: List(Field { name: "item", data_type: Struct([Field { name: "key", data_type: Int32, nullable: false, dict_id: 0, dict_is_ordered: false, metadata: {} }, Field { name: "value", data_type: Int64, nullable: false, dict_id: 0, dict_is_ordered: false, metadata: {} }]), nullable: true, dict_id: 0, dict_is_ordered: false, metadata: {} }), nullable: true, dict_id: 0, dict_is_ordered: false, metadata: {} }, len:1 array:List(Field { name: "item", data_type: Struct([Field { name: "key", data_type: Int32, nullable: false, dict_id: 0, dict_is_ordered: false, metadata: {} }, Field { name: "value", data_type: Int64, nullable: false, dict_id: 0, dict_is_ordered: false, metadata: {} }]), nullable: true, dict_id: 0, dict_is_ordered: false, metadata: {} })/1
Field:Field { name: "value_counts", data_type: List(Field { name: "item", data_type: Struct([Field { name: "key", data_type: Int32, nullable: false, dict_id: 0, dict_is_ordered: false, metadata: {} }, Field { name: "value", data_type: Int64, nullable: false, dict_id: 0, dict_is_ordered: false, metadata: {} }]), nullable: true, dict_id: 0, dict_is_ordered: false, metadata: {} }), nullable: true, dict_id: 0, dict_is_ordered: false, metadata: {} }, len:1 array:List(Field { name: "item", data_type: Struct([Field { name: "key", data_type: Int32, nullable: false, dict_id: 0, dict_is_ordered: false, metadata: {} }, Field { name: "value", data_type: Int64, nullable: false, dict_id: 0, dict_is_ordered: false, metadata: {} }]), nullable: true, dict_id: 0, dict_is_ordered: false, metadata: {} })/1
Field:Field { name: "null_value_counts", data_type: List(Field { name: "item", data_type: Struct([Field { name: "key", data_type: Int32, nullable: false, dict_id: 0, dict_is_ordered: false, metadata: {} }, Field { name: "value", data_type: Int64, nullable: false, dict_id: 0, dict_is_ordered: false, metadata: {} }]), nullable: true, dict_id: 0, dict_is_ordered: false, metadata: {} }), nullable: true, dict_id: 0, dict_is_ordered: false, metadata: {} }, len:1 array:List(Field { name: "item", data_type: Struct([Field { name: "key", data_type: Int32, nullable: false, dict_id: 0, dict_is_ordered: false, metadata: {} }, Field { name: "value", data_type: Int64, nullable: false, dict_id: 0, dict_is_ordered: false, metadata: {} }]), nullable: true, dict_id: 0, dict_is_ordered: false, metadata: {} })/1
Field:Field { name: "nan_value_counts", data_type: List(Field { name: "item", data_type: Struct([Field { name: "key", data_type: Int32, nullable: false, dict_id: 0, dict_is_ordered: false, metadata: {} }, Field { name: "value", data_type: Int64, nullable: false, dict_id: 0, dict_is_ordered: false, metadata: {} }]), nullable: true, dict_id: 0, dict_is_ordered: false, metadata: {} }), nullable: true, dict_id: 0, dict_is_ordered: false, metadata: {} }, len:1 array:List(Field { name: "item", data_type: Struct([Field { name: "key", data_type: Int32, nullable: false, dict_id: 0, dict_is_ordered: false, metadata: {} }, Field { name: "value", data_type: Int64, nullable: false, dict_id: 0, dict_is_ordered: false, metadata: {} }]), nullable: true, dict_id: 0, dict_is_ordered: false, metadata: {} })/1
Field:Field { name: "lower_bounds", data_type: List(Field { name: "item", data_type: Struct([Field { name: "key", data_type: Int32, nullable: false, dict_id: 0, dict_is_ordered: false, metadata: {} }, Field { name: "value", data_type: Binary, nullable: false, dict_id: 0, dict_is_ordered: false, metadata: {} }]), nullable: true, dict_id: 0, dict_is_ordered: false, metadata: {} }), nullable: true, dict_id: 0, dict_is_ordered: false, metadata: {} }, len:1 array:List(Field { name: "item", data_type: Struct([Field { name: "key", data_type: Int32, nullable: false, dict_id: 0, dict_is_ordered: false, metadata: {} }, Field { name: "value", data_type: Binary, nullable: false, dict_id: 0, dict_is_ordered: false, metadata: {} }]), nullable: true, dict_id: 0, dict_is_ordered: false, metadata: {} })/1
Field:Field { name: "upper_bounds", data_type: List(Field { name: "item", data_type: Struct([Field { name: "key", data_type: Int32, nullable: false, dict_id: 0, dict_is_ordered: false, metadata: {} }, Field { name: "value", data_type: Binary, nullable: false, dict_id: 0, dict_is_ordered: false, metadata: {} }]), nullable: true, dict_id: 0, dict_is_ordered: false, metadata: {} }), nullable: true, dict_id: 0, dict_is_ordered: false, metadata: {} }, len:1 array:List(Field { name: "item", data_type: Struct([Field { name: "key", data_type: Int32, nullable: false, dict_id: 0, dict_is_ordered: false, metadata: {} }, Field { name: "value", data_type: Binary, nullable: false, dict_id: 0, dict_is_ordered: false, metadata: {} }]), nullable: true, dict_id: 0, dict_is_ordered: false, metadata: {} })/1
Field:Field { name: "key_metadata", data_type: Binary, nullable: true, dict_id: 0, dict_is_ordered: false, metadata: {} }, len:1 array:Binary/1
Field:Field { name: "split_offsets", data_type: List(Field { name: "item", data_type: Int64, nullable: true, dict_id: 0, dict_is_ordered: false, metadata: {} }), nullable: true, dict_id: 0, dict_is_ordered: false, metadata: {"element-id": "133"} }, len:1 array:List(Field { name: "item", data_type: Int64, nullable: true, dict_id: 0, dict_is_ordered: false, metadata: {} })/1
Field:Field { name: "equality_ids", data_type: List(Field { name: "item", data_type: Int32, nullable: true, dict_id: 0, dict_is_ordered: false, metadata: {} }), nullable: true, dict_id: 0, dict_is_ordered: false, metadata: {"element-id": "136"} }, len:1 array:List(Field { name: "item", data_type: Int32, nullable: true, dict_id: 0, dict_is_ordered: false, metadata: {} })/1
Field:Field { name: "sort_order_id", data_type: Int32, nullable: true, dict_id: 0, dict_is_ordered: false, metadata: {} }, len:1 array:Int32/1
```
after reading the [spec](https://avro.apache.org/docs/++version++/specification/#schema-record) did not find that all the fields have the same length
If this logic here needs some improvements, maybe I can help here, thanks
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-rs] alamb commented on a diff in pull request #4064: Add StructArray Constructors (#3879)
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on code in PR #4064:
URL: https://github.com/apache/arrow-rs/pull/4064#discussion_r1167833025
##########
arrow-array/src/array/struct_array.rs:
##########
@@ -77,10 +77,136 @@ pub struct StructArray {
len: usize,
data_type: DataType,
nulls: Option<NullBuffer>,
- pub(crate) fields: Vec<ArrayRef>,
+ fields: Vec<ArrayRef>,
}
impl StructArray {
+ /// Create a new [`StructArray`] from the provided parts, panicking on failure
+ ///
+ /// # Panics
+ ///
+ /// Panics if [`Self::try_new`] returns an error
+ pub fn new(fields: Fields, arrays: Vec<ArrayRef>, nulls: Option<NullBuffer>) -> Self {
+ Self::try_new(fields, arrays, nulls).unwrap()
+ }
+
+ /// Create a new [`StructArray`] from the provided parts, returning an error on failure
+ ///
+ /// # Errors
+ ///
+ /// Errors if
+ ///
+ /// * `fields.len() != arrays.len()`
+ /// * `fields[i].data_type() != arrays[i].data_type()`
+ /// * `arrays[i].len() != arrays[j].len()`
+ /// * `arrays[i].len() != nulls.len()`
+ /// * `!fields[i].is_nullable() && !nulls.contains(arrays[i].nulls())`
+ pub fn try_new(
Review Comment:
As in the similar PRs, I think we should add test coverage for these new constructors, especially the error conditions
##########
arrow-array/src/array/struct_array.rs:
##########
@@ -359,37 +485,10 @@ impl std::fmt::Debug for StructArray {
impl From<(Vec<(Field, ArrayRef)>, Buffer)> for StructArray {
fn from(pair: (Vec<(Field, ArrayRef)>, Buffer)) -> Self {
- let capacity = pair.0.len();
Review Comment:
it is really nice that you are making the construction (and validation) of the various array types consistent ❤️
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-rs] alamb commented on a diff in pull request #4064: Add StructArray Constructors (#3879)
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on code in PR #4064:
URL: https://github.com/apache/arrow-rs/pull/4064#discussion_r1176851208
##########
arrow-array/src/array/struct_array.rs:
##########
@@ -77,10 +77,136 @@ pub struct StructArray {
len: usize,
data_type: DataType,
nulls: Option<NullBuffer>,
- pub(crate) fields: Vec<ArrayRef>,
+ fields: Vec<ArrayRef>,
}
impl StructArray {
+ /// Create a new [`StructArray`] from the provided parts, panicking on failure
+ ///
+ /// # Panics
+ ///
+ /// Panics if [`Self::try_new`] returns an error
+ pub fn new(fields: Fields, arrays: Vec<ArrayRef>, nulls: Option<NullBuffer>) -> Self {
+ Self::try_new(fields, arrays, nulls).unwrap()
+ }
+
+ /// Create a new [`StructArray`] from the provided parts, returning an error on failure
+ ///
+ /// # Errors
+ ///
+ /// Errors if
+ ///
+ /// * `fields.len() != arrays.len()`
+ /// * `fields[i].data_type() != arrays[i].data_type()`
+ /// * `arrays[i].len() != arrays[j].len()`
+ /// * `arrays[i].len() != nulls.len()`
+ /// * `!fields[i].is_nullable() && !nulls.contains(arrays[i].nulls())`
+ pub fn try_new(
Review Comment:
I verified that the error conditions are now covered (via `should_panic` messages). 👍
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org