1mod encoder;
108
109use std::{fmt::Debug, io::Write, sync::Arc};
110
111use crate::StructMode;
112use arrow_array::*;
113use arrow_schema::*;
114
115pub use encoder::{Encoder, EncoderFactory, EncoderOptions, NullableEncoder, make_encoder};
116
117pub trait JsonFormat: Debug + Default {
120 #[inline]
121 fn start_stream<W: Write>(&self, _writer: &mut W) -> Result<(), ArrowError> {
123 Ok(())
124 }
125
126 #[inline]
127 fn start_row<W: Write>(&self, _writer: &mut W, _is_first_row: bool) -> Result<(), ArrowError> {
129 Ok(())
130 }
131
132 #[inline]
133 fn end_row<W: Write>(&self, _writer: &mut W) -> Result<(), ArrowError> {
135 Ok(())
136 }
137
138 fn end_stream<W: Write>(&self, _writer: &mut W) -> Result<(), ArrowError> {
140 Ok(())
141 }
142}
143
144#[derive(Debug, Default)]
154pub struct LineDelimited {}
155
156impl JsonFormat for LineDelimited {
157 fn end_row<W: Write>(&self, writer: &mut W) -> Result<(), ArrowError> {
158 writer.write_all(b"\n")?;
159 Ok(())
160 }
161}
162
163#[derive(Debug, Default)]
171pub struct JsonArray {}
172
173impl JsonFormat for JsonArray {
174 fn start_stream<W: Write>(&self, writer: &mut W) -> Result<(), ArrowError> {
175 writer.write_all(b"[")?;
176 Ok(())
177 }
178
179 fn start_row<W: Write>(&self, writer: &mut W, is_first_row: bool) -> Result<(), ArrowError> {
180 if !is_first_row {
181 writer.write_all(b",")?;
182 }
183 Ok(())
184 }
185
186 fn end_stream<W: Write>(&self, writer: &mut W) -> Result<(), ArrowError> {
187 writer.write_all(b"]")?;
188 Ok(())
189 }
190}
191
192pub type LineDelimitedWriter<W> = Writer<W, LineDelimited>;
194
195pub type ArrayWriter<W> = Writer<W, JsonArray>;
197
198#[derive(Debug, Clone, Default)]
200pub struct WriterBuilder(EncoderOptions);
201
202impl WriterBuilder {
203 pub fn new() -> Self {
223 Self::default()
224 }
225
226 pub fn explicit_nulls(&self) -> bool {
228 self.0.explicit_nulls()
229 }
230
231 pub fn with_explicit_nulls(mut self, explicit_nulls: bool) -> Self {
254 self.0 = self.0.with_explicit_nulls(explicit_nulls);
255 self
256 }
257
258 pub fn struct_mode(&self) -> StructMode {
260 self.0.struct_mode()
261 }
262
263 pub fn with_struct_mode(mut self, struct_mode: StructMode) -> Self {
269 self.0 = self.0.with_struct_mode(struct_mode);
270 self
271 }
272
273 pub fn with_encoder_factory(mut self, factory: Arc<dyn EncoderFactory>) -> Self {
278 self.0 = self.0.with_encoder_factory(factory);
279 self
280 }
281
282 pub fn with_date_format(mut self, format: String) -> Self {
284 self.0 = self.0.with_date_format(format);
285 self
286 }
287
288 pub fn with_datetime_format(mut self, format: String) -> Self {
290 self.0 = self.0.with_datetime_format(format);
291 self
292 }
293
294 pub fn with_time_format(mut self, format: String) -> Self {
296 self.0 = self.0.with_time_format(format);
297 self
298 }
299
300 pub fn with_timestamp_format(mut self, format: String) -> Self {
302 self.0 = self.0.with_timestamp_format(format);
303 self
304 }
305
306 pub fn with_timestamp_tz_format(mut self, tz_format: String) -> Self {
308 self.0 = self.0.with_timestamp_tz_format(tz_format);
309 self
310 }
311
312 pub fn build<W, F>(self, writer: W) -> Writer<W, F>
314 where
315 W: Write,
316 F: JsonFormat,
317 {
318 Writer {
319 writer,
320 started: false,
321 finished: false,
322 format: F::default(),
323 options: self.0,
324 }
325 }
326}
327
328#[derive(Debug)]
339pub struct Writer<W, F>
340where
341 W: Write,
342 F: JsonFormat,
343{
344 writer: W,
346
347 started: bool,
349
350 finished: bool,
352
353 format: F,
355
356 options: EncoderOptions,
358}
359
360impl<W, F> Writer<W, F>
361where
362 W: Write,
363 F: JsonFormat,
364{
365 pub fn new(writer: W) -> Self {
367 Self {
368 writer,
369 started: false,
370 finished: false,
371 format: F::default(),
372 options: EncoderOptions::default(),
373 }
374 }
375
376 pub fn write(&mut self, batch: &RecordBatch) -> Result<(), ArrowError> {
378 if batch.num_rows() == 0 {
379 return Ok(());
380 }
381
382 let mut buffer = Vec::with_capacity(16 * 1024);
385
386 let mut is_first_row = !self.started;
387 if !self.started {
388 self.format.start_stream(&mut buffer)?;
389 self.started = true;
390 }
391
392 let array = StructArray::from(batch.clone());
393 let field = Arc::new(Field::new_struct(
394 "",
395 batch.schema().fields().clone(),
396 false,
397 ));
398
399 let mut encoder = make_encoder(&field, &array, &self.options)?;
400
401 assert!(!encoder.has_nulls(), "root cannot be nullable");
403 for idx in 0..batch.num_rows() {
404 self.format.start_row(&mut buffer, is_first_row)?;
405 is_first_row = false;
406
407 encoder.encode(idx, &mut buffer);
408 if buffer.len() > 8 * 1024 {
409 self.writer.write_all(&buffer)?;
410 buffer.clear();
411 }
412 self.format.end_row(&mut buffer)?;
413 }
414
415 if !buffer.is_empty() {
416 self.writer.write_all(&buffer)?;
417 }
418
419 Ok(())
420 }
421
422 pub fn write_batches(&mut self, batches: &[&RecordBatch]) -> Result<(), ArrowError> {
424 for b in batches {
425 self.write(b)?;
426 }
427 Ok(())
428 }
429
430 pub fn finish(&mut self) -> Result<(), ArrowError> {
434 if !self.started {
435 self.format.start_stream(&mut self.writer)?;
436 self.started = true;
437 }
438 if !self.finished {
439 self.format.end_stream(&mut self.writer)?;
440 self.finished = true;
441 }
442
443 Ok(())
444 }
445
446 pub fn get_ref(&self) -> &W {
448 &self.writer
449 }
450
451 pub fn get_mut(&mut self) -> &mut W {
456 &mut self.writer
457 }
458
459 pub fn into_inner(self) -> W {
461 self.writer
462 }
463}
464
465impl<W, F> RecordBatchWriter for Writer<W, F>
466where
467 W: Write,
468 F: JsonFormat,
469{
470 fn write(&mut self, batch: &RecordBatch) -> Result<(), ArrowError> {
471 self.write(batch)
472 }
473
474 fn close(mut self) -> Result<(), ArrowError> {
475 self.finish()
476 }
477}
478
479#[cfg(test)]
480mod tests {
481 use core::str;
482 use std::collections::HashMap;
483 use std::fs::{File, read_to_string};
484 use std::io::{BufReader, Seek};
485 use std::sync::Arc;
486
487 use arrow_array::cast::AsArray;
488 use serde_json::{Value, json};
489
490 use super::LineDelimited;
491 use super::{Encoder, WriterBuilder};
492 use arrow_array::builder::*;
493 use arrow_array::types::*;
494 use arrow_buffer::{Buffer, NullBuffer, OffsetBuffer, ScalarBuffer, ToByteSlice, i256};
495 use arrow_data::ArrayData;
496
497 use crate::reader::*;
498
499 use super::*;
500
501 fn assert_json_eq(input: &[u8], expected: &str) {
503 let expected: Vec<Option<Value>> = expected
504 .split('\n')
505 .map(|s| (!s.is_empty()).then(|| serde_json::from_str(s).unwrap()))
506 .collect();
507
508 let actual: Vec<Option<Value>> = input
509 .split(|b| *b == b'\n')
510 .map(|s| (!s.is_empty()).then(|| serde_json::from_slice(s).unwrap()))
511 .collect();
512
513 assert_eq!(actual, expected);
514 }
515
516 #[test]
517 fn write_simple_rows() {
518 let schema = Schema::new(vec![
519 Field::new("c1", DataType::Int32, true),
520 Field::new("c2", DataType::Utf8, true),
521 ]);
522
523 let a = Int32Array::from(vec![Some(1), Some(2), Some(3), None, Some(5)]);
524 let b = StringArray::from(vec![Some("a"), Some("b"), Some("c"), Some("d"), None]);
525
526 let batch = RecordBatch::try_new(Arc::new(schema), vec![Arc::new(a), Arc::new(b)]).unwrap();
527
528 let mut buf = Vec::new();
529 {
530 let mut writer = LineDelimitedWriter::new(&mut buf);
531 writer.write_batches(&[&batch]).unwrap();
532 }
533
534 assert_json_eq(
535 &buf,
536 r#"{"c1":1,"c2":"a"}
537{"c1":2,"c2":"b"}
538{"c1":3,"c2":"c"}
539{"c2":"d"}
540{"c1":5}
541"#,
542 );
543 }
544
545 #[test]
546 fn write_large_utf8_and_utf8_view() {
547 let schema = Schema::new(vec![
548 Field::new("c1", DataType::Utf8, true),
549 Field::new("c2", DataType::LargeUtf8, true),
550 Field::new("c3", DataType::Utf8View, true),
551 ]);
552
553 let a = StringArray::from(vec![Some("a"), None, Some("c"), Some("d"), None]);
554 let b = LargeStringArray::from(vec![Some("a"), Some("b"), None, Some("d"), None]);
555 let c = StringViewArray::from(vec![Some("a"), Some("b"), None, Some("d"), None]);
556
557 let batch = RecordBatch::try_new(
558 Arc::new(schema),
559 vec![Arc::new(a), Arc::new(b), Arc::new(c)],
560 )
561 .unwrap();
562
563 let mut buf = Vec::new();
564 {
565 let mut writer = LineDelimitedWriter::new(&mut buf);
566 writer.write_batches(&[&batch]).unwrap();
567 }
568
569 assert_json_eq(
570 &buf,
571 r#"{"c1":"a","c2":"a","c3":"a"}
572{"c2":"b","c3":"b"}
573{"c1":"c"}
574{"c1":"d","c2":"d","c3":"d"}
575{}
576"#,
577 );
578 }
579
580 #[test]
581 fn write_dictionary() {
582 let schema = Schema::new(vec![
583 Field::new_dictionary("c1", DataType::Int32, DataType::Utf8, true),
584 Field::new_dictionary("c2", DataType::Int8, DataType::Utf8, true),
585 ]);
586
587 let a: DictionaryArray<Int32Type> = vec![
588 Some("cupcakes"),
589 Some("foo"),
590 Some("foo"),
591 None,
592 Some("cupcakes"),
593 ]
594 .into_iter()
595 .collect();
596 let b: DictionaryArray<Int8Type> =
597 vec![Some("sdsd"), Some("sdsd"), None, Some("sd"), Some("sdsd")]
598 .into_iter()
599 .collect();
600
601 let batch = RecordBatch::try_new(Arc::new(schema), vec![Arc::new(a), Arc::new(b)]).unwrap();
602
603 let mut buf = Vec::new();
604 {
605 let mut writer = LineDelimitedWriter::new(&mut buf);
606 writer.write_batches(&[&batch]).unwrap();
607 }
608
609 assert_json_eq(
610 &buf,
611 r#"{"c1":"cupcakes","c2":"sdsd"}
612{"c1":"foo","c2":"sdsd"}
613{"c1":"foo"}
614{"c2":"sd"}
615{"c1":"cupcakes","c2":"sdsd"}
616"#,
617 );
618 }
619
620 #[test]
621 fn write_list_of_dictionary() {
622 let dict_field = Arc::new(Field::new_dictionary(
623 "item",
624 DataType::Int32,
625 DataType::Utf8,
626 true,
627 ));
628 let schema = Schema::new(vec![Field::new_large_list("l", dict_field.clone(), true)]);
629
630 let dict_array: DictionaryArray<Int32Type> =
631 vec![Some("a"), Some("b"), Some("c"), Some("a"), None, Some("c")]
632 .into_iter()
633 .collect();
634 let list_array = LargeListArray::try_new(
635 dict_field,
636 OffsetBuffer::from_lengths([3_usize, 2, 0, 1]),
637 Arc::new(dict_array),
638 Some(NullBuffer::from_iter([true, true, false, true])),
639 )
640 .unwrap();
641
642 let batch = RecordBatch::try_new(Arc::new(schema), vec![Arc::new(list_array)]).unwrap();
643
644 let mut buf = Vec::new();
645 {
646 let mut writer = LineDelimitedWriter::new(&mut buf);
647 writer.write_batches(&[&batch]).unwrap();
648 }
649
650 assert_json_eq(
651 &buf,
652 r#"{"l":["a","b","c"]}
653{"l":["a",null]}
654{}
655{"l":["c"]}
656"#,
657 );
658 }
659
660 #[test]
661 fn write_list_of_dictionary_large_values() {
662 let dict_field = Arc::new(Field::new_dictionary(
663 "item",
664 DataType::Int32,
665 DataType::LargeUtf8,
666 true,
667 ));
668 let schema = Schema::new(vec![Field::new_large_list("l", dict_field.clone(), true)]);
669
670 let keys = PrimitiveArray::<Int32Type>::from(vec![
671 Some(0),
672 Some(1),
673 Some(2),
674 Some(0),
675 None,
676 Some(2),
677 ]);
678 let values = LargeStringArray::from(vec!["a", "b", "c"]);
679 let dict_array = DictionaryArray::try_new(keys, Arc::new(values)).unwrap();
680
681 let list_array = LargeListArray::try_new(
682 dict_field,
683 OffsetBuffer::from_lengths([3_usize, 2, 0, 1]),
684 Arc::new(dict_array),
685 Some(NullBuffer::from_iter([true, true, false, true])),
686 )
687 .unwrap();
688
689 let batch = RecordBatch::try_new(Arc::new(schema), vec![Arc::new(list_array)]).unwrap();
690
691 let mut buf = Vec::new();
692 {
693 let mut writer = LineDelimitedWriter::new(&mut buf);
694 writer.write_batches(&[&batch]).unwrap();
695 }
696
697 assert_json_eq(
698 &buf,
699 r#"{"l":["a","b","c"]}
700{"l":["a",null]}
701{}
702{"l":["c"]}
703"#,
704 );
705 }
706
707 #[test]
708 fn write_timestamps() {
709 let ts_string = "2018-11-13T17:11:10.011375885995";
710 let ts_nanos = ts_string
711 .parse::<chrono::NaiveDateTime>()
712 .unwrap()
713 .and_utc()
714 .timestamp_nanos_opt()
715 .unwrap();
716 let ts_micros = ts_nanos / 1000;
717 let ts_millis = ts_micros / 1000;
718 let ts_secs = ts_millis / 1000;
719
720 let arr_nanos = TimestampNanosecondArray::from(vec![Some(ts_nanos), None]);
721 let arr_micros = TimestampMicrosecondArray::from(vec![Some(ts_micros), None]);
722 let arr_millis = TimestampMillisecondArray::from(vec![Some(ts_millis), None]);
723 let arr_secs = TimestampSecondArray::from(vec![Some(ts_secs), None]);
724 let arr_names = StringArray::from(vec![Some("a"), Some("b")]);
725
726 let schema = Schema::new(vec![
727 Field::new("nanos", arr_nanos.data_type().clone(), true),
728 Field::new("micros", arr_micros.data_type().clone(), true),
729 Field::new("millis", arr_millis.data_type().clone(), true),
730 Field::new("secs", arr_secs.data_type().clone(), true),
731 Field::new("name", arr_names.data_type().clone(), true),
732 ]);
733 let schema = Arc::new(schema);
734
735 let batch = RecordBatch::try_new(
736 schema,
737 vec![
738 Arc::new(arr_nanos),
739 Arc::new(arr_micros),
740 Arc::new(arr_millis),
741 Arc::new(arr_secs),
742 Arc::new(arr_names),
743 ],
744 )
745 .unwrap();
746
747 let mut buf = Vec::new();
748 {
749 let mut writer = LineDelimitedWriter::new(&mut buf);
750 writer.write_batches(&[&batch]).unwrap();
751 }
752
753 assert_json_eq(
754 &buf,
755 r#"{"micros":"2018-11-13T17:11:10.011375","millis":"2018-11-13T17:11:10.011","name":"a","nanos":"2018-11-13T17:11:10.011375885","secs":"2018-11-13T17:11:10"}
756{"name":"b"}
757"#,
758 );
759
760 let mut buf = Vec::new();
761 {
762 let mut writer = WriterBuilder::new()
763 .with_timestamp_format("%m-%d-%Y".to_string())
764 .build::<_, LineDelimited>(&mut buf);
765 writer.write_batches(&[&batch]).unwrap();
766 }
767
768 assert_json_eq(
769 &buf,
770 r#"{"nanos":"11-13-2018","micros":"11-13-2018","millis":"11-13-2018","secs":"11-13-2018","name":"a"}
771{"name":"b"}
772"#,
773 );
774 }
775
776 #[test]
777 fn write_timestamps_with_tz() {
778 let ts_string = "2018-11-13T17:11:10.011375885995";
779 let ts_nanos = ts_string
780 .parse::<chrono::NaiveDateTime>()
781 .unwrap()
782 .and_utc()
783 .timestamp_nanos_opt()
784 .unwrap();
785 let ts_micros = ts_nanos / 1000;
786 let ts_millis = ts_micros / 1000;
787 let ts_secs = ts_millis / 1000;
788
789 let arr_nanos = TimestampNanosecondArray::from(vec![Some(ts_nanos), None]);
790 let arr_micros = TimestampMicrosecondArray::from(vec![Some(ts_micros), None]);
791 let arr_millis = TimestampMillisecondArray::from(vec![Some(ts_millis), None]);
792 let arr_secs = TimestampSecondArray::from(vec![Some(ts_secs), None]);
793 let arr_names = StringArray::from(vec![Some("a"), Some("b")]);
794
795 let tz = "+00:00";
796
797 let arr_nanos = arr_nanos.with_timezone(tz);
798 let arr_micros = arr_micros.with_timezone(tz);
799 let arr_millis = arr_millis.with_timezone(tz);
800 let arr_secs = arr_secs.with_timezone(tz);
801
802 let schema = Schema::new(vec![
803 Field::new("nanos", arr_nanos.data_type().clone(), true),
804 Field::new("micros", arr_micros.data_type().clone(), true),
805 Field::new("millis", arr_millis.data_type().clone(), true),
806 Field::new("secs", arr_secs.data_type().clone(), true),
807 Field::new("name", arr_names.data_type().clone(), true),
808 ]);
809 let schema = Arc::new(schema);
810
811 let batch = RecordBatch::try_new(
812 schema,
813 vec![
814 Arc::new(arr_nanos),
815 Arc::new(arr_micros),
816 Arc::new(arr_millis),
817 Arc::new(arr_secs),
818 Arc::new(arr_names),
819 ],
820 )
821 .unwrap();
822
823 let mut buf = Vec::new();
824 {
825 let mut writer = LineDelimitedWriter::new(&mut buf);
826 writer.write_batches(&[&batch]).unwrap();
827 }
828
829 assert_json_eq(
830 &buf,
831 r#"{"micros":"2018-11-13T17:11:10.011375Z","millis":"2018-11-13T17:11:10.011Z","name":"a","nanos":"2018-11-13T17:11:10.011375885Z","secs":"2018-11-13T17:11:10Z"}
832{"name":"b"}
833"#,
834 );
835
836 let mut buf = Vec::new();
837 {
838 let mut writer = WriterBuilder::new()
839 .with_timestamp_tz_format("%m-%d-%Y %Z".to_string())
840 .build::<_, LineDelimited>(&mut buf);
841 writer.write_batches(&[&batch]).unwrap();
842 }
843
844 assert_json_eq(
845 &buf,
846 r#"{"nanos":"11-13-2018 +00:00","micros":"11-13-2018 +00:00","millis":"11-13-2018 +00:00","secs":"11-13-2018 +00:00","name":"a"}
847{"name":"b"}
848"#,
849 );
850 }
851
852 #[test]
853 fn write_dates() {
854 let ts_string = "2018-11-13T17:11:10.011375885995";
855 let ts_millis = ts_string
856 .parse::<chrono::NaiveDateTime>()
857 .unwrap()
858 .and_utc()
859 .timestamp_millis();
860
861 let arr_date32 = Date32Array::from(vec![
862 Some(i32::try_from(ts_millis / 1000 / (60 * 60 * 24)).unwrap()),
863 None,
864 ]);
865 let arr_date64 = Date64Array::from(vec![Some(ts_millis), None]);
866 let arr_names = StringArray::from(vec![Some("a"), Some("b")]);
867
868 let schema = Schema::new(vec![
869 Field::new("date32", arr_date32.data_type().clone(), true),
870 Field::new("date64", arr_date64.data_type().clone(), true),
871 Field::new("name", arr_names.data_type().clone(), false),
872 ]);
873 let schema = Arc::new(schema);
874
875 let batch = RecordBatch::try_new(
876 schema,
877 vec![
878 Arc::new(arr_date32),
879 Arc::new(arr_date64),
880 Arc::new(arr_names),
881 ],
882 )
883 .unwrap();
884
885 let mut buf = Vec::new();
886 {
887 let mut writer = LineDelimitedWriter::new(&mut buf);
888 writer.write_batches(&[&batch]).unwrap();
889 }
890
891 assert_json_eq(
892 &buf,
893 r#"{"date32":"2018-11-13","date64":"2018-11-13T17:11:10.011","name":"a"}
894{"name":"b"}
895"#,
896 );
897
898 let mut buf = Vec::new();
899 {
900 let mut writer = WriterBuilder::new()
901 .with_date_format("%m-%d-%Y".to_string())
902 .with_datetime_format("%m-%d-%Y %Mmin %Ssec %Hhour".to_string())
903 .build::<_, LineDelimited>(&mut buf);
904 writer.write_batches(&[&batch]).unwrap();
905 }
906
907 assert_json_eq(
908 &buf,
909 r#"{"date32":"11-13-2018","date64":"11-13-2018 11min 10sec 17hour","name":"a"}
910{"name":"b"}
911"#,
912 );
913 }
914
915 #[test]
916 fn write_times() {
917 let arr_time32sec = Time32SecondArray::from(vec![Some(120), None]);
918 let arr_time32msec = Time32MillisecondArray::from(vec![Some(120), None]);
919 let arr_time64usec = Time64MicrosecondArray::from(vec![Some(120), None]);
920 let arr_time64nsec = Time64NanosecondArray::from(vec![Some(120), None]);
921 let arr_names = StringArray::from(vec![Some("a"), Some("b")]);
922
923 let schema = Schema::new(vec![
924 Field::new("time32sec", arr_time32sec.data_type().clone(), true),
925 Field::new("time32msec", arr_time32msec.data_type().clone(), true),
926 Field::new("time64usec", arr_time64usec.data_type().clone(), true),
927 Field::new("time64nsec", arr_time64nsec.data_type().clone(), true),
928 Field::new("name", arr_names.data_type().clone(), true),
929 ]);
930 let schema = Arc::new(schema);
931
932 let batch = RecordBatch::try_new(
933 schema,
934 vec![
935 Arc::new(arr_time32sec),
936 Arc::new(arr_time32msec),
937 Arc::new(arr_time64usec),
938 Arc::new(arr_time64nsec),
939 Arc::new(arr_names),
940 ],
941 )
942 .unwrap();
943
944 let mut buf = Vec::new();
945 {
946 let mut writer = LineDelimitedWriter::new(&mut buf);
947 writer.write_batches(&[&batch]).unwrap();
948 }
949
950 assert_json_eq(
951 &buf,
952 r#"{"time32sec":"00:02:00","time32msec":"00:00:00.120","time64usec":"00:00:00.000120","time64nsec":"00:00:00.000000120","name":"a"}
953{"name":"b"}
954"#,
955 );
956
957 let mut buf = Vec::new();
958 {
959 let mut writer = WriterBuilder::new()
960 .with_time_format("%H-%M-%S %f".to_string())
961 .build::<_, LineDelimited>(&mut buf);
962 writer.write_batches(&[&batch]).unwrap();
963 }
964
965 assert_json_eq(
966 &buf,
967 r#"{"time32sec":"00-02-00 000000000","time32msec":"00-00-00 120000000","time64usec":"00-00-00 000120000","time64nsec":"00-00-00 000000120","name":"a"}
968{"name":"b"}
969"#,
970 );
971 }
972
973 #[test]
974 fn write_durations() {
975 let arr_durationsec = DurationSecondArray::from(vec![Some(120), None]);
976 let arr_durationmsec = DurationMillisecondArray::from(vec![Some(120), None]);
977 let arr_durationusec = DurationMicrosecondArray::from(vec![Some(120), None]);
978 let arr_durationnsec = DurationNanosecondArray::from(vec![Some(120), None]);
979 let arr_names = StringArray::from(vec![Some("a"), Some("b")]);
980
981 let schema = Schema::new(vec![
982 Field::new("duration_sec", arr_durationsec.data_type().clone(), true),
983 Field::new("duration_msec", arr_durationmsec.data_type().clone(), true),
984 Field::new("duration_usec", arr_durationusec.data_type().clone(), true),
985 Field::new("duration_nsec", arr_durationnsec.data_type().clone(), true),
986 Field::new("name", arr_names.data_type().clone(), true),
987 ]);
988 let schema = Arc::new(schema);
989
990 let batch = RecordBatch::try_new(
991 schema,
992 vec![
993 Arc::new(arr_durationsec),
994 Arc::new(arr_durationmsec),
995 Arc::new(arr_durationusec),
996 Arc::new(arr_durationnsec),
997 Arc::new(arr_names),
998 ],
999 )
1000 .unwrap();
1001
1002 let mut buf = Vec::new();
1003 {
1004 let mut writer = LineDelimitedWriter::new(&mut buf);
1005 writer.write_batches(&[&batch]).unwrap();
1006 }
1007
1008 assert_json_eq(
1009 &buf,
1010 r#"{"duration_sec":"PT120S","duration_msec":"PT0.12S","duration_usec":"PT0.00012S","duration_nsec":"PT0.00000012S","name":"a"}
1011{"name":"b"}
1012"#,
1013 );
1014 }
1015
1016 #[test]
1017 fn write_nested_structs() {
1018 let schema = Schema::new(vec![
1019 Field::new(
1020 "c1",
1021 DataType::Struct(Fields::from(vec![
1022 Field::new("c11", DataType::Int32, true),
1023 Field::new(
1024 "c12",
1025 DataType::Struct(vec![Field::new("c121", DataType::Utf8, false)].into()),
1026 false,
1027 ),
1028 ])),
1029 false,
1030 ),
1031 Field::new("c2", DataType::Utf8, false),
1032 ]);
1033
1034 let c1 = StructArray::from(vec![
1035 (
1036 Arc::new(Field::new("c11", DataType::Int32, true)),
1037 Arc::new(Int32Array::from(vec![Some(1), None, Some(5)])) as ArrayRef,
1038 ),
1039 (
1040 Arc::new(Field::new(
1041 "c12",
1042 DataType::Struct(vec![Field::new("c121", DataType::Utf8, false)].into()),
1043 false,
1044 )),
1045 Arc::new(StructArray::from(vec![(
1046 Arc::new(Field::new("c121", DataType::Utf8, false)),
1047 Arc::new(StringArray::from(vec![Some("e"), Some("f"), Some("g")])) as ArrayRef,
1048 )])) as ArrayRef,
1049 ),
1050 ]);
1051 let c2 = StringArray::from(vec![Some("a"), Some("b"), Some("c")]);
1052
1053 let batch =
1054 RecordBatch::try_new(Arc::new(schema), vec![Arc::new(c1), Arc::new(c2)]).unwrap();
1055
1056 let mut buf = Vec::new();
1057 {
1058 let mut writer = LineDelimitedWriter::new(&mut buf);
1059 writer.write_batches(&[&batch]).unwrap();
1060 }
1061
1062 assert_json_eq(
1063 &buf,
1064 r#"{"c1":{"c11":1,"c12":{"c121":"e"}},"c2":"a"}
1065{"c1":{"c12":{"c121":"f"}},"c2":"b"}
1066{"c1":{"c11":5,"c12":{"c121":"g"}},"c2":"c"}
1067"#,
1068 );
1069 }
1070
1071 #[test]
1072 fn write_struct_with_list_field() {
1073 let field_c1 = Field::new(
1074 "c1",
1075 DataType::List(Arc::new(Field::new("c_list", DataType::Utf8, false))),
1076 false,
1077 );
1078 let field_c2 = Field::new("c2", DataType::Int32, false);
1079 let schema = Schema::new(vec![field_c1.clone(), field_c2]);
1080
1081 let a_values = StringArray::from(vec!["a", "a1", "b", "c", "d", "e"]);
1082 let a_value_offsets = Buffer::from([0, 2, 3, 4, 5, 6].to_byte_slice());
1084 let a_list_data = ArrayData::builder(field_c1.data_type().clone())
1085 .len(5)
1086 .add_buffer(a_value_offsets)
1087 .add_child_data(a_values.into_data())
1088 .null_bit_buffer(Some(Buffer::from([0b00011111])))
1089 .build()
1090 .unwrap();
1091 let a = ListArray::from(a_list_data);
1092
1093 let b = Int32Array::from(vec![1, 2, 3, 4, 5]);
1094
1095 let batch = RecordBatch::try_new(Arc::new(schema), vec![Arc::new(a), Arc::new(b)]).unwrap();
1096
1097 let mut buf = Vec::new();
1098 {
1099 let mut writer = LineDelimitedWriter::new(&mut buf);
1100 writer.write_batches(&[&batch]).unwrap();
1101 }
1102
1103 assert_json_eq(
1104 &buf,
1105 r#"{"c1":["a","a1"],"c2":1}
1106{"c1":["b"],"c2":2}
1107{"c1":["c"],"c2":3}
1108{"c1":["d"],"c2":4}
1109{"c1":["e"],"c2":5}
1110"#,
1111 );
1112 }
1113
1114 #[test]
1115 fn write_nested_list() {
1116 let list_inner_type = Field::new(
1117 "a",
1118 DataType::List(Arc::new(Field::new("b", DataType::Int32, false))),
1119 false,
1120 );
1121 let field_c1 = Field::new(
1122 "c1",
1123 DataType::List(Arc::new(list_inner_type.clone())),
1124 false,
1125 );
1126 let field_c2 = Field::new("c2", DataType::Utf8, true);
1127 let schema = Schema::new(vec![field_c1.clone(), field_c2]);
1128
1129 let a_values = Int32Array::from(vec![1, 2, 3, 4, 5, 6]);
1131
1132 let a_value_offsets = Buffer::from([0, 2, 3, 6].to_byte_slice());
1133 let a_list_data = ArrayData::builder(list_inner_type.data_type().clone())
1135 .len(3)
1136 .add_buffer(a_value_offsets)
1137 .null_bit_buffer(Some(Buffer::from([0b00000111])))
1138 .add_child_data(a_values.into_data())
1139 .build()
1140 .unwrap();
1141
1142 let c1_value_offsets = Buffer::from([0, 2, 2, 3].to_byte_slice());
1143 let c1_list_data = ArrayData::builder(field_c1.data_type().clone())
1144 .len(3)
1145 .add_buffer(c1_value_offsets)
1146 .add_child_data(a_list_data)
1147 .build()
1148 .unwrap();
1149
1150 let c1 = ListArray::from(c1_list_data);
1151 let c2 = StringArray::from(vec![Some("foo"), Some("bar"), None]);
1152
1153 let batch =
1154 RecordBatch::try_new(Arc::new(schema), vec![Arc::new(c1), Arc::new(c2)]).unwrap();
1155
1156 let mut buf = Vec::new();
1157 {
1158 let mut writer = LineDelimitedWriter::new(&mut buf);
1159 writer.write_batches(&[&batch]).unwrap();
1160 }
1161
1162 assert_json_eq(
1163 &buf,
1164 r#"{"c1":[[1,2],[3]],"c2":"foo"}
1165{"c1":[],"c2":"bar"}
1166{"c1":[[4,5,6]]}
1167"#,
1168 );
1169 }
1170
1171 #[test]
1172 fn write_list_of_struct() {
1173 let field_c1 = Field::new(
1174 "c1",
1175 DataType::List(Arc::new(Field::new(
1176 "s",
1177 DataType::Struct(Fields::from(vec![
1178 Field::new("c11", DataType::Int32, true),
1179 Field::new(
1180 "c12",
1181 DataType::Struct(vec![Field::new("c121", DataType::Utf8, false)].into()),
1182 false,
1183 ),
1184 ])),
1185 false,
1186 ))),
1187 true,
1188 );
1189 let field_c2 = Field::new("c2", DataType::Int32, false);
1190 let schema = Schema::new(vec![field_c1.clone(), field_c2]);
1191
1192 let struct_values = StructArray::from(vec![
1193 (
1194 Arc::new(Field::new("c11", DataType::Int32, true)),
1195 Arc::new(Int32Array::from(vec![Some(1), None, Some(5)])) as ArrayRef,
1196 ),
1197 (
1198 Arc::new(Field::new(
1199 "c12",
1200 DataType::Struct(vec![Field::new("c121", DataType::Utf8, false)].into()),
1201 false,
1202 )),
1203 Arc::new(StructArray::from(vec![(
1204 Arc::new(Field::new("c121", DataType::Utf8, false)),
1205 Arc::new(StringArray::from(vec![Some("e"), Some("f"), Some("g")])) as ArrayRef,
1206 )])) as ArrayRef,
1207 ),
1208 ]);
1209
1210 let c1_value_offsets = Buffer::from([0, 2, 2, 3].to_byte_slice());
1215 let c1_list_data = ArrayData::builder(field_c1.data_type().clone())
1216 .len(3)
1217 .add_buffer(c1_value_offsets)
1218 .add_child_data(struct_values.into_data())
1219 .null_bit_buffer(Some(Buffer::from([0b00000101])))
1220 .build()
1221 .unwrap();
1222 let c1 = ListArray::from(c1_list_data);
1223
1224 let c2 = Int32Array::from(vec![1, 2, 3]);
1225
1226 let batch =
1227 RecordBatch::try_new(Arc::new(schema), vec![Arc::new(c1), Arc::new(c2)]).unwrap();
1228
1229 let mut buf = Vec::new();
1230 {
1231 let mut writer = LineDelimitedWriter::new(&mut buf);
1232 writer.write_batches(&[&batch]).unwrap();
1233 }
1234
1235 assert_json_eq(
1236 &buf,
1237 r#"{"c1":[{"c11":1,"c12":{"c121":"e"}},{"c12":{"c121":"f"}}],"c2":1}
1238{"c2":2}
1239{"c1":[{"c11":5,"c12":{"c121":"g"}}],"c2":3}
1240"#,
1241 );
1242 }
1243
1244 fn test_write_for_file(test_file: &str, remove_nulls: bool) {
1245 let file = File::open(test_file).unwrap();
1246 let mut reader = BufReader::new(file);
1247 let (schema, _) = infer_json_schema(&mut reader, None).unwrap();
1248 reader.rewind().unwrap();
1249
1250 let builder = ReaderBuilder::new(Arc::new(schema)).with_batch_size(1024);
1251 let mut reader = builder.build(reader).unwrap();
1252 let batch = reader.next().unwrap().unwrap();
1253
1254 let mut buf = Vec::new();
1255 {
1256 if remove_nulls {
1257 let mut writer = LineDelimitedWriter::new(&mut buf);
1258 writer.write_batches(&[&batch]).unwrap();
1259 } else {
1260 let mut writer = WriterBuilder::new()
1261 .with_explicit_nulls(true)
1262 .build::<_, LineDelimited>(&mut buf);
1263 writer.write_batches(&[&batch]).unwrap();
1264 }
1265 }
1266
1267 let result = str::from_utf8(&buf).unwrap();
1268 let expected = read_to_string(test_file).unwrap();
1269 for (r, e) in result.lines().zip(expected.lines()) {
1270 let mut expected_json = serde_json::from_str::<Value>(e).unwrap();
1271 if remove_nulls {
1272 if let Value::Object(obj) = expected_json {
1274 expected_json =
1275 Value::Object(obj.into_iter().filter(|(_, v)| *v != Value::Null).collect());
1276 }
1277 }
1278 assert_eq!(serde_json::from_str::<Value>(r).unwrap(), expected_json,);
1279 }
1280 }
1281
1282 #[test]
1283 fn write_basic_rows() {
1284 test_write_for_file("test/data/basic.json", true);
1285 }
1286
1287 #[test]
1288 fn write_arrays() {
1289 test_write_for_file("test/data/arrays.json", true);
1290 }
1291
1292 #[test]
1293 fn write_basic_nulls() {
1294 test_write_for_file("test/data/basic_nulls.json", true);
1295 }
1296
1297 #[test]
1298 fn write_nested_with_nulls() {
1299 test_write_for_file("test/data/nested_with_nulls.json", false);
1300 }
1301
1302 #[test]
1303 fn json_line_writer_empty() {
1304 let mut writer = LineDelimitedWriter::new(vec![] as Vec<u8>);
1305 writer.finish().unwrap();
1306 assert_eq!(str::from_utf8(&writer.into_inner()).unwrap(), "");
1307 }
1308
1309 #[test]
1310 fn json_array_writer_empty() {
1311 let mut writer = ArrayWriter::new(vec![] as Vec<u8>);
1312 writer.finish().unwrap();
1313 assert_eq!(str::from_utf8(&writer.into_inner()).unwrap(), "[]");
1314 }
1315
1316 #[test]
1317 fn json_line_writer_empty_batch() {
1318 let mut writer = LineDelimitedWriter::new(vec![] as Vec<u8>);
1319
1320 let array = Int32Array::from(Vec::<i32>::new());
1321 let schema = Schema::new(vec![Field::new("c", DataType::Int32, true)]);
1322 let batch = RecordBatch::try_new(Arc::new(schema), vec![Arc::new(array)]).unwrap();
1323
1324 writer.write(&batch).unwrap();
1325 writer.finish().unwrap();
1326 assert_eq!(str::from_utf8(&writer.into_inner()).unwrap(), "");
1327 }
1328
1329 #[test]
1330 fn json_array_writer_empty_batch() {
1331 let mut writer = ArrayWriter::new(vec![] as Vec<u8>);
1332
1333 let array = Int32Array::from(Vec::<i32>::new());
1334 let schema = Schema::new(vec![Field::new("c", DataType::Int32, true)]);
1335 let batch = RecordBatch::try_new(Arc::new(schema), vec![Arc::new(array)]).unwrap();
1336
1337 writer.write(&batch).unwrap();
1338 writer.finish().unwrap();
1339 assert_eq!(str::from_utf8(&writer.into_inner()).unwrap(), "[]");
1340 }
1341
1342 #[test]
1343 fn json_struct_array_nulls() {
1344 let inner = ListArray::from_iter_primitive::<Int32Type, _, _>(vec![
1345 Some(vec![Some(1), Some(2)]),
1346 Some(vec![None]),
1347 Some(vec![]),
1348 Some(vec![Some(3), None]), Some(vec![Some(4), Some(5)]),
1350 None, None,
1352 ]);
1353
1354 let field = Arc::new(Field::new("list", inner.data_type().clone(), true));
1355 let array = Arc::new(inner) as ArrayRef;
1356 let struct_array_a = StructArray::from((
1357 vec![(field.clone(), array.clone())],
1358 Buffer::from([0b01010111]),
1359 ));
1360 let struct_array_b = StructArray::from(vec![(field, array)]);
1361
1362 let schema = Schema::new(vec![
1363 Field::new_struct("a", struct_array_a.fields().clone(), true),
1364 Field::new_struct("b", struct_array_b.fields().clone(), true),
1365 ]);
1366
1367 let batch = RecordBatch::try_new(
1368 Arc::new(schema),
1369 vec![Arc::new(struct_array_a), Arc::new(struct_array_b)],
1370 )
1371 .unwrap();
1372
1373 let mut buf = Vec::new();
1374 {
1375 let mut writer = LineDelimitedWriter::new(&mut buf);
1376 writer.write_batches(&[&batch]).unwrap();
1377 }
1378
1379 assert_json_eq(
1380 &buf,
1381 r#"{"a":{"list":[1,2]},"b":{"list":[1,2]}}
1382{"a":{"list":[null]},"b":{"list":[null]}}
1383{"a":{"list":[]},"b":{"list":[]}}
1384{"b":{"list":[3,null]}}
1385{"a":{"list":[4,5]},"b":{"list":[4,5]}}
1386{"b":{}}
1387{"a":{},"b":{}}
1388"#,
1389 );
1390 }
1391
1392 #[test]
1393 fn json_writer_map() {
1394 let keys_array = super::StringArray::from(vec!["foo", "bar", "baz", "qux", "quux"]);
1395 let values_array = super::Int64Array::from(vec![10, 20, 30, 40, 50]);
1396
1397 let keys = Arc::new(Field::new("keys", DataType::Utf8, false));
1398 let values = Arc::new(Field::new("values", DataType::Int64, false));
1399 let entry_struct = StructArray::from(vec![
1400 (keys, Arc::new(keys_array) as ArrayRef),
1401 (values, Arc::new(values_array) as ArrayRef),
1402 ]);
1403
1404 let map_data_type = DataType::Map(
1405 Arc::new(Field::new(
1406 "entries",
1407 entry_struct.data_type().clone(),
1408 false,
1409 )),
1410 false,
1411 );
1412
1413 let entry_offsets = Buffer::from([0, 1, 1, 1, 4, 5, 5].to_byte_slice());
1415 let valid_buffer = Buffer::from([0b00111101]);
1416
1417 let map_data = ArrayData::builder(map_data_type.clone())
1418 .len(6)
1419 .null_bit_buffer(Some(valid_buffer))
1420 .add_buffer(entry_offsets)
1421 .add_child_data(entry_struct.into_data())
1422 .build()
1423 .unwrap();
1424
1425 let map = MapArray::from(map_data);
1426
1427 let map_field = Field::new("map", map_data_type, true);
1428 let schema = Arc::new(Schema::new(vec![map_field]));
1429
1430 let batch = RecordBatch::try_new(schema, vec![Arc::new(map)]).unwrap();
1431
1432 let mut buf = Vec::new();
1433 {
1434 let mut writer = LineDelimitedWriter::new(&mut buf);
1435 writer.write_batches(&[&batch]).unwrap();
1436 }
1437
1438 assert_json_eq(
1439 &buf,
1440 r#"{"map":{"foo":10}}
1441{}
1442{"map":{}}
1443{"map":{"bar":20,"baz":30,"qux":40}}
1444{"map":{"quux":50}}
1445{"map":{}}
1446"#,
1447 );
1448 }
1449
1450 #[test]
1451 fn test_write_single_batch() {
1452 let test_file = "test/data/basic.json";
1453 let file = File::open(test_file).unwrap();
1454 let mut reader = BufReader::new(file);
1455 let (schema, _) = infer_json_schema(&mut reader, None).unwrap();
1456 reader.rewind().unwrap();
1457
1458 let builder = ReaderBuilder::new(Arc::new(schema)).with_batch_size(1024);
1459 let mut reader = builder.build(reader).unwrap();
1460 let batch = reader.next().unwrap().unwrap();
1461
1462 let mut buf = Vec::new();
1463 {
1464 let mut writer = LineDelimitedWriter::new(&mut buf);
1465 writer.write(&batch).unwrap();
1466 }
1467
1468 let result = str::from_utf8(&buf).unwrap();
1469 let expected = read_to_string(test_file).unwrap();
1470 for (r, e) in result.lines().zip(expected.lines()) {
1471 let mut expected_json = serde_json::from_str::<Value>(e).unwrap();
1472 if let Value::Object(obj) = expected_json {
1474 expected_json =
1475 Value::Object(obj.into_iter().filter(|(_, v)| *v != Value::Null).collect());
1476 }
1477 assert_eq!(serde_json::from_str::<Value>(r).unwrap(), expected_json,);
1478 }
1479 }
1480
1481 #[test]
1482 fn test_write_multi_batches() {
1483 let test_file = "test/data/basic.json";
1484
1485 let schema = SchemaRef::new(Schema::new(vec![
1486 Field::new("a", DataType::Int64, true),
1487 Field::new("b", DataType::Float64, true),
1488 Field::new("c", DataType::Boolean, true),
1489 Field::new("d", DataType::Utf8, true),
1490 Field::new("e", DataType::Utf8, true),
1491 Field::new("f", DataType::Utf8, true),
1492 Field::new("g", DataType::Timestamp(TimeUnit::Millisecond, None), true),
1493 Field::new("h", DataType::Float16, true),
1494 ]));
1495
1496 let mut reader = ReaderBuilder::new(schema.clone())
1497 .build(BufReader::new(File::open(test_file).unwrap()))
1498 .unwrap();
1499 let batch = reader.next().unwrap().unwrap();
1500
1501 let batches = [&RecordBatch::new_empty(schema), &batch, &batch];
1503
1504 let mut buf = Vec::new();
1505 {
1506 let mut writer = LineDelimitedWriter::new(&mut buf);
1507 writer.write_batches(&batches).unwrap();
1508 }
1509
1510 let result = str::from_utf8(&buf).unwrap();
1511 let expected = read_to_string(test_file).unwrap();
1512 let expected = format!("{expected}\n{expected}");
1514 for (r, e) in result.lines().zip(expected.lines()) {
1515 let mut expected_json = serde_json::from_str::<Value>(e).unwrap();
1516 if let Value::Object(obj) = expected_json {
1518 expected_json =
1519 Value::Object(obj.into_iter().filter(|(_, v)| *v != Value::Null).collect());
1520 }
1521 assert_eq!(serde_json::from_str::<Value>(r).unwrap(), expected_json,);
1522 }
1523 }
1524
1525 #[test]
1526 fn test_writer_explicit_nulls() -> Result<(), ArrowError> {
1527 fn nested_list() -> (Arc<ListArray>, Arc<Field>) {
1528 let array = Arc::new(ListArray::from_iter_primitive::<Int32Type, _, _>(vec![
1529 Some(vec![None, None, None]),
1530 Some(vec![Some(1), Some(2), Some(3)]),
1531 None,
1532 Some(vec![None, None, None]),
1533 ]));
1534 let field = Arc::new(Field::new("list", array.data_type().clone(), true));
1535 (array, field)
1537 }
1538
1539 fn nested_dict() -> (Arc<DictionaryArray<Int32Type>>, Arc<Field>) {
1540 let array = Arc::new(DictionaryArray::from_iter(vec![
1541 Some("cupcakes"),
1542 None,
1543 Some("bear"),
1544 Some("kuma"),
1545 ]));
1546 let field = Arc::new(Field::new("dict", array.data_type().clone(), true));
1547 (array, field)
1549 }
1550
1551 fn nested_map() -> (Arc<MapArray>, Arc<Field>) {
1552 let string_builder = StringBuilder::new();
1553 let int_builder = Int64Builder::new();
1554 let mut builder = MapBuilder::new(None, string_builder, int_builder);
1555
1556 builder.keys().append_value("foo");
1558 builder.values().append_value(10);
1559 builder.append(true).unwrap();
1560
1561 builder.append(false).unwrap();
1562
1563 builder.append(true).unwrap();
1564
1565 builder.keys().append_value("bar");
1566 builder.values().append_value(20);
1567 builder.keys().append_value("baz");
1568 builder.values().append_value(30);
1569 builder.keys().append_value("qux");
1570 builder.values().append_value(40);
1571 builder.append(true).unwrap();
1572
1573 let array = Arc::new(builder.finish());
1574 let field = Arc::new(Field::new("map", array.data_type().clone(), true));
1575 (array, field)
1576 }
1577
1578 fn root_list() -> (Arc<ListArray>, Field) {
1579 let struct_array = StructArray::from(vec![
1580 (
1581 Arc::new(Field::new("utf8", DataType::Utf8, true)),
1582 Arc::new(StringArray::from(vec![Some("a"), Some("b"), None, None])) as ArrayRef,
1583 ),
1584 (
1585 Arc::new(Field::new("int32", DataType::Int32, true)),
1586 Arc::new(Int32Array::from(vec![Some(1), None, Some(5), None])) as ArrayRef,
1587 ),
1588 ]);
1589
1590 let field = Field::new_list(
1591 "list",
1592 Field::new("struct", struct_array.data_type().clone(), true),
1593 true,
1594 );
1595
1596 let entry_offsets = Buffer::from([0, 2, 2, 3, 3].to_byte_slice());
1598 let data = ArrayData::builder(field.data_type().clone())
1599 .len(4)
1600 .add_buffer(entry_offsets)
1601 .add_child_data(struct_array.into_data())
1602 .null_bit_buffer(Some([0b00000101].into()))
1603 .build()
1604 .unwrap();
1605 let array = Arc::new(ListArray::from(data));
1606 (array, field)
1607 }
1608
1609 let (nested_list_array, nested_list_field) = nested_list();
1610 let (nested_dict_array, nested_dict_field) = nested_dict();
1611 let (nested_map_array, nested_map_field) = nested_map();
1612 let (root_list_array, root_list_field) = root_list();
1613
1614 let schema = Schema::new(vec![
1615 Field::new("date", DataType::Date32, true),
1616 Field::new("null", DataType::Null, true),
1617 Field::new_struct(
1618 "struct",
1619 vec![
1620 Arc::new(Field::new("utf8", DataType::Utf8, true)),
1621 nested_list_field.clone(),
1622 nested_dict_field.clone(),
1623 nested_map_field.clone(),
1624 ],
1625 true,
1626 ),
1627 root_list_field,
1628 ]);
1629
1630 let arr_date32 = Date32Array::from(vec![Some(0), None, Some(1), None]);
1631 let arr_null = NullArray::new(4);
1632 let arr_struct = StructArray::from(vec![
1633 (
1635 Arc::new(Field::new("utf8", DataType::Utf8, true)),
1636 Arc::new(StringArray::from(vec![Some("a"), None, None, Some("b")])) as ArrayRef,
1637 ),
1638 (nested_list_field, nested_list_array as ArrayRef),
1640 (nested_dict_field, nested_dict_array as ArrayRef),
1642 (nested_map_field, nested_map_array as ArrayRef),
1644 ]);
1645
1646 let batch = RecordBatch::try_new(
1647 Arc::new(schema),
1648 vec![
1649 Arc::new(arr_date32),
1651 Arc::new(arr_null),
1653 Arc::new(arr_struct),
1654 root_list_array,
1656 ],
1657 )?;
1658
1659 let mut buf = Vec::new();
1660 {
1661 let mut writer = WriterBuilder::new()
1662 .with_explicit_nulls(true)
1663 .build::<_, JsonArray>(&mut buf);
1664 writer.write_batches(&[&batch])?;
1665 writer.finish()?;
1666 }
1667
1668 let actual = serde_json::from_slice::<Vec<Value>>(&buf).unwrap();
1669 let expected = serde_json::from_value::<Vec<Value>>(json!([
1670 {
1671 "date": "1970-01-01",
1672 "list": [
1673 {
1674 "int32": 1,
1675 "utf8": "a"
1676 },
1677 {
1678 "int32": null,
1679 "utf8": "b"
1680 }
1681 ],
1682 "null": null,
1683 "struct": {
1684 "dict": "cupcakes",
1685 "list": [
1686 null,
1687 null,
1688 null
1689 ],
1690 "map": {
1691 "foo": 10
1692 },
1693 "utf8": "a"
1694 }
1695 },
1696 {
1697 "date": null,
1698 "list": null,
1699 "null": null,
1700 "struct": {
1701 "dict": null,
1702 "list": [
1703 1,
1704 2,
1705 3
1706 ],
1707 "map": null,
1708 "utf8": null
1709 }
1710 },
1711 {
1712 "date": "1970-01-02",
1713 "list": [
1714 {
1715 "int32": 5,
1716 "utf8": null
1717 }
1718 ],
1719 "null": null,
1720 "struct": {
1721 "dict": "bear",
1722 "list": null,
1723 "map": {},
1724 "utf8": null
1725 }
1726 },
1727 {
1728 "date": null,
1729 "list": null,
1730 "null": null,
1731 "struct": {
1732 "dict": "kuma",
1733 "list": [
1734 null,
1735 null,
1736 null
1737 ],
1738 "map": {
1739 "bar": 20,
1740 "baz": 30,
1741 "qux": 40
1742 },
1743 "utf8": "b"
1744 }
1745 }
1746 ]))
1747 .unwrap();
1748
1749 assert_eq!(actual, expected);
1750
1751 Ok(())
1752 }
1753
1754 fn binary_encoding_test<O: OffsetSizeTrait>() {
1755 let schema = SchemaRef::new(Schema::new(vec![Field::new(
1757 "bytes",
1758 GenericBinaryType::<O>::DATA_TYPE,
1759 true,
1760 )]));
1761
1762 let mut builder = GenericByteBuilder::<GenericBinaryType<O>>::new();
1764 let values = [Some(b"Ned Flanders"), None, Some(b"Troy McClure")];
1765 for value in values {
1766 match value {
1767 Some(v) => builder.append_value(v),
1768 None => builder.append_null(),
1769 }
1770 }
1771 let array = Arc::new(builder.finish()) as ArrayRef;
1772 let batch = RecordBatch::try_new(schema, vec![array]).unwrap();
1773
1774 {
1776 let mut buf = Vec::new();
1777 let json_value: Value = {
1778 let mut writer = WriterBuilder::new()
1779 .with_explicit_nulls(true)
1780 .build::<_, JsonArray>(&mut buf);
1781 writer.write(&batch).unwrap();
1782 writer.close().unwrap();
1783 serde_json::from_slice(&buf).unwrap()
1784 };
1785
1786 assert_eq!(
1787 json!([
1788 {
1789 "bytes": "4e656420466c616e64657273"
1790 },
1791 {
1792 "bytes": null },
1794 {
1795 "bytes": "54726f79204d63436c757265"
1796 }
1797 ]),
1798 json_value,
1799 );
1800 }
1801
1802 {
1804 let mut buf = Vec::new();
1805 let json_value: Value = {
1806 let mut writer = ArrayWriter::new(&mut buf);
1809 writer.write(&batch).unwrap();
1810 writer.close().unwrap();
1811 serde_json::from_slice(&buf).unwrap()
1812 };
1813
1814 assert_eq!(
1815 json!([
1816 {
1817 "bytes": "4e656420466c616e64657273"
1818 },
1819 {}, {
1821 "bytes": "54726f79204d63436c757265"
1822 }
1823 ]),
1824 json_value
1825 );
1826 }
1827 }
1828
1829 #[test]
1830 fn test_writer_binary() {
1831 binary_encoding_test::<i32>();
1833 binary_encoding_test::<i64>();
1835 }
1836
1837 #[test]
1838 fn test_writer_fixed_size_binary() {
1839 let size = 11;
1841 let schema = SchemaRef::new(Schema::new(vec![Field::new(
1842 "bytes",
1843 DataType::FixedSizeBinary(size),
1844 true,
1845 )]));
1846
1847 let mut builder = FixedSizeBinaryBuilder::new(size);
1849 let values = [Some(b"hello world"), None, Some(b"summer rain")];
1850 for value in values {
1851 match value {
1852 Some(v) => builder.append_value(v).unwrap(),
1853 None => builder.append_null(),
1854 }
1855 }
1856 let array = Arc::new(builder.finish()) as ArrayRef;
1857 let batch = RecordBatch::try_new(schema, vec![array]).unwrap();
1858
1859 {
1861 let mut buf = Vec::new();
1862 let json_value: Value = {
1863 let mut writer = WriterBuilder::new()
1864 .with_explicit_nulls(true)
1865 .build::<_, JsonArray>(&mut buf);
1866 writer.write(&batch).unwrap();
1867 writer.close().unwrap();
1868 serde_json::from_slice(&buf).unwrap()
1869 };
1870
1871 assert_eq!(
1872 json!([
1873 {
1874 "bytes": "68656c6c6f20776f726c64"
1875 },
1876 {
1877 "bytes": null },
1879 {
1880 "bytes": "73756d6d6572207261696e"
1881 }
1882 ]),
1883 json_value,
1884 );
1885 }
1886 {
1888 let mut buf = Vec::new();
1889 let json_value: Value = {
1890 let mut writer = ArrayWriter::new(&mut buf);
1893 writer.write(&batch).unwrap();
1894 writer.close().unwrap();
1895 serde_json::from_slice(&buf).unwrap()
1896 };
1897
1898 assert_eq!(
1899 json!([
1900 {
1901 "bytes": "68656c6c6f20776f726c64"
1902 },
1903 {}, {
1905 "bytes": "73756d6d6572207261696e"
1906 }
1907 ]),
1908 json_value,
1909 );
1910 }
1911 }
1912
1913 #[test]
1914 fn test_writer_fixed_size_list() {
1915 let size = 3;
1916 let field = FieldRef::new(Field::new_list_field(DataType::Int32, true));
1917 let schema = SchemaRef::new(Schema::new(vec![Field::new(
1918 "list",
1919 DataType::FixedSizeList(field, size),
1920 true,
1921 )]));
1922
1923 let values_builder = Int32Builder::new();
1924 let mut list_builder = FixedSizeListBuilder::new(values_builder, size);
1925 let lists = [
1926 Some([Some(1), Some(2), None]),
1927 Some([Some(3), None, Some(4)]),
1928 Some([None, Some(5), Some(6)]),
1929 None,
1930 ];
1931 for list in lists {
1932 match list {
1933 Some(l) => {
1934 for value in l {
1935 match value {
1936 Some(v) => list_builder.values().append_value(v),
1937 None => list_builder.values().append_null(),
1938 }
1939 }
1940 list_builder.append(true);
1941 }
1942 None => {
1943 for _ in 0..size {
1944 list_builder.values().append_null();
1945 }
1946 list_builder.append(false);
1947 }
1948 }
1949 }
1950 let array = Arc::new(list_builder.finish()) as ArrayRef;
1951 let batch = RecordBatch::try_new(schema, vec![array]).unwrap();
1952
1953 {
1955 let json_value: Value = {
1956 let mut buf = Vec::new();
1957 let mut writer = WriterBuilder::new()
1958 .with_explicit_nulls(true)
1959 .build::<_, JsonArray>(&mut buf);
1960 writer.write(&batch).unwrap();
1961 writer.close().unwrap();
1962 serde_json::from_slice(&buf).unwrap()
1963 };
1964 assert_eq!(
1965 json!([
1966 {"list": [1, 2, null]},
1967 {"list": [3, null, 4]},
1968 {"list": [null, 5, 6]},
1969 {"list": null},
1970 ]),
1971 json_value
1972 );
1973 }
1974 {
1976 let json_value: Value = {
1977 let mut buf = Vec::new();
1978 let mut writer = ArrayWriter::new(&mut buf);
1979 writer.write(&batch).unwrap();
1980 writer.close().unwrap();
1981 serde_json::from_slice(&buf).unwrap()
1982 };
1983 assert_eq!(
1984 json!([
1985 {"list": [1, 2, null]},
1986 {"list": [3, null, 4]},
1987 {"list": [null, 5, 6]},
1988 {}, ]),
1990 json_value
1991 );
1992 }
1993 }
1994
1995 #[test]
1996 fn test_writer_null_dict() {
1997 let keys = Int32Array::from_iter(vec![Some(0), None, Some(1)]);
1998 let values = Arc::new(StringArray::from_iter(vec![Some("a"), None]));
1999 let dict = DictionaryArray::new(keys, values);
2000
2001 let schema = SchemaRef::new(Schema::new(vec![Field::new(
2002 "my_dict",
2003 DataType::Dictionary(DataType::Int32.into(), DataType::Utf8.into()),
2004 true,
2005 )]));
2006
2007 let array = Arc::new(dict) as ArrayRef;
2008 let batch = RecordBatch::try_new(schema, vec![array]).unwrap();
2009
2010 let mut json = Vec::new();
2011 let write_builder = WriterBuilder::new().with_explicit_nulls(true);
2012 let mut writer = write_builder.build::<_, JsonArray>(&mut json);
2013 writer.write(&batch).unwrap();
2014 writer.close().unwrap();
2015
2016 let json_str = str::from_utf8(&json).unwrap();
2017 assert_eq!(
2018 json_str,
2019 r#"[{"my_dict":"a"},{"my_dict":null},{"my_dict":""}]"#
2020 )
2021 }
2022
2023 #[test]
2024 fn test_decimal32_encoder() {
2025 let array = Decimal32Array::from_iter_values([1234, 5678, 9012])
2026 .with_precision_and_scale(8, 2)
2027 .unwrap();
2028 let field = Arc::new(Field::new("decimal", array.data_type().clone(), true));
2029 let schema = Schema::new(vec![field]);
2030 let batch = RecordBatch::try_new(Arc::new(schema), vec![Arc::new(array)]).unwrap();
2031
2032 let mut buf = Vec::new();
2033 {
2034 let mut writer = LineDelimitedWriter::new(&mut buf);
2035 writer.write_batches(&[&batch]).unwrap();
2036 }
2037
2038 assert_json_eq(
2039 &buf,
2040 r#"{"decimal":12.34}
2041{"decimal":56.78}
2042{"decimal":90.12}
2043"#,
2044 );
2045 }
2046
2047 #[test]
2048 fn test_decimal64_encoder() {
2049 let array = Decimal64Array::from_iter_values([1234, 5678, 9012])
2050 .with_precision_and_scale(10, 2)
2051 .unwrap();
2052 let field = Arc::new(Field::new("decimal", array.data_type().clone(), true));
2053 let schema = Schema::new(vec![field]);
2054 let batch = RecordBatch::try_new(Arc::new(schema), vec![Arc::new(array)]).unwrap();
2055
2056 let mut buf = Vec::new();
2057 {
2058 let mut writer = LineDelimitedWriter::new(&mut buf);
2059 writer.write_batches(&[&batch]).unwrap();
2060 }
2061
2062 assert_json_eq(
2063 &buf,
2064 r#"{"decimal":12.34}
2065{"decimal":56.78}
2066{"decimal":90.12}
2067"#,
2068 );
2069 }
2070
2071 #[test]
2072 fn test_decimal128_encoder() {
2073 let array = Decimal128Array::from_iter_values([1234, 5678, 9012])
2074 .with_precision_and_scale(10, 2)
2075 .unwrap();
2076 let field = Arc::new(Field::new("decimal", array.data_type().clone(), true));
2077 let schema = Schema::new(vec![field]);
2078 let batch = RecordBatch::try_new(Arc::new(schema), vec![Arc::new(array)]).unwrap();
2079
2080 let mut buf = Vec::new();
2081 {
2082 let mut writer = LineDelimitedWriter::new(&mut buf);
2083 writer.write_batches(&[&batch]).unwrap();
2084 }
2085
2086 assert_json_eq(
2087 &buf,
2088 r#"{"decimal":12.34}
2089{"decimal":56.78}
2090{"decimal":90.12}
2091"#,
2092 );
2093 }
2094
2095 #[test]
2096 fn test_decimal256_encoder() {
2097 let array = Decimal256Array::from_iter_values([
2098 i256::from(123400),
2099 i256::from(567800),
2100 i256::from(901200),
2101 ])
2102 .with_precision_and_scale(10, 4)
2103 .unwrap();
2104 let field = Arc::new(Field::new("decimal", array.data_type().clone(), true));
2105 let schema = Schema::new(vec![field]);
2106 let batch = RecordBatch::try_new(Arc::new(schema), vec![Arc::new(array)]).unwrap();
2107
2108 let mut buf = Vec::new();
2109 {
2110 let mut writer = LineDelimitedWriter::new(&mut buf);
2111 writer.write_batches(&[&batch]).unwrap();
2112 }
2113
2114 assert_json_eq(
2115 &buf,
2116 r#"{"decimal":12.3400}
2117{"decimal":56.7800}
2118{"decimal":90.1200}
2119"#,
2120 );
2121 }
2122
2123 #[test]
2124 fn test_decimal_encoder_with_nulls() {
2125 let array = Decimal128Array::from_iter([Some(1234), None, Some(5678)])
2126 .with_precision_and_scale(10, 2)
2127 .unwrap();
2128 let field = Arc::new(Field::new("decimal", array.data_type().clone(), true));
2129 let schema = Schema::new(vec![field]);
2130 let batch = RecordBatch::try_new(Arc::new(schema), vec![Arc::new(array)]).unwrap();
2131
2132 let mut buf = Vec::new();
2133 {
2134 let mut writer = LineDelimitedWriter::new(&mut buf);
2135 writer.write_batches(&[&batch]).unwrap();
2136 }
2137
2138 assert_json_eq(
2139 &buf,
2140 r#"{"decimal":12.34}
2141{}
2142{"decimal":56.78}
2143"#,
2144 );
2145 }
2146
2147 #[test]
2148 fn write_structs_as_list() {
2149 let schema = Schema::new(vec![
2150 Field::new(
2151 "c1",
2152 DataType::Struct(Fields::from(vec![
2153 Field::new("c11", DataType::Int32, true),
2154 Field::new(
2155 "c12",
2156 DataType::Struct(vec![Field::new("c121", DataType::Utf8, false)].into()),
2157 false,
2158 ),
2159 ])),
2160 false,
2161 ),
2162 Field::new("c2", DataType::Utf8, false),
2163 ]);
2164
2165 let c1 = StructArray::from(vec![
2166 (
2167 Arc::new(Field::new("c11", DataType::Int32, true)),
2168 Arc::new(Int32Array::from(vec![Some(1), None, Some(5)])) as ArrayRef,
2169 ),
2170 (
2171 Arc::new(Field::new(
2172 "c12",
2173 DataType::Struct(vec![Field::new("c121", DataType::Utf8, false)].into()),
2174 false,
2175 )),
2176 Arc::new(StructArray::from(vec![(
2177 Arc::new(Field::new("c121", DataType::Utf8, false)),
2178 Arc::new(StringArray::from(vec![Some("e"), Some("f"), Some("g")])) as ArrayRef,
2179 )])) as ArrayRef,
2180 ),
2181 ]);
2182 let c2 = StringArray::from(vec![Some("a"), Some("b"), Some("c")]);
2183
2184 let batch =
2185 RecordBatch::try_new(Arc::new(schema), vec![Arc::new(c1), Arc::new(c2)]).unwrap();
2186
2187 let expected = r#"[[1,["e"]],"a"]
2188[[null,["f"]],"b"]
2189[[5,["g"]],"c"]
2190"#;
2191
2192 let mut buf = Vec::new();
2193 {
2194 let builder = WriterBuilder::new()
2195 .with_explicit_nulls(true)
2196 .with_struct_mode(StructMode::ListOnly);
2197 let mut writer = builder.build::<_, LineDelimited>(&mut buf);
2198 writer.write_batches(&[&batch]).unwrap();
2199 }
2200 assert_json_eq(&buf, expected);
2201
2202 let mut buf = Vec::new();
2203 {
2204 let builder = WriterBuilder::new()
2205 .with_explicit_nulls(false)
2206 .with_struct_mode(StructMode::ListOnly);
2207 let mut writer = builder.build::<_, LineDelimited>(&mut buf);
2208 writer.write_batches(&[&batch]).unwrap();
2209 }
2210 assert_json_eq(&buf, expected);
2211 }
2212
2213 fn make_fallback_encoder_test_data() -> (RecordBatch, Arc<dyn EncoderFactory>) {
2214 #[derive(Debug)]
2217 enum UnionValue {
2218 Int32(i32),
2219 String(String),
2220 }
2221
2222 #[derive(Debug)]
2223 struct UnionEncoder {
2224 array: Vec<Option<UnionValue>>,
2225 }
2226
2227 impl Encoder for UnionEncoder {
2228 fn encode(&mut self, idx: usize, out: &mut Vec<u8>) {
2229 match &self.array[idx] {
2230 None => out.extend_from_slice(b"null"),
2231 Some(UnionValue::Int32(v)) => out.extend_from_slice(v.to_string().as_bytes()),
2232 Some(UnionValue::String(v)) => {
2233 out.extend_from_slice(format!("\"{v}\"").as_bytes())
2234 }
2235 }
2236 }
2237 }
2238
2239 #[derive(Debug)]
2240 struct UnionEncoderFactory;
2241
2242 impl EncoderFactory for UnionEncoderFactory {
2243 fn make_default_encoder<'a>(
2244 &self,
2245 _field: &'a FieldRef,
2246 array: &'a dyn Array,
2247 _options: &'a EncoderOptions,
2248 ) -> Result<Option<NullableEncoder<'a>>, ArrowError> {
2249 let data_type = array.data_type();
2250 let fields = match data_type {
2251 DataType::Union(fields, UnionMode::Sparse) => fields,
2252 _ => return Ok(None),
2253 };
2254 let fields = fields.iter().map(|(_, f)| f).collect::<Vec<_>>();
2256 for f in fields.iter() {
2257 match f.data_type() {
2258 DataType::Null => {}
2259 DataType::Int32 => {}
2260 DataType::Utf8 => {}
2261 _ => return Ok(None),
2262 }
2263 }
2264 let (_, type_ids, _, buffers) = array.as_union().clone().into_parts();
2265 let mut values = Vec::with_capacity(type_ids.len());
2266 for idx in 0..type_ids.len() {
2267 let type_id = type_ids[idx];
2268 let field = &fields[type_id as usize];
2269 let value = match field.data_type() {
2270 DataType::Null => None,
2271 DataType::Int32 => Some(UnionValue::Int32(
2272 buffers[type_id as usize]
2273 .as_primitive::<Int32Type>()
2274 .value(idx),
2275 )),
2276 DataType::Utf8 => Some(UnionValue::String(
2277 buffers[type_id as usize]
2278 .as_string::<i32>()
2279 .value(idx)
2280 .to_string(),
2281 )),
2282 _ => unreachable!(),
2283 };
2284 values.push(value);
2285 }
2286 let array_encoder =
2287 Box::new(UnionEncoder { array: values }) as Box<dyn Encoder + 'a>;
2288 let nulls = array.nulls().cloned();
2289 Ok(Some(NullableEncoder::new(array_encoder, nulls)))
2290 }
2291 }
2292
2293 let int_array = Int32Array::from(vec![Some(1), None, None]);
2294 let string_array = StringArray::from(vec![None, Some("a"), None]);
2295 let null_array = NullArray::new(3);
2296 let type_ids = [0_i8, 1, 2].into_iter().collect::<ScalarBuffer<i8>>();
2297
2298 let union_fields = [
2299 (0, Arc::new(Field::new("A", DataType::Int32, false))),
2300 (1, Arc::new(Field::new("B", DataType::Utf8, false))),
2301 (2, Arc::new(Field::new("C", DataType::Null, false))),
2302 ]
2303 .into_iter()
2304 .collect::<UnionFields>();
2305
2306 let children = vec![
2307 Arc::new(int_array) as Arc<dyn Array>,
2308 Arc::new(string_array),
2309 Arc::new(null_array),
2310 ];
2311
2312 let array = UnionArray::try_new(union_fields.clone(), type_ids, None, children).unwrap();
2313
2314 let float_array = Float64Array::from(vec![Some(1.0), None, Some(3.4)]);
2315
2316 let fields = vec![
2317 Field::new(
2318 "union",
2319 DataType::Union(union_fields, UnionMode::Sparse),
2320 true,
2321 ),
2322 Field::new("float", DataType::Float64, true),
2323 ];
2324
2325 let batch = RecordBatch::try_new(
2326 Arc::new(Schema::new(fields)),
2327 vec![
2328 Arc::new(array) as Arc<dyn Array>,
2329 Arc::new(float_array) as Arc<dyn Array>,
2330 ],
2331 )
2332 .unwrap();
2333
2334 (batch, Arc::new(UnionEncoderFactory))
2335 }
2336
2337 #[test]
2338 fn test_fallback_encoder_factory_line_delimited_implicit_nulls() {
2339 let (batch, encoder_factory) = make_fallback_encoder_test_data();
2340
2341 let mut buf = Vec::new();
2342 {
2343 let mut writer = WriterBuilder::new()
2344 .with_encoder_factory(encoder_factory)
2345 .with_explicit_nulls(false)
2346 .build::<_, LineDelimited>(&mut buf);
2347 writer.write_batches(&[&batch]).unwrap();
2348 writer.finish().unwrap();
2349 }
2350
2351 println!("{}", str::from_utf8(&buf).unwrap());
2352
2353 assert_json_eq(
2354 &buf,
2355 r#"{"union":1,"float":1.0}
2356{"union":"a"}
2357{"union":null,"float":3.4}
2358"#,
2359 );
2360 }
2361
2362 #[test]
2363 fn test_fallback_encoder_factory_line_delimited_explicit_nulls() {
2364 let (batch, encoder_factory) = make_fallback_encoder_test_data();
2365
2366 let mut buf = Vec::new();
2367 {
2368 let mut writer = WriterBuilder::new()
2369 .with_encoder_factory(encoder_factory)
2370 .with_explicit_nulls(true)
2371 .build::<_, LineDelimited>(&mut buf);
2372 writer.write_batches(&[&batch]).unwrap();
2373 writer.finish().unwrap();
2374 }
2375
2376 assert_json_eq(
2377 &buf,
2378 r#"{"union":1,"float":1.0}
2379{"union":"a","float":null}
2380{"union":null,"float":3.4}
2381"#,
2382 );
2383 }
2384
2385 #[test]
2386 fn test_fallback_encoder_factory_array_implicit_nulls() {
2387 let (batch, encoder_factory) = make_fallback_encoder_test_data();
2388
2389 let json_value: Value = {
2390 let mut buf = Vec::new();
2391 let mut writer = WriterBuilder::new()
2392 .with_encoder_factory(encoder_factory)
2393 .build::<_, JsonArray>(&mut buf);
2394 writer.write_batches(&[&batch]).unwrap();
2395 writer.finish().unwrap();
2396 serde_json::from_slice(&buf).unwrap()
2397 };
2398
2399 let expected = json!([
2400 {"union":1,"float":1.0},
2401 {"union":"a"},
2402 {"float":3.4,"union":null},
2403 ]);
2404
2405 assert_eq!(json_value, expected);
2406 }
2407
2408 #[test]
2409 fn test_fallback_encoder_factory_array_explicit_nulls() {
2410 let (batch, encoder_factory) = make_fallback_encoder_test_data();
2411
2412 let json_value: Value = {
2413 let mut buf = Vec::new();
2414 let mut writer = WriterBuilder::new()
2415 .with_encoder_factory(encoder_factory)
2416 .with_explicit_nulls(true)
2417 .build::<_, JsonArray>(&mut buf);
2418 writer.write_batches(&[&batch]).unwrap();
2419 writer.finish().unwrap();
2420 serde_json::from_slice(&buf).unwrap()
2421 };
2422
2423 let expected = json!([
2424 {"union":1,"float":1.0},
2425 {"union":"a", "float": null},
2426 {"union":null,"float":3.4},
2427 ]);
2428
2429 assert_eq!(json_value, expected);
2430 }
2431
2432 #[test]
2433 fn test_default_encoder_byte_array() {
2434 struct IntArrayBinaryEncoder<B> {
2435 array: B,
2436 }
2437
2438 impl<'a, B> Encoder for IntArrayBinaryEncoder<B>
2439 where
2440 B: ArrayAccessor<Item = &'a [u8]>,
2441 {
2442 fn encode(&mut self, idx: usize, out: &mut Vec<u8>) {
2443 out.push(b'[');
2444 let child = self.array.value(idx);
2445 for (idx, byte) in child.iter().enumerate() {
2446 write!(out, "{byte}").unwrap();
2447 if idx < child.len() - 1 {
2448 out.push(b',');
2449 }
2450 }
2451 out.push(b']');
2452 }
2453 }
2454
2455 #[derive(Debug)]
2456 struct IntArayBinaryEncoderFactory;
2457
2458 impl EncoderFactory for IntArayBinaryEncoderFactory {
2459 fn make_default_encoder<'a>(
2460 &self,
2461 _field: &'a FieldRef,
2462 array: &'a dyn Array,
2463 _options: &'a EncoderOptions,
2464 ) -> Result<Option<NullableEncoder<'a>>, ArrowError> {
2465 match array.data_type() {
2466 DataType::Binary => {
2467 let array = array.as_binary::<i32>();
2468 let encoder = IntArrayBinaryEncoder { array };
2469 let array_encoder = Box::new(encoder) as Box<dyn Encoder + 'a>;
2470 let nulls = array.nulls().cloned();
2471 Ok(Some(NullableEncoder::new(array_encoder, nulls)))
2472 }
2473 _ => Ok(None),
2474 }
2475 }
2476 }
2477
2478 let binary_array = BinaryArray::from_opt_vec(vec![Some(b"a"), None, Some(b"b")]);
2479 let float_array = Float64Array::from(vec![Some(1.0), Some(2.3), None]);
2480 let fields = vec![
2481 Field::new("bytes", DataType::Binary, true),
2482 Field::new("float", DataType::Float64, true),
2483 ];
2484 let batch = RecordBatch::try_new(
2485 Arc::new(Schema::new(fields)),
2486 vec![
2487 Arc::new(binary_array) as Arc<dyn Array>,
2488 Arc::new(float_array) as Arc<dyn Array>,
2489 ],
2490 )
2491 .unwrap();
2492
2493 let json_value: Value = {
2494 let mut buf = Vec::new();
2495 let mut writer = WriterBuilder::new()
2496 .with_encoder_factory(Arc::new(IntArayBinaryEncoderFactory))
2497 .build::<_, JsonArray>(&mut buf);
2498 writer.write_batches(&[&batch]).unwrap();
2499 writer.finish().unwrap();
2500 serde_json::from_slice(&buf).unwrap()
2501 };
2502
2503 let expected = json!([
2504 {"bytes": [97], "float": 1.0},
2505 {"float": 2.3},
2506 {"bytes": [98]},
2507 ]);
2508
2509 assert_eq!(json_value, expected);
2510 }
2511
2512 #[test]
2513 fn test_encoder_factory_customize_dictionary() {
2514 struct PaddedInt32Encoder {
2519 array: Int32Array,
2520 }
2521
2522 impl Encoder for PaddedInt32Encoder {
2523 fn encode(&mut self, idx: usize, out: &mut Vec<u8>) {
2524 let value = self.array.value(idx);
2525 write!(out, "\"{value:0>8}\"").unwrap();
2526 }
2527 }
2528
2529 #[derive(Debug)]
2530 struct CustomEncoderFactory;
2531
2532 impl EncoderFactory for CustomEncoderFactory {
2533 fn make_default_encoder<'a>(
2534 &self,
2535 field: &'a FieldRef,
2536 array: &'a dyn Array,
2537 _options: &'a EncoderOptions,
2538 ) -> Result<Option<NullableEncoder<'a>>, ArrowError> {
2539 let padded = field
2544 .metadata()
2545 .get("padded")
2546 .map(|v| v == "true")
2547 .unwrap_or_default();
2548 match (array.data_type(), padded) {
2549 (DataType::Int32, true) => {
2550 let array = array.as_primitive::<Int32Type>();
2551 let nulls = array.nulls().cloned();
2552 let encoder = PaddedInt32Encoder {
2553 array: array.clone(),
2554 };
2555 let array_encoder = Box::new(encoder) as Box<dyn Encoder + 'a>;
2556 Ok(Some(NullableEncoder::new(array_encoder, nulls)))
2557 }
2558 _ => Ok(None),
2559 }
2560 }
2561 }
2562
2563 let to_json = |batch| {
2564 let mut buf = Vec::new();
2565 let mut writer = WriterBuilder::new()
2566 .with_encoder_factory(Arc::new(CustomEncoderFactory))
2567 .build::<_, JsonArray>(&mut buf);
2568 writer.write_batches(&[batch]).unwrap();
2569 writer.finish().unwrap();
2570 serde_json::from_slice::<Value>(&buf).unwrap()
2571 };
2572
2573 let array = Int32Array::from(vec![Some(1), None, Some(2)]);
2575 let field = Arc::new(Field::new("int", DataType::Int32, true).with_metadata(
2576 HashMap::from_iter(vec![("padded".to_string(), "true".to_string())]),
2577 ));
2578 let batch = RecordBatch::try_new(
2579 Arc::new(Schema::new(vec![field.clone()])),
2580 vec![Arc::new(array)],
2581 )
2582 .unwrap();
2583
2584 let json_value = to_json(&batch);
2585
2586 let expected = json!([
2587 {"int": "00000001"},
2588 {},
2589 {"int": "00000002"},
2590 ]);
2591
2592 assert_eq!(json_value, expected);
2593
2594 let mut array_builder = PrimitiveDictionaryBuilder::<UInt16Type, Int32Type>::new();
2596 array_builder.append_value(1);
2597 array_builder.append_null();
2598 array_builder.append_value(1);
2599 let array = array_builder.finish();
2600 let field = Field::new(
2601 "int",
2602 DataType::Dictionary(Box::new(DataType::UInt16), Box::new(DataType::Int32)),
2603 true,
2604 )
2605 .with_metadata(HashMap::from_iter(vec![(
2606 "padded".to_string(),
2607 "true".to_string(),
2608 )]));
2609 let batch = RecordBatch::try_new(Arc::new(Schema::new(vec![field])), vec![Arc::new(array)])
2610 .unwrap();
2611
2612 let json_value = to_json(&batch);
2613
2614 let expected = json!([
2615 {"int": "00000001"},
2616 {},
2617 {"int": "00000001"},
2618 ]);
2619
2620 assert_eq!(json_value, expected);
2621 }
2622}