This is an automated email from the ASF dual-hosted git repository.
Jefffrey pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-rs.git
The following commit(s) were added to refs/heads/main by this push:
new b8bf07101e feat: coalesce fixed size binary (#11122)
b8bf07101e is described below
commit b8bf07101ed3582da0e2c24e0c21d0d79695b9db
Author: RIchard Baah <[email protected]>
AuthorDate: Mon Sep 21 05:27:06 2026 -0400
feat: coalesce fixed size binary (#11122)
# 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.
-->
- works towards #7761.
# Rationale for this change
FixedSizeBinary coalescing previously fell through to the generic
ArrayData-based path, which reconstructs offsets on every batch even
though fixed-size types have no offsets. This adds a specialized
InProgressFixedSizeBinaryArray that copies rows directly via
`FixedSizeBinaryBuilder::append_array`, avoiding that overhead.
<!--
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?
This PR adds a specialized InProgressFixedSizeBinaryArray that copies
rows directly via `FixedSizeBinaryBuilder::append_array`, avoiding that
overhead.
<!--
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 these changes tested?
yes, test are included
<!--
We typically require tests for all PRs in order to:
1. Prevent the code from being accidentally broken by subsequent changes
2. Serve as another way to document the expected behavior of the code
If tests are not included in your PR, please explain why (for example,
are they covered by existing tests)?
If this PR claims a performance improvement, please include evidence
such as benchmark results.
-->
# Are there any user-facing changes?
no
<!--
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 call them out.
-->
---
arrow-select/src/coalesce.rs | 5 +
arrow-select/src/coalesce/fixed_size_binary.rs | 171 +++++++++++++++++++++++++
2 files changed, 176 insertions(+)
diff --git a/arrow-select/src/coalesce.rs b/arrow-select/src/coalesce.rs
index 48b26d3e7c..929526ef40 100644
--- a/arrow-select/src/coalesce.rs
+++ b/arrow-select/src/coalesce.rs
@@ -31,10 +31,12 @@ use std::sync::Arc;
//
https://github.com/apache/datafusion/blob/9d2f04996604e709ee440b65f41e7b882f50b788/datafusion/physical-plan/src/coalesce/mod.rs#L26-L25
mod byte_view;
+mod fixed_size_binary;
mod generic;
mod primitive;
use byte_view::InProgressByteViewArray;
+use fixed_size_binary::InProgressFixedSizeBinaryArray;
use generic::GenericInProgressArray;
use primitive::InProgressPrimitiveArray;
@@ -699,6 +701,9 @@ fn create_in_progress_array(data_type: &DataType,
batch_size: usize) -> Box<dyn
DataType::BinaryView => {
Box::new(InProgressByteViewArray::<BinaryViewType>::new(batch_size))
}
+ DataType::FixedSizeBinary(size) => {
+ Box::new(InProgressFixedSizeBinaryArray::new(*size, batch_size))
+ }
_ => Box::new(GenericInProgressArray::new()),
}
}
diff --git a/arrow-select/src/coalesce/fixed_size_binary.rs
b/arrow-select/src/coalesce/fixed_size_binary.rs
new file mode 100644
index 0000000000..296a977d3c
--- /dev/null
+++ b/arrow-select/src/coalesce/fixed_size_binary.rs
@@ -0,0 +1,171 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+use super::InProgressArray;
+use crate::filter::FilterPredicate;
+use arrow_array::builder::FixedSizeBinaryBuilder;
+use arrow_array::cast::AsArray;
+use arrow_array::{Array, ArrayRef};
+use arrow_schema::ArrowError;
+use std::sync::Arc;
+
+/// Specialized [`InProgressArray`] for `FixedSizeBinary` columns.
+#[derive(Debug)]
+pub(crate) struct InProgressFixedSizeBinaryArray {
+ source: Option<ArrayRef>,
+ value_length: i32,
+ batch_size: usize,
+ builder: Option<FixedSizeBinaryBuilder>,
+}
+
+impl InProgressFixedSizeBinaryArray {
+ pub(crate) fn new(value_length: i32, batch_size: usize) -> Self {
+ Self {
+ source: None,
+ value_length,
+ batch_size,
+ builder: None,
+ }
+ }
+
+ fn ensure_builder(&mut self) -> &mut FixedSizeBinaryBuilder {
+ self.builder.get_or_insert_with(|| {
+ FixedSizeBinaryBuilder::with_capacity(self.batch_size,
self.value_length)
+ })
+ }
+}
+
+impl InProgressArray for InProgressFixedSizeBinaryArray {
+ fn set_source(&mut self, source: Option<ArrayRef>) {
+ self.source = source;
+ }
+
+ fn copy_rows(&mut self, offset: usize, len: usize) -> Result<(),
ArrowError> {
+ let source = self.source.as_ref().ok_or_else(|| {
+ ArrowError::InvalidArgumentError(
+ "Internal Error: InProgressFixedSizeBinaryArray: source not
set".to_string(),
+ )
+ })?;
+ let sliced = source.as_fixed_size_binary().slice(offset, len);
+ self.ensure_builder().append_array(&sliced)?;
+ Ok(())
+ }
+
+ fn copy_rows_by_filter_from(
+ &mut self,
+ source: ArrayRef,
+ filter: &FilterPredicate,
+ ) -> Result<(), ArrowError> {
+ let filtered = filter.filter(source.as_ref())?;
+ if !filtered.is_empty() {
+ self.ensure_builder()
+ .append_array(filtered.as_fixed_size_binary())?;
+ }
+ Ok(())
+ }
+
+ fn finish(&mut self) -> Result<ArrayRef, ArrowError> {
+ let mut b = self
+ .builder
+ .take()
+ .unwrap_or_else(|| FixedSizeBinaryBuilder::new(self.value_length));
+ Ok(Arc::new(b.finish()))
+ }
+
+ fn size(&self) -> usize {
+ self.builder.as_ref().map_or(0, |b| b.capacity())
+ + self
+ .source
+ .as_ref()
+ .map_or(0, |a| a.get_array_memory_size())
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ use crate::filter::FilterBuilder;
+ use arrow_array::{BooleanArray, FixedSizeBinaryArray};
+
+ fn make_fsb(value_length: i32, data: &[Option<&[u8]>]) ->
FixedSizeBinaryArray {
+ let mut b = FixedSizeBinaryBuilder::with_capacity(data.len(),
value_length);
+ for v in data {
+ match v {
+ Some(bytes) => b.append_value(bytes).unwrap(),
+ None => b.append_null(),
+ }
+ }
+ b.finish()
+ }
+
+ #[test]
+ fn test_roundtrip_with_nulls() {
+ let source = Arc::new(make_fsb(4, &[Some(b"abcd"), None,
Some(b"ijkl")])) as ArrayRef;
+ let mut coalescer = InProgressFixedSizeBinaryArray::new(4, 8);
+ coalescer.set_source(Some(Arc::clone(&source)));
+ coalescer.copy_rows(0, 3).unwrap();
+ let output = coalescer.finish().unwrap();
+ let output = output.as_fixed_size_binary();
+ assert_eq!(output.len(), 3);
+ assert_eq!(output.value(0), b"abcd");
+ assert!(output.is_null(1));
+ assert_eq!(output.value(2), b"ijkl");
+ }
+
+ #[test]
+ fn test_offset_copy() {
+ let source =
+ Arc::new(make_fsb(4, &[Some(b"aaaa"), Some(b"bbbb"),
Some(b"cccc")])) as ArrayRef;
+ let mut coalescer = InProgressFixedSizeBinaryArray::new(4, 8);
+ coalescer.set_source(Some(Arc::clone(&source)));
+ coalescer.copy_rows(1, 2).unwrap();
+ let output = coalescer.finish().unwrap();
+ let output = output.as_fixed_size_binary();
+ assert_eq!(output.len(), 2);
+ assert_eq!(output.value(0), b"bbbb");
+ assert_eq!(output.value(1), b"cccc");
+ }
+
+ #[test]
+ fn test_finish_preserves_value_length() {
+ // finish() with no rows written should still produce an array with
the correct value_length
+ let mut coalescer = InProgressFixedSizeBinaryArray::new(16, 8);
+ let output = coalescer.finish().unwrap();
+ let output = output.as_fixed_size_binary();
+ assert_eq!(output.len(), 0);
+ assert_eq!(output.value_length(), 16);
+ }
+
+ #[test]
+ fn test_filter_path() {
+ let source = Arc::new(make_fsb(
+ 4,
+ &[Some(b"aaaa"), Some(b"bbbb"), Some(b"cccc"), Some(b"dddd")],
+ )) as ArrayRef;
+ let filter_mask = BooleanArray::from(vec![true, false, true, false]);
+ let predicate = FilterBuilder::new(&filter_mask).build();
+ let mut coalescer = InProgressFixedSizeBinaryArray::new(4, 8);
+ coalescer
+ .copy_rows_by_filter_from(source, &predicate)
+ .unwrap();
+ let output = coalescer.finish().unwrap();
+ let output = output.as_fixed_size_binary();
+ assert_eq!(output.len(), 2);
+ assert_eq!(output.value(0), b"aaaa");
+ assert_eq!(output.value(1), b"cccc");
+ }
+}
