Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add JSON writer benchmarks (#5314) #5317

Merged
merged 5 commits into from
Jan 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions arrow/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,11 @@ name = "json_reader"
harness = false
required-features = ["test_utils", "json"]

[[bench]]
name = "json_writer"
harness = false
required-features = ["test_utils", "json"]

[[bench]]
name = "equal"
harness = false
Expand Down
198 changes: 198 additions & 0 deletions arrow/benches/json_writer.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,198 @@
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

use criterion::*;

use arrow::datatypes::*;
use arrow::util::bench_util::{
create_primitive_array, create_string_array, create_string_array_with_len,
create_string_dict_array,
};
use arrow::util::test_util::seedable_rng;
use arrow_array::{Array, ListArray, RecordBatch, StructArray};
use arrow_buffer::{BooleanBuffer, NullBuffer, OffsetBuffer};
use arrow_json::LineDelimitedWriter;
use rand::Rng;
use std::sync::Arc;

const NUM_ROWS: usize = 65536;

fn do_bench(c: &mut Criterion, name: &str, batch: &RecordBatch) {
c.bench_function(name, |b| {
b.iter(|| {
let mut out = Vec::with_capacity(1024);
LineDelimitedWriter::new(&mut out).write(batch).unwrap();
out
})
});
}

fn create_mixed(len: usize) -> RecordBatch {
let c1 = Arc::new(create_string_array::<i32>(len, 0.));
let c2 = Arc::new(create_primitive_array::<Int32Type>(len, 0.));
let c3 = Arc::new(create_primitive_array::<UInt32Type>(len, 0.));
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe we should also include a 64 bit type (like U64IntType rather than U32IntType)?

let c4 = Arc::new(create_string_array_with_len::<i32>(len, 0.2, 10));
let c5 = Arc::new(create_string_array_with_len::<i32>(len, 0.2, 20));
let c6 = Arc::new(create_primitive_array::<Float32Type>(len, 0.2));
RecordBatch::try_from_iter([
("c1", c1 as _),
("c2", c2 as _),
("c3", c3 as _),
("c4", c4 as _),
("c5", c5 as _),
("c6", c6 as _),
])
.unwrap()
}

fn create_nulls(len: usize) -> NullBuffer {
let mut rng = seedable_rng();
BooleanBuffer::from_iter((0..len).map(|_| rng.gen_bool(0.2))).into()
}

fn create_offsets(len: usize) -> (usize, OffsetBuffer<i32>) {
let mut rng = seedable_rng();
let mut last_offset = 0;
let mut offsets = Vec::with_capacity(len + 1);
offsets.push(0);
for _ in 0..len {
let len = rng.gen_range(0..10);
offsets.push(last_offset + len);
last_offset += len;
}
(
*offsets.last().unwrap() as _,
OffsetBuffer::new(offsets.into()),
)
}

fn create_nullable_struct(len: usize) -> StructArray {
let c2 = StructArray::from(create_mixed(len));
StructArray::new(
c2.fields().clone(),
c2.columns().to_vec(),
Some(create_nulls(c2.len())),
)
}

fn bench_float(c: &mut Criterion) {
let c1 = Arc::new(create_primitive_array::<Float32Type>(NUM_ROWS, 0.));
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

any reason to lump them together or would it make more sense to have a separate one for ints and flots?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Habit, this is a good shout as float formatting is much more complex for JSON

let c2 = Arc::new(create_primitive_array::<Float64Type>(NUM_ROWS, 0.));

let batch = RecordBatch::try_from_iter([("c1", c1 as _), ("c2", c2 as _)]).unwrap();

do_bench(c, "bench_float", &batch)
}

fn bench_integer(c: &mut Criterion) {
let c1 = Arc::new(create_primitive_array::<UInt64Type>(NUM_ROWS, 0.));
let c2 = Arc::new(create_primitive_array::<Int32Type>(NUM_ROWS, 0.));
let c3 = Arc::new(create_primitive_array::<UInt32Type>(NUM_ROWS, 0.));

let batch =
RecordBatch::try_from_iter([("c1", c1 as _), ("c2", c2 as _), ("c3", c3 as _)]).unwrap();

do_bench(c, "bench_integer", &batch)
}

fn bench_mixed(c: &mut Criterion) {
let batch = create_mixed(NUM_ROWS);
do_bench(c, "bench_mixed", &batch)
}

fn bench_dict_array(c: &mut Criterion) {
let c1 = Arc::new(create_string_dict_array::<Int32Type>(NUM_ROWS, 0., 30));
let c2 = Arc::new(create_string_dict_array::<Int32Type>(NUM_ROWS, 0., 20));
let c3 = Arc::new(create_string_dict_array::<Int32Type>(NUM_ROWS, 0.1, 20));

let batch =
RecordBatch::try_from_iter([("c1", c1 as _), ("c2", c2 as _), ("c3", c3 as _)]).unwrap();

do_bench(c, "bench_dict_array", &batch)
}

fn bench_string(c: &mut Criterion) {
let c1 = Arc::new(create_string_array::<i32>(NUM_ROWS, 0.));
let c2 = Arc::new(create_string_array_with_len::<i32>(NUM_ROWS, 0., 10));
let c3 = Arc::new(create_string_array_with_len::<i32>(NUM_ROWS, 0.1, 20));

let batch =
RecordBatch::try_from_iter([("c1", c1 as _), ("c2", c2 as _), ("c3", c3 as _)]).unwrap();

do_bench(c, "bench_dict_array", &batch)
}

fn bench_struct(c: &mut Criterion) {
let c1 = Arc::new(create_string_array::<i32>(NUM_ROWS, 0.));
let c2 = Arc::new(StructArray::from(create_mixed(NUM_ROWS)));
let batch = RecordBatch::try_from_iter([("c1", c1 as _), ("c2", c2 as _)]).unwrap();

do_bench(c, "bench_struct", &batch)
}

fn bench_nullable_struct(c: &mut Criterion) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💯 for including structs

Though again here I wonder if it is important to also have a string array or if we should just have a single struct array column)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wanted to have more than one column at the struct level, to break branch prediction

let c1 = Arc::new(create_string_array::<i32>(NUM_ROWS, 0.));
let c2 = Arc::new(create_nullable_struct(NUM_ROWS));
let batch = RecordBatch::try_from_iter([("c1", c1 as _), ("c2", c2 as _)]).unwrap();

do_bench(c, "bench_nullable_struct", &batch)
}

fn bench_list(c: &mut Criterion) {
let (values_len, offsets) = create_offsets(NUM_ROWS);
let c1_values = Arc::new(create_string_array::<i32>(values_len, 0.));
let c1_field = Arc::new(Field::new_list_field(c1_values.data_type().clone(), false));
let c1 = Arc::new(ListArray::new(c1_field, offsets, c1_values, None));
let batch = RecordBatch::try_from_iter([("c1", c1 as _)]).unwrap();
do_bench(c, "bench_list", &batch)
}

fn bench_nullable_list(c: &mut Criterion) {
let (values_len, offsets) = create_offsets(NUM_ROWS);
let c1_values = Arc::new(create_string_array::<i32>(values_len, 0.1));
let c1_field = Arc::new(Field::new_list_field(c1_values.data_type().clone(), true));
let c1_nulls = create_nulls(NUM_ROWS);
let c1 = Arc::new(ListArray::new(c1_field, offsets, c1_values, Some(c1_nulls)));
let batch = RecordBatch::try_from_iter([("c1", c1 as _)]).unwrap();
do_bench(c, "bench_nullable_list", &batch)
}

fn bench_struct_list(c: &mut Criterion) {
let (values_len, offsets) = create_offsets(NUM_ROWS);
let c1_values = Arc::new(create_nullable_struct(values_len));
let c1_field = Arc::new(Field::new_list_field(c1_values.data_type().clone(), true));
let c1_nulls = create_nulls(NUM_ROWS);
let c1 = Arc::new(ListArray::new(c1_field, offsets, c1_values, Some(c1_nulls)));
let batch = RecordBatch::try_from_iter([("c1", c1 as _)]).unwrap();
do_bench(c, "bench_struct_list", &batch)
}

fn criterion_benchmark(c: &mut Criterion) {
bench_integer(c);
bench_float(c);
bench_string(c);
bench_mixed(c);
bench_dict_array(c);
bench_struct(c);
bench_nullable_struct(c);
bench_list(c);
bench_nullable_list(c);
bench_struct_list(c);
}

criterion_group!(benches, criterion_benchmark);
criterion_main!(benches);
Loading