Skip to content

fix(manifest): write null instead of empty list/map for unset optional DataFile fields #934

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.

Sign up for GitHub

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

Open
Angelia-Wang wants to merge 1 commit into
base: main
Choose a base branch
from
+117 −0
Open

fix(manifest): write null instead of empty list/map for unset optional DataFile fields #934

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 12 additions & 0 deletions src/iceberg/arrow_row_builder.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,9 @@ Status AppendBytes(ArrowArray* array, std::span<const uint8_t> value) {
}

Status AppendIntList(ArrowArray* array, const std::vector<int32_t>& values) {
if (values.empty()) {
return AppendNull(array);
}
auto list_array = array->children[0];
for (const auto& value : values) {
ICEBERG_NANOARROW_RETURN_UNEXPECTED(
Expand All @@ -146,6 +149,9 @@ Status AppendIntList(ArrowArray* array, const std::vector<int32_t>& values) {
}

Status AppendIntList(ArrowArray* array, const std::vector<int64_t>& values) {
if (values.empty()) {
return AppendNull(array);
}
auto list_array = array->children[0];
for (const auto& value : values) {
ICEBERG_NANOARROW_RETURN_UNEXPECTED(ArrowArrayAppendInt(list_array, value));
Expand Down Expand Up @@ -174,6 +180,9 @@ Status AppendStringMap(ArrowArray* array,
}

Status AppendIntMap(ArrowArray* array, const std::map<int32_t, int64_t>& entries) {
if (entries.empty()) {
return AppendNull(array);
}
auto map_array = array->children[0];
if (map_array->n_children != 2) {
return InvalidArrowData("Map array must have exactly 2 children.");
Expand All @@ -191,6 +200,9 @@ Status AppendIntMap(ArrowArray* array, const std::map<int32_t, int64_t>& entries

Status AppendBinaryMap(ArrowArray* array,
const std::map<int32_t, std::vector<uint8_t>>& entries) {
if (entries.empty()) {
return AppendNull(array);
}
auto map_array = array->children[0];
if (map_array->n_children != 2) {
return InvalidArrowData("Map array must have exactly 2 children.");
Expand Down
105 changes: 105 additions & 0 deletions src/iceberg/test/arrow_row_builder_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,29 @@ std::shared_ptr<Schema> MakeTestSchema() {
SchemaField::MakeRequired(7, "value", string())))});
}

/// \brief A schema exercising the list/map append helpers backing Iceberg's
/// optional DataFile fields (e.g. equality_ids, split_offsets, column_sizes,
/// lower_bounds): list<int32>, list<int64>, map<int32, int64>, and
/// map<int32, binary>.
std::shared_ptr<Schema> MakeListMapTestSchema() {
return std::make_shared<Schema>(std::vector<SchemaField>{
SchemaField::MakeOptional(1, "int32_list",
list(SchemaField::MakeRequired(
2, std::string(ListType::kElementName), int32()))),
SchemaField::MakeOptional(3, "int64_list",
list(SchemaField::MakeRequired(
4, std::string(ListType::kElementName), int64()))),
SchemaField::MakeOptional(
5, "int_map",
map(SchemaField::MakeRequired(6, std::string(MapType::kKeyName), int32()),
SchemaField::MakeRequired(7, std::string(MapType::kValueName), int64()))),
SchemaField::MakeOptional(
8, "binary_map",
map(SchemaField::MakeRequired(9, std::string(MapType::kKeyName), int32()),
SchemaField::MakeRequired(10, std::string(MapType::kValueName),
binary())))});
}

/// \brief Finish a builder and import the result into an Arrow RecordBatch.
std::shared_ptr<::arrow::RecordBatch> FinishAndImport(ArrowRowBuilder builder,
const Schema& schema) {
Expand Down Expand Up @@ -178,4 +201,86 @@ TEST(ArrowRowBuilderTest, ColumnIndexOutOfRangeReturnsNull) {
EXPECT_EQ(builder.column(5), nullptr);
}

TEST(ArrowRowBuilderTest, AppendIntListWritesNullForEmptyInput) {
auto schema = MakeListMapTestSchema();
ICEBERG_UNWRAP_OR_FAIL(auto builder, ArrowRowBuilder::Make(*schema));

// Row 0: non-empty lists.
ASSERT_THAT(AppendIntList(builder.column(0), std::vector<int32_t>{1, 2}), IsOk());
ASSERT_THAT(AppendIntList(builder.column(1), std::vector<int64_t>{3, 4}), IsOk());
ASSERT_THAT(AppendNull(builder.column(2)), IsOk());
ASSERT_THAT(AppendNull(builder.column(3)), IsOk());
ASSERT_THAT(builder.FinishRow(), IsOk());

// Row 1: empty lists must be encoded as null, not an empty list.
ASSERT_THAT(AppendIntList(builder.column(0), std::vector<int32_t>{}), IsOk());
ASSERT_THAT(AppendIntList(builder.column(1), std::vector<int64_t>{}), IsOk());
ASSERT_THAT(AppendNull(builder.column(2)), IsOk());
ASSERT_THAT(AppendNull(builder.column(3)), IsOk());
ASSERT_THAT(builder.FinishRow(), IsOk());

auto batch = FinishAndImport(std::move(builder), *schema);
ASSERT_EQ(batch->num_rows(), 2);

auto int32_list = std::static_pointer_cast<::arrow::ListArray>(batch->column(0));
EXPECT_FALSE(int32_list->IsNull(0));
EXPECT_TRUE(int32_list->IsNull(1));

auto int64_list = std::static_pointer_cast<::arrow::ListArray>(batch->column(1));
EXPECT_FALSE(int64_list->IsNull(0));
EXPECT_TRUE(int64_list->IsNull(1));
}

TEST(ArrowRowBuilderTest, AppendIntMapWritesNullForEmptyInput) {
auto schema = MakeListMapTestSchema();
ICEBERG_UNWRAP_OR_FAIL(auto builder, ArrowRowBuilder::Make(*schema));

// Row 0: a non-empty map.
ASSERT_THAT(AppendNull(builder.column(0)), IsOk());
ASSERT_THAT(AppendNull(builder.column(1)), IsOk());
ASSERT_THAT(AppendIntMap(builder.column(2), {{1, 100}}), IsOk());
ASSERT_THAT(AppendNull(builder.column(3)), IsOk());
ASSERT_THAT(builder.FinishRow(), IsOk());

// Row 1: an empty map must be encoded as null, not an empty map.
ASSERT_THAT(AppendNull(builder.column(0)), IsOk());
ASSERT_THAT(AppendNull(builder.column(1)), IsOk());
ASSERT_THAT(AppendIntMap(builder.column(2), {}), IsOk());
ASSERT_THAT(AppendNull(builder.column(3)), IsOk());
ASSERT_THAT(builder.FinishRow(), IsOk());

auto batch = FinishAndImport(std::move(builder), *schema);
ASSERT_EQ(batch->num_rows(), 2);

auto int_map = std::static_pointer_cast<::arrow::MapArray>(batch->column(2));
EXPECT_FALSE(int_map->IsNull(0));
EXPECT_TRUE(int_map->IsNull(1));
}

TEST(ArrowRowBuilderTest, AppendBinaryMapWritesNullForEmptyInput) {
auto schema = MakeListMapTestSchema();
ICEBERG_UNWRAP_OR_FAIL(auto builder, ArrowRowBuilder::Make(*schema));

// Row 0: a non-empty map.
ASSERT_THAT(AppendNull(builder.column(0)), IsOk());
ASSERT_THAT(AppendNull(builder.column(1)), IsOk());
ASSERT_THAT(AppendNull(builder.column(2)), IsOk());
ASSERT_THAT(AppendBinaryMap(builder.column(3), {{1, {0x01, 0x02}}}), IsOk());
ASSERT_THAT(builder.FinishRow(), IsOk());

// Row 1: an empty map must be encoded as null, not an empty map.
ASSERT_THAT(AppendNull(builder.column(0)), IsOk());
ASSERT_THAT(AppendNull(builder.column(1)), IsOk());
ASSERT_THAT(AppendNull(builder.column(2)), IsOk());
ASSERT_THAT(AppendBinaryMap(builder.column(3), {}), IsOk());
ASSERT_THAT(builder.FinishRow(), IsOk());

auto batch = FinishAndImport(std::move(builder), *schema);
ASSERT_EQ(batch->num_rows(), 2);

auto binary_map = std::static_pointer_cast<::arrow::MapArray>(batch->column(3));
EXPECT_FALSE(binary_map->IsNull(0));
EXPECT_TRUE(binary_map->IsNull(1));
}

} // namespace iceberg
Loading