Repository navigation
Expand file tree
/
Copy pathunshred_variant.rs
More file actions
819 lines (733 loc) · 33.2 KB
/
Copy pathunshred_variant.rs
File metadata and controls
819 lines (733 loc) · 33.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
// 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.
//! Module for unshredding VariantArray by folding typed_value columns back into the value column.
use crate::variant_array::binary_array_value;
use crate::{BorrowedShreddingState, VariantArray, VariantValueArrayBuilder};
use arrow::array::{
Array, ArrayRef, AsArray as _, BinaryArray, BinaryViewArray, BooleanArray,
FixedSizeBinaryArray, FixedSizeListArray, GenericListArray, GenericListViewArray,
LargeBinaryArray, LargeStringArray, ListLikeArray, PrimitiveArray, StringArray,
StringViewArray, StructArray,
};
use arrow::buffer::NullBuffer;
use arrow::datatypes::{
ArrowPrimitiveType, DataType, Date32Type, Decimal32Type, Decimal64Type, Decimal128Type,
DecimalType, Float32Type, Float64Type, Int8Type, Int16Type, Int32Type, Int64Type,
Time64MicrosecondType, TimeUnit, TimestampMicrosecondType, TimestampNanosecondType,
};
use arrow::error::{ArrowError, Result};
use arrow::temporal_conversions::time64us_to_time;
use chrono::{DateTime, Utc};
use indexmap::IndexMap;
use parquet_variant::{
ObjectFieldBuilder, Variant, VariantBuilderExt, VariantDecimal4, VariantDecimal8,
VariantDecimal16, VariantDecimalType, VariantMetadata,
};
use std::marker::PhantomData;
use std::sync::Arc;
use uuid::Uuid;
/// Removes all (nested) typed_value columns from a VariantArray by converting them back to binary
/// variant and merging the resulting values back into the value column.
///
/// This function efficiently converts a shredded VariantArray back to an unshredded form where all
/// data resides in the value column.
///
/// # Arguments
/// * `array` - The VariantArray to unshred
///
/// # Returns
/// A new VariantArray with all data in the value column and no typed_value column
///
/// # Errors
/// - If the shredded data contains spec violations (e.g., field name conflicts)
/// - If unsupported data types are encountered in typed_value columns
pub fn unshred_variant(array: &VariantArray) -> Result<VariantArray> {
// Check if already unshredded (optimization for common case)
if array.typed_value_field().is_none() && array.value_field().is_some() {
return Ok(array.clone());
}
// NOTE: None/None at top-level is technically invalid, but the shredding spec requires us to
// emit `Variant::Null` when a required value is missing.
let nulls = array.nulls();
let mut row_builder = UnshredVariantRowBuilder::try_new_opt(array.shredding_state().borrow())?
.unwrap_or_else(|| UnshredVariantRowBuilder::null(nulls));
let metadata = array.metadata_field();
let mut value_builder = VariantValueArrayBuilder::new(array.len());
for i in 0..array.len() {
if array.is_null(i) {
value_builder.append_null();
} else {
let metadata_bytes = binary_array_value(metadata.as_ref(), i).ok_or_else(|| {
ArrowError::InvalidArgumentError(
"metadata field must be a binary-like array".to_string(),
)
})?;
let metadata = VariantMetadata::try_new(metadata_bytes)?;
let mut value_builder = value_builder.builder_ext(&metadata);
row_builder.append_row(&mut value_builder, &metadata, i)?;
}
}
let value = value_builder.build()?;
Ok(VariantArray::from_parts(
metadata.clone(),
Some(Arc::new(value)),
None,
nulls.cloned(),
))
}
/// Row builder for converting shredded VariantArray rows back to unshredded form
enum UnshredVariantRowBuilder<'a> {
PrimitiveInt8(UnshredPrimitiveRowBuilder<'a, PrimitiveArray<Int8Type>>),
PrimitiveInt16(UnshredPrimitiveRowBuilder<'a, PrimitiveArray<Int16Type>>),
PrimitiveInt32(UnshredPrimitiveRowBuilder<'a, PrimitiveArray<Int32Type>>),
PrimitiveInt64(UnshredPrimitiveRowBuilder<'a, PrimitiveArray<Int64Type>>),
PrimitiveFloat32(UnshredPrimitiveRowBuilder<'a, PrimitiveArray<Float32Type>>),
PrimitiveFloat64(UnshredPrimitiveRowBuilder<'a, PrimitiveArray<Float64Type>>),
Decimal32(DecimalUnshredRowBuilder<'a, Decimal32Type, VariantDecimal4>),
Decimal64(DecimalUnshredRowBuilder<'a, Decimal64Type, VariantDecimal8>),
Decimal128(DecimalUnshredRowBuilder<'a, Decimal128Type, VariantDecimal16>),
PrimitiveDate32(UnshredPrimitiveRowBuilder<'a, PrimitiveArray<Date32Type>>),
PrimitiveTime64(UnshredPrimitiveRowBuilder<'a, PrimitiveArray<Time64MicrosecondType>>),
TimestampMicrosecond(TimestampUnshredRowBuilder<'a, TimestampMicrosecondType>),
TimestampNanosecond(TimestampUnshredRowBuilder<'a, TimestampNanosecondType>),
PrimitiveBoolean(UnshredPrimitiveRowBuilder<'a, BooleanArray>),
PrimitiveString(UnshredPrimitiveRowBuilder<'a, StringArray>),
PrimitiveStringView(UnshredPrimitiveRowBuilder<'a, StringViewArray>),
PrimitiveLargeString(UnshredPrimitiveRowBuilder<'a, LargeStringArray>),
PrimitiveBinary(UnshredPrimitiveRowBuilder<'a, BinaryArray>),
PrimitiveBinaryView(UnshredPrimitiveRowBuilder<'a, BinaryViewArray>),
PrimitiveLargeBinary(UnshredPrimitiveRowBuilder<'a, LargeBinaryArray>),
PrimitiveUuid(UnshredPrimitiveRowBuilder<'a, FixedSizeBinaryArray>),
List(ListUnshredVariantBuilder<'a, GenericListArray<i32>>),
LargeList(ListUnshredVariantBuilder<'a, GenericListArray<i64>>),
ListView(ListUnshredVariantBuilder<'a, GenericListViewArray<i32>>),
LargeListView(ListUnshredVariantBuilder<'a, GenericListViewArray<i64>>),
FixedSizeList(ListUnshredVariantBuilder<'a, FixedSizeListArray>),
Struct(StructUnshredVariantBuilder<'a>),
ValueOnly(ValueOnlyUnshredVariantBuilder<'a>),
Null(NullUnshredVariantBuilder<'a>),
}
impl<'a> UnshredVariantRowBuilder<'a> {
/// Creates an all-null row builder.
fn null(nulls: Option<&'a NullBuffer>) -> Self {
Self::Null(NullUnshredVariantBuilder::new(nulls))
}
/// Appends a single row at the given value index to the supplied builder.
fn append_row(
&mut self,
builder: &mut impl VariantBuilderExt,
metadata: &VariantMetadata,
index: usize,
) -> Result<()> {
match self {
Self::PrimitiveInt8(b) => b.append_row(builder, metadata, index),
Self::PrimitiveInt16(b) => b.append_row(builder, metadata, index),
Self::PrimitiveInt32(b) => b.append_row(builder, metadata, index),
Self::PrimitiveInt64(b) => b.append_row(builder, metadata, index),
Self::PrimitiveFloat32(b) => b.append_row(builder, metadata, index),
Self::PrimitiveFloat64(b) => b.append_row(builder, metadata, index),
Self::Decimal32(b) => b.append_row(builder, metadata, index),
Self::Decimal64(b) => b.append_row(builder, metadata, index),
Self::Decimal128(b) => b.append_row(builder, metadata, index),
Self::PrimitiveDate32(b) => b.append_row(builder, metadata, index),
Self::PrimitiveTime64(b) => b.append_row(builder, metadata, index),
Self::TimestampMicrosecond(b) => b.append_row(builder, metadata, index),
Self::TimestampNanosecond(b) => b.append_row(builder, metadata, index),
Self::PrimitiveBoolean(b) => b.append_row(builder, metadata, index),
Self::PrimitiveString(b) => b.append_row(builder, metadata, index),
Self::PrimitiveStringView(b) => b.append_row(builder, metadata, index),
Self::PrimitiveLargeString(b) => b.append_row(builder, metadata, index),
Self::PrimitiveBinary(b) => b.append_row(builder, metadata, index),
Self::PrimitiveBinaryView(b) => b.append_row(builder, metadata, index),
Self::PrimitiveLargeBinary(b) => b.append_row(builder, metadata, index),
Self::PrimitiveUuid(b) => b.append_row(builder, metadata, index),
Self::List(b) => b.append_row(builder, metadata, index),
Self::LargeList(b) => b.append_row(builder, metadata, index),
Self::ListView(b) => b.append_row(builder, metadata, index),
Self::LargeListView(b) => b.append_row(builder, metadata, index),
Self::FixedSizeList(b) => b.append_row(builder, metadata, index),
Self::Struct(b) => b.append_row(builder, metadata, index),
Self::ValueOnly(b) => b.append_row(builder, metadata, index),
Self::Null(b) => b.append_row(builder, metadata, index),
}
}
/// Creates a new UnshredVariantRowBuilder from shredding state
/// Returns None for None/None case - caller decides how to handle based on context
fn try_new_opt(shredding_state: BorrowedShreddingState<'a>) -> Result<Option<Self>> {
let value = shredding_state.value_field();
let typed_value = shredding_state.typed_value_field();
let Some(typed_value) = typed_value else {
// Copy the value across directly, if present. Else caller decides what to do.
return Ok(value.map(|v| Self::ValueOnly(ValueOnlyUnshredVariantBuilder::new(v))));
};
// Has typed_value -> determine type and create appropriate builder
macro_rules! primitive_builder {
($enum_variant:ident, $cast_fn:ident) => {
Self::$enum_variant(UnshredPrimitiveRowBuilder::new(
value,
typed_value.$cast_fn(),
))
};
}
let builder = match typed_value.data_type() {
DataType::Int8 => primitive_builder!(PrimitiveInt8, as_primitive),
DataType::Int16 => primitive_builder!(PrimitiveInt16, as_primitive),
DataType::Int32 => primitive_builder!(PrimitiveInt32, as_primitive),
DataType::Int64 => primitive_builder!(PrimitiveInt64, as_primitive),
DataType::Float32 => primitive_builder!(PrimitiveFloat32, as_primitive),
DataType::Float64 => primitive_builder!(PrimitiveFloat64, as_primitive),
DataType::Decimal32(p, s) if VariantDecimal4::is_valid_precision_and_scale(p, s) => {
Self::Decimal32(DecimalUnshredRowBuilder::new(value, typed_value, *s as _))
}
DataType::Decimal64(p, s) if VariantDecimal8::is_valid_precision_and_scale(p, s) => {
Self::Decimal64(DecimalUnshredRowBuilder::new(value, typed_value, *s as _))
}
DataType::Decimal128(p, s) if VariantDecimal16::is_valid_precision_and_scale(p, s) => {
Self::Decimal128(DecimalUnshredRowBuilder::new(value, typed_value, *s as _))
}
DataType::Decimal32(_, _)
| DataType::Decimal64(_, _)
| DataType::Decimal128(_, _)
| DataType::Decimal256(_, _) => {
return Err(ArrowError::InvalidArgumentError(format!(
"{} is not a valid variant shredding type",
typed_value.data_type()
)));
}
DataType::Date32 => primitive_builder!(PrimitiveDate32, as_primitive),
DataType::Time64(TimeUnit::Microsecond) => {
primitive_builder!(PrimitiveTime64, as_primitive)
}
DataType::Time64(time_unit) => {
return Err(ArrowError::InvalidArgumentError(format!(
"Time64({time_unit}) is not a valid variant shredding type",
)));
}
DataType::Timestamp(TimeUnit::Microsecond, timezone) => Self::TimestampMicrosecond(
TimestampUnshredRowBuilder::new(value, typed_value, timezone.is_some()),
),
DataType::Timestamp(TimeUnit::Nanosecond, timezone) => Self::TimestampNanosecond(
TimestampUnshredRowBuilder::new(value, typed_value, timezone.is_some()),
),
DataType::Timestamp(time_unit, _) => {
return Err(ArrowError::InvalidArgumentError(format!(
"Timestamp({time_unit}) is not a valid variant shredding type",
)));
}
DataType::Boolean => primitive_builder!(PrimitiveBoolean, as_boolean),
DataType::Utf8 => primitive_builder!(PrimitiveString, as_string),
DataType::Utf8View => primitive_builder!(PrimitiveStringView, as_string_view),
DataType::LargeUtf8 => primitive_builder!(PrimitiveLargeString, as_string),
DataType::Binary => primitive_builder!(PrimitiveBinary, as_binary),
DataType::BinaryView => primitive_builder!(PrimitiveBinaryView, as_binary_view),
DataType::LargeBinary => primitive_builder!(PrimitiveLargeBinary, as_binary),
DataType::FixedSizeBinary(16) => {
primitive_builder!(PrimitiveUuid, as_fixed_size_binary)
}
DataType::FixedSizeBinary(size) => {
return Err(ArrowError::InvalidArgumentError(format!(
"FixedSizeBinary({size}) is not a valid variant shredding type",
)));
}
DataType::Struct(_) => Self::Struct(StructUnshredVariantBuilder::try_new(
value,
typed_value.as_struct(),
)?),
DataType::List(_) => Self::List(ListUnshredVariantBuilder::try_new(
value,
typed_value.as_list(),
)?),
DataType::LargeList(_) => Self::LargeList(ListUnshredVariantBuilder::try_new(
value,
typed_value.as_list(),
)?),
DataType::ListView(_) => Self::ListView(ListUnshredVariantBuilder::try_new(
value,
typed_value.as_list_view(),
)?),
DataType::LargeListView(_) => Self::LargeListView(ListUnshredVariantBuilder::try_new(
value,
typed_value.as_list_view(),
)?),
DataType::FixedSizeList(_, _) => Self::FixedSizeList(
ListUnshredVariantBuilder::try_new(value, typed_value.as_fixed_size_list())?,
),
_ => {
return Err(ArrowError::NotYetImplemented(format!(
"Unshredding not yet supported for type: {}",
typed_value.data_type()
)));
}
};
Ok(Some(builder))
}
}
/// Builder for arrays with neither typed_value nor value (all NULL/Variant::Null)
struct NullUnshredVariantBuilder<'a> {
nulls: Option<&'a NullBuffer>,
}
impl<'a> NullUnshredVariantBuilder<'a> {
fn new(nulls: Option<&'a NullBuffer>) -> Self {
Self { nulls }
}
fn append_row(
&mut self,
builder: &mut impl VariantBuilderExt,
_metadata: &VariantMetadata,
index: usize,
) -> Result<()> {
if self.nulls.is_some_and(|nulls| nulls.is_null(index)) {
builder.append_null();
} else {
builder.append_value(Variant::Null);
}
Ok(())
}
}
/// Builder for arrays that only have value column (already unshredded)
struct ValueOnlyUnshredVariantBuilder<'a> {
value: &'a ArrayRef,
}
impl<'a> ValueOnlyUnshredVariantBuilder<'a> {
fn new(value: &'a ArrayRef) -> Self {
Self { value }
}
fn append_row(
&mut self,
builder: &mut impl VariantBuilderExt,
metadata: &VariantMetadata,
index: usize,
) -> Result<()> {
if self.value.is_null(index) {
builder.append_null();
} else {
let value_bytes = binary_array_value(self.value.as_ref(), index).ok_or_else(|| {
ArrowError::InvalidArgumentError(
"value field must be a binary-like array".to_string(),
)
})?;
let variant = Variant::try_new_with_metadata(metadata.clone(), value_bytes)?;
builder.append_value(variant);
}
Ok(())
}
}
/// Extension trait that directly adds row builder support for arrays that correspond to primitive
/// variant types.
trait AppendToVariantBuilder: Array {
fn append_to_variant_builder(
&self,
builder: &mut impl VariantBuilderExt,
index: usize,
) -> Result<()>;
}
/// Macro that handles the unshredded case (typed_value is missing or NULL) and returns early if
/// handled. If not handled (shredded case), validates and returns the extracted value.
macro_rules! handle_unshredded_case {
($self:expr, $builder:expr, $metadata:expr, $index:expr, $partial_shredding:expr) => {{
let value = $self.value.as_ref().filter(|v| v.is_valid($index));
let value = value
.map(|v| {
let bytes = binary_array_value(v.as_ref(), $index).ok_or_else(|| {
ArrowError::InvalidArgumentError(format!(
"value field must be a binary-like array, instead got {}",
v.data_type(),
))
})?;
Variant::try_new_with_metadata($metadata.clone(), bytes)
})
.transpose()?;
// If typed_value is null, handle unshredded case and return early
if $self.typed_value.is_null($index) {
match value {
Some(value) => $builder.append_value(value),
None => $builder.append_null(),
}
return Ok(());
}
// Only partial shredding allows value and typed_value to both be non-NULL
if !$partial_shredding && value.is_some() {
return Err(ArrowError::InvalidArgumentError(
"Invalid shredded variant: both value and typed_value are non-null".to_string(),
));
}
// Return the extracted value for the partial shredded case
value
}};
}
/// Generic unshred builder that works with any Array implementing AppendToVariantBuilder
struct UnshredPrimitiveRowBuilder<'a, T> {
value: Option<&'a ArrayRef>,
typed_value: &'a T,
}
impl<'a, T: AppendToVariantBuilder> UnshredPrimitiveRowBuilder<'a, T> {
fn new(value: Option<&'a ArrayRef>, typed_value: &'a T) -> Self {
Self { value, typed_value }
}
fn append_row(
&mut self,
builder: &mut impl VariantBuilderExt,
metadata: &VariantMetadata,
index: usize,
) -> Result<()> {
handle_unshredded_case!(self, builder, metadata, index, false);
// If we get here, typed_value is valid and value is NULL
self.typed_value.append_to_variant_builder(builder, index)
}
}
// Macro to generate AppendToVariantBuilder implementations with optional value transformation
macro_rules! impl_append_to_variant_builder {
($array_type:ty $(, |$v:ident| $transform:expr)? ) => {
impl AppendToVariantBuilder for $array_type {
fn append_to_variant_builder(
&self,
builder: &mut impl VariantBuilderExt,
index: usize,
) -> Result<()> {
let value = self.value(index);
$(
let $v = value;
let value = $transform;
)?
builder.append_value(value);
Ok(())
}
}
};
}
impl_append_to_variant_builder!(BooleanArray);
impl_append_to_variant_builder!(StringArray);
impl_append_to_variant_builder!(StringViewArray);
impl_append_to_variant_builder!(LargeStringArray);
impl_append_to_variant_builder!(BinaryArray);
impl_append_to_variant_builder!(BinaryViewArray);
impl_append_to_variant_builder!(LargeBinaryArray);
impl_append_to_variant_builder!(PrimitiveArray<Int8Type>);
impl_append_to_variant_builder!(PrimitiveArray<Int16Type>);
impl_append_to_variant_builder!(PrimitiveArray<Int32Type>);
impl_append_to_variant_builder!(PrimitiveArray<Int64Type>);
impl_append_to_variant_builder!(PrimitiveArray<Float32Type>);
impl_append_to_variant_builder!(PrimitiveArray<Float64Type>);
impl_append_to_variant_builder!(PrimitiveArray<Date32Type>, |days_since_epoch| {
Date32Type::to_naive_date_opt(days_since_epoch).ok_or_else(|| {
ArrowError::InvalidArgumentError(format!("Invalid Date32 value: {days_since_epoch}"))
})?
});
impl_append_to_variant_builder!(
PrimitiveArray<Time64MicrosecondType>,
|micros_since_midnight| {
time64us_to_time(micros_since_midnight).ok_or_else(|| {
ArrowError::InvalidArgumentError(format!(
"Invalid Time64 microsecond value: {micros_since_midnight}"
))
})?
}
);
// UUID from FixedSizeBinary(16)
// NOTE: FixedSizeBinaryArray guarantees the byte length, so we can safely unwrap
impl_append_to_variant_builder!(FixedSizeBinaryArray, |bytes| {
Uuid::from_slice(bytes).unwrap()
});
/// Trait for timestamp types to handle conversion to `DateTime<Utc>`
trait TimestampType: ArrowPrimitiveType<Native = i64> {
fn to_datetime_utc(value: i64) -> Result<DateTime<Utc>>;
}
impl TimestampType for TimestampMicrosecondType {
fn to_datetime_utc(micros: i64) -> Result<DateTime<Utc>> {
DateTime::from_timestamp_micros(micros).ok_or_else(|| {
ArrowError::InvalidArgumentError(format!(
"Invalid timestamp microsecond value: {micros}"
))
})
}
}
impl TimestampType for TimestampNanosecondType {
fn to_datetime_utc(nanos: i64) -> Result<DateTime<Utc>> {
Ok(DateTime::from_timestamp_nanos(nanos))
}
}
/// Generic builder for timestamp types that handles timezone-aware conversion
struct TimestampUnshredRowBuilder<'a, T: TimestampType> {
value: Option<&'a ArrayRef>,
typed_value: &'a PrimitiveArray<T>,
has_timezone: bool,
}
impl<'a, T: TimestampType> TimestampUnshredRowBuilder<'a, T> {
fn new(value: Option<&'a ArrayRef>, typed_value: &'a dyn Array, has_timezone: bool) -> Self {
Self {
value,
typed_value: typed_value.as_primitive(),
has_timezone,
}
}
fn append_row(
&mut self,
builder: &mut impl VariantBuilderExt,
metadata: &VariantMetadata,
index: usize,
) -> Result<()> {
handle_unshredded_case!(self, builder, metadata, index, false);
// If we get here, typed_value is valid and value is NULL
let timestamp_value = self.typed_value.value(index);
let dt = T::to_datetime_utc(timestamp_value)?;
if self.has_timezone {
builder.append_value(dt);
} else {
builder.append_value(dt.naive_utc());
}
Ok(())
}
}
/// Generic builder for decimal unshredding
struct DecimalUnshredRowBuilder<'a, A: DecimalType, V>
where
V: VariantDecimalType<Native = A::Native>,
{
value: Option<&'a ArrayRef>,
typed_value: &'a PrimitiveArray<A>,
scale: i8,
_phantom: PhantomData<V>,
}
impl<'a, A: DecimalType, V> DecimalUnshredRowBuilder<'a, A, V>
where
V: VariantDecimalType<Native = A::Native>,
{
fn new(value: Option<&'a ArrayRef>, typed_value: &'a dyn Array, scale: i8) -> Self {
Self {
value,
typed_value: typed_value.as_primitive(),
scale,
_phantom: PhantomData,
}
}
fn append_row(
&mut self,
builder: &mut impl VariantBuilderExt,
metadata: &VariantMetadata,
index: usize,
) -> Result<()> {
handle_unshredded_case!(self, builder, metadata, index, false);
let raw = self.typed_value.value(index);
let variant = V::try_new_with_signed_scale(raw, self.scale)?;
builder.append_value(variant);
Ok(())
}
}
/// Builder for unshredding struct/object types with nested fields
struct StructUnshredVariantBuilder<'a> {
value: Option<&'a ArrayRef>,
typed_value: &'a arrow::array::StructArray,
field_unshredders: IndexMap<&'a str, Option<UnshredVariantRowBuilder<'a>>>,
}
impl<'a> StructUnshredVariantBuilder<'a> {
fn try_new(value: Option<&'a ArrayRef>, typed_value: &'a StructArray) -> Result<Self> {
// Create unshredders for each field in constructor
let mut field_unshredders = IndexMap::new();
for (field, field_array) in typed_value.fields().iter().zip(typed_value.columns()) {
// Factory returns None for None/None case -- these are missing fields we should skip
let Some(field_array) = field_array.as_struct_opt() else {
return Err(ArrowError::InvalidArgumentError(format!(
"Invalid shredded variant object field: expected Struct, got {}",
field_array.data_type()
)));
};
let field_unshredder = UnshredVariantRowBuilder::try_new_opt(field_array.try_into()?)?;
field_unshredders.insert(field.name().as_ref(), field_unshredder);
}
Ok(Self {
value,
typed_value,
field_unshredders,
})
}
fn append_row(
&mut self,
builder: &mut impl VariantBuilderExt,
metadata: &VariantMetadata,
index: usize,
) -> Result<()> {
let value = handle_unshredded_case!(self, builder, metadata, index, true);
// If we get here, typed_value is valid and value may or may not be valid
let mut object_builder = builder.try_new_object()?;
// Process typed fields (skip empty builders that indicate missing fields)
for (field_name, field_unshredder_opt) in &mut self.field_unshredders {
if let Some(field_unshredder) = field_unshredder_opt {
let mut field_builder = ObjectFieldBuilder::new(field_name, &mut object_builder);
field_unshredder.append_row(&mut field_builder, metadata, index)?;
}
}
// Process any unshredded fields (partial shredding)
if let Some(value) = value {
let Variant::Object(object) = value else {
return Err(ArrowError::InvalidArgumentError(
"Expected object in value field for partially shredded struct".to_string(),
));
};
for entry in object.iter_try() {
let (field_name, field_value) = entry?;
if self.field_unshredders.contains_key(field_name) {
return Err(ArrowError::InvalidArgumentError(format!(
"Field '{field_name}' appears in both typed_value and value",
)));
}
object_builder.insert_bytes(field_name, field_value);
}
}
object_builder.finish();
Ok(())
}
}
/// Builder for unshredding list/array types with recursive element processing
struct ListUnshredVariantBuilder<'a, L: ListLikeArray> {
value: Option<&'a ArrayRef>,
typed_value: &'a L,
element_unshredder: Box<UnshredVariantRowBuilder<'a>>,
}
impl<'a, L: ListLikeArray> ListUnshredVariantBuilder<'a, L> {
fn try_new(value: Option<&'a ArrayRef>, typed_value: &'a L) -> Result<Self> {
// Create a recursive unshredder for the list elements
// The element type comes from the values array of the list
let element_values = typed_value.values();
// For shredded lists, each element would be a ShreddedVariantFieldArray (struct)
// Extract value/typed_value from the element struct
let Some(element_values) = element_values.as_struct_opt() else {
return Err(ArrowError::InvalidArgumentError(format!(
"Invalid shredded variant array element: expected Struct, got {}",
element_values.data_type()
)));
};
// Create recursive unshredder for elements
//
// NOTE: A None/None array element is technically invalid, but the shredding spec
// requires us to emit `Variant::Null` when a required value is missing.
let element_unshredder = UnshredVariantRowBuilder::try_new_opt(element_values.try_into()?)?
.unwrap_or_else(|| UnshredVariantRowBuilder::null(None));
Ok(Self {
value,
typed_value,
element_unshredder: Box::new(element_unshredder),
})
}
fn append_row(
&mut self,
builder: &mut impl VariantBuilderExt,
metadata: &VariantMetadata,
index: usize,
) -> Result<()> {
handle_unshredded_case!(self, builder, metadata, index, false);
// If we get here, typed_value is valid and value is NULL -- process the list elements
let mut list_builder = builder.try_new_list()?;
for element_index in self.typed_value.element_range(index) {
self.element_unshredder
.append_row(&mut list_builder, metadata, element_index)?;
}
list_builder.finish();
Ok(())
}
}
#[cfg(test)]
mod tests {
use crate::VariantArray;
use arrow::array::{
ArrayRef, BinaryArray, BinaryViewArray, LargeBinaryArray, LargeStringArray, StringViewArray,
};
use parquet_variant::Variant;
use std::sync::Arc;
#[test]
fn test_unshred_utf8view_typed_value() {
let metadata_bytes: &[u8] = &[0x01, 0x00, 0x00];
let metadata: ArrayRef =
Arc::new(BinaryViewArray::from_iter_values(vec![metadata_bytes; 3]));
let typed_value: ArrayRef = Arc::new(StringViewArray::from(vec![
Some("hello"),
Some("middle"),
Some("world"),
]));
let variant_array = VariantArray::from_parts(metadata, None, Some(typed_value), None);
let result = crate::unshred_variant(&variant_array).unwrap();
assert_eq!(result.len(), 3);
assert_eq!(result.value(0), Variant::from("hello"));
assert_eq!(result.value(1), Variant::from("middle"));
assert_eq!(result.value(2), Variant::from("world"));
}
#[test]
fn test_unshred_largeutf8_typed_value() {
let metadata_bytes: &[u8] = &[0x01, 0x00, 0x00];
let metadata: ArrayRef =
Arc::new(BinaryViewArray::from_iter_values(vec![metadata_bytes; 3]));
let typed_value: ArrayRef = Arc::new(LargeStringArray::from(vec![
Some("hello"),
Some("middle"),
Some("world"),
]));
let variant_array = VariantArray::from_parts(metadata, None, Some(typed_value), None);
let result = crate::unshred_variant(&variant_array).unwrap();
assert_eq!(result.len(), 3);
assert_eq!(result.value(0), Variant::from("hello"));
assert_eq!(result.value(1), Variant::from("middle"));
assert_eq!(result.value(2), Variant::from("world"));
}
#[test]
fn test_unshred_binary_typed_value() {
let metadata_bytes: &[u8] = &[0x01, 0x00, 0x00];
let metadata: ArrayRef =
Arc::new(BinaryViewArray::from_iter_values(vec![metadata_bytes; 3]));
let typed_value: ArrayRef = Arc::new(BinaryArray::from_iter_values(vec![
&b"\x00\x01\x02"[..],
&b"\xff\xaa"[..],
&b"\xde\xad\xbe\xef"[..],
]));
let variant_array = VariantArray::from_parts(metadata, None, Some(typed_value), None);
let result = crate::unshred_variant(&variant_array).unwrap();
assert_eq!(result.len(), 3);
assert_eq!(result.value(0), Variant::from(&b"\x00\x01\x02"[..]));
assert_eq!(result.value(1), Variant::from(&b"\xff\xaa"[..]));
assert_eq!(result.value(2), Variant::from(&b"\xde\xad\xbe\xef"[..]));
}
#[test]
fn test_unshred_largebinary_typed_value() {
let metadata_bytes: &[u8] = &[0x01, 0x00, 0x00];
let metadata: ArrayRef =
Arc::new(BinaryViewArray::from_iter_values(vec![metadata_bytes; 3]));
let typed_value: ArrayRef = Arc::new(LargeBinaryArray::from_iter_values(vec![
&b"\x00\x01\x02"[..],
&b"\xff\xaa"[..],
&b"\xde\xad\xbe\xef"[..],
]));
let variant_array = VariantArray::from_parts(metadata, None, Some(typed_value), None);
let result = crate::unshred_variant(&variant_array).unwrap();
assert_eq!(result.len(), 3);
assert_eq!(result.value(0), Variant::from(&b"\x00\x01\x02"[..]));
assert_eq!(result.value(1), Variant::from(&b"\xff\xaa"[..]));
assert_eq!(result.value(2), Variant::from(&b"\xde\xad\xbe\xef"[..]));
}
#[test]
fn test_unshred_returns_err_on_malformed_metadata() {
// empty metadata bytes fail VariantMetadata's header parse. before this fix the
// call inside unshred_variant used the panicking `VariantMetadata::new`, which
// crashed the thread instead of surfacing the spec violation through the
// documented `Result` return type.
let metadata: ArrayRef = Arc::new(BinaryViewArray::from_iter_values(vec![&b""[..]]));
let typed_value: ArrayRef = Arc::new(StringViewArray::from(vec![Some("hello")]));
let variant_array = VariantArray::from_parts(metadata, None, Some(typed_value), None);
let result = crate::unshred_variant(&variant_array);
assert!(
result.is_err(),
"unshred_variant must return Err on malformed metadata, not panic",
);
}
}