pitrou commented on code in PR #13901: URL: https://github.com/apache/arrow/pull/13901#discussion_r1733142900
########## cpp/src/arrow/extension/json.h: ########## @@ -0,0 +1,65 @@ +// 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. + +#pragma once + +#include <string> + +#include "arrow/extension_type.h" +#include "arrow/result.h" +#include "arrow/type_fwd.h" +#include "arrow/util/logging.h" Review Comment: `logging.h` should normally not be included in public headers. ########## cpp/src/arrow/extension/json.h: ########## @@ -0,0 +1,65 @@ +// 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. + +#pragma once + +#include <string> + +#include "arrow/extension_type.h" +#include "arrow/result.h" +#include "arrow/type_fwd.h" +#include "arrow/util/logging.h" +#include "arrow/util/visibility.h" + +namespace arrow::extension { + +/// \brief Concrete type class for variable-size JSON data, utf8-encoded. +class ARROW_EXPORT JsonExtensionType : public ExtensionType { + public: + explicit JsonExtensionType(const std::shared_ptr<DataType>& storage_type) + : ExtensionType(storage_type), storage_type_(storage_type) { + ARROW_CHECK(storage_type->Equals(utf8()) || storage_type->Equals(large_utf8()) || Review Comment: Can instead use a more light-weight id check (`storage_type->id() == Type::STRING`). ########## cpp/src/arrow/extension/json_test.cc: ########## @@ -0,0 +1,57 @@ +// 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. + +#include "arrow/extension/json.h" + +#include "arrow/ipc/test_common.h" +#include "arrow/record_batch.h" +#include "arrow/testing/gtest_util.h" + +namespace arrow { + +using arrow::ipc::test::RoundtripBatch; +using extension::json; + +class TestJsonExtensionType : public ::testing::Test {}; + +std::shared_ptr<Array> ExampleJson(const std::shared_ptr<DataType>& storage_type) { + std::shared_ptr<Array> arr = ArrayFromJSON(storage_type, R"([ + "null", + "1234", + "3.14159", + "true", + "false", + "\"a json string\"", + "[\"a\", \"json\", \"array\"]", + "{\"obj\": \"a simple json object\"}" + ])"); + return ExtensionType::WrapArray(arrow::extension::json(storage_type), arr); +} + +TEST_F(TestJsonExtensionType, JsonRoundtrip) { + for (const auto& storage_type : {utf8(), large_utf8(), utf8_view()}) { + auto ext_arr = ExampleJson(storage_type); + + auto batch = + RecordBatch::Make(schema({field("f0", json(storage_type))}), 8, {ext_arr}); + std::shared_ptr<RecordBatch> read_batch; + RoundtripBatch(batch, &read_batch); + CompareBatch(*batch, *read_batch, false /* compare_metadata */); Review Comment: Why leave `compare_metadata` to `false`? ########## cpp/src/parquet/properties.h: ########## @@ -941,6 +942,15 @@ class PARQUET_EXPORT ArrowReaderProperties { return coerce_int96_timestamp_unit_; } + /// Enable Parquet supported Arrow Extension Types. + /// + /// When enabled, Parquet will use supported Arrow ExtensionTypes in mapping to Arrow + /// schema. Currently only arrow::extension::json() extension type is supported. This + /// will be used for binary columns whose LogicalType is JSON. + void enable_known_arrow_extensions() { known_arrow_extensions_enabled_ = true; } + void disable_known_arrow_extensions() { known_arrow_extensions_enabled_ = false; } + bool known_arrow_extensions_enabled() const { return known_arrow_extensions_enabled_; } Review Comment: Other boolean setters use a single `void set_XXX(bool xxx)` method. Perhaps we should do that here? What do you think @wgtmac ? ########## cpp/src/arrow/extension/json.cc: ########## @@ -0,0 +1,62 @@ +// 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. + +#include "arrow/extension/json.h" + +#include <string> + +#include "arrow/extension_type.h" +#include "arrow/result.h" +#include "arrow/status.h" +#include "arrow/type_fwd.h" +#include "arrow/util/logging.h" + +namespace arrow::extension { + +bool JsonExtensionType::ExtensionEquals(const ExtensionType& other) const { + const auto& other_ext = static_cast<const ExtensionType&>(other); + return other_ext.extension_name() == this->extension_name(); +} + +Result<std::shared_ptr<DataType>> JsonExtensionType::Deserialize( + std::shared_ptr<DataType> storage_type, const std::string& serialized) const { + if (!serialized.empty()) { + return Status::Invalid("Unexpected serialized metadata: '", serialized, "'"); + } + if (!(storage_type->Equals(*utf8()) || storage_type->Equals(large_utf8()) || + storage_type->Equals(utf8_view()))) { Review Comment: Better use `id()` comparison here as well. ########## cpp/src/arrow/extension/json_test.cc: ########## @@ -0,0 +1,57 @@ +// 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. + +#include "arrow/extension/json.h" + +#include "arrow/ipc/test_common.h" +#include "arrow/record_batch.h" +#include "arrow/testing/gtest_util.h" + +namespace arrow { + +using arrow::ipc::test::RoundtripBatch; +using extension::json; + +class TestJsonExtensionType : public ::testing::Test {}; + +std::shared_ptr<Array> ExampleJson(const std::shared_ptr<DataType>& storage_type) { + std::shared_ptr<Array> arr = ArrayFromJSON(storage_type, R"([ + "null", + "1234", + "3.14159", + "true", + "false", + "\"a json string\"", + "[\"a\", \"json\", \"array\"]", + "{\"obj\": \"a simple json object\"}" + ])"); + return ExtensionType::WrapArray(arrow::extension::json(storage_type), arr); +} + +TEST_F(TestJsonExtensionType, JsonRoundtrip) { + for (const auto& storage_type : {utf8(), large_utf8(), utf8_view()}) { + auto ext_arr = ExampleJson(storage_type); + + auto batch = + RecordBatch::Make(schema({field("f0", json(storage_type))}), 8, {ext_arr}); + std::shared_ptr<RecordBatch> read_batch; + RoundtripBatch(batch, &read_batch); Review Comment: Does this also validate the batch? Or perhaps: ```suggestion RoundtripBatch(batch, &read_batch); ASSERT_OK(read_batch->ValidateFull()); ``` ########## cpp/src/arrow/extension/json.h: ########## @@ -0,0 +1,65 @@ +// 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. + +#pragma once + +#include <string> + +#include "arrow/extension_type.h" +#include "arrow/result.h" +#include "arrow/type_fwd.h" +#include "arrow/util/logging.h" +#include "arrow/util/visibility.h" + +namespace arrow::extension { + +/// \brief Concrete type class for variable-size JSON data, utf8-encoded. +class ARROW_EXPORT JsonExtensionType : public ExtensionType { + public: + explicit JsonExtensionType(const std::shared_ptr<DataType>& storage_type) + : ExtensionType(storage_type), storage_type_(storage_type) { + ARROW_CHECK(storage_type->Equals(utf8()) || storage_type->Equals(large_utf8()) || + storage_type->Equals(utf8_view())); + } + + static constexpr const char* type_name() { return "arrow.json"; } Review Comment: No, this should remain the same as for `ExtensionType` ("extension") ########## cpp/src/parquet/arrow/schema_internal.h: ########## @@ -18,6 +18,7 @@ #pragma once #include "arrow/result.h" +#include "parquet/properties.h" Review Comment: Could include `parquet/type_fwd.h` instead. ########## cpp/src/parquet/arrow/schema.cc: ########## @@ -984,21 +992,51 @@ Result<bool> ApplyOriginalMetadata(const Field& origin_field, SchemaField* infer bool modified = false; auto& origin_type = origin_field.type(); + auto inferred_type = inferred->field->type(); if (origin_type->id() == ::arrow::Type::EXTENSION) { const auto& ex_type = checked_cast<const ::arrow::ExtensionType&>(*origin_type); - auto origin_storage_field = origin_field.WithType(ex_type.storage_type()); + if (inferred_type->id() != ::arrow::Type::EXTENSION && + ex_type.extension_name() == ::arrow::extension::JsonExtensionType::type_name()) { + // Schema mismatch. + // + // Arrow extensions are DISABLED in Parquet. + // origin_type is ::arrow::extension::json() + // inferred_type is ::arrow::binary() + // + // Origin type is restored as Arrow should be considered the source of truth. + DCHECK_EQ(inferred_type->id(), ::arrow::Type::BINARY); + inferred->field = inferred->field->WithType(origin_type); + RETURN_NOT_OK(ApplyOriginalStorageMetadata(origin_field, inferred)); + } else { + auto origin_storage_field = origin_field.WithType(ex_type.storage_type()); - // Apply metadata recursively to storage type - RETURN_NOT_OK(ApplyOriginalStorageMetadata(*origin_storage_field, inferred)); + // Apply metadata recursively to storage type + RETURN_NOT_OK(ApplyOriginalStorageMetadata(*origin_storage_field, inferred)); - // Restore extension type, if the storage type is the same as inferred - // from the Parquet type - if (ex_type.storage_type()->Equals(*inferred->field->type())) { - inferred->field = inferred->field->WithType(origin_type); + // Restore extension type, if the storage type is the same as inferred + // from the Parquet type + if (ex_type.storage_type()->Equals(*inferred->field->type())) { + inferred->field = inferred->field->WithType(origin_type); + } } modified = true; } else { + if (inferred_type->id() == ::arrow::Type::EXTENSION) { + const auto& ex_type = checked_cast<const ::arrow::ExtensionType&>(*inferred_type); + if (ex_type.extension_name() == + ::arrow::extension::JsonExtensionType::type_name()) { + // Schema mismatch. + // + // Arrow extensions are ENABLED in Parquet. + // origin_type is ::arrow::binary() + // inferred_type is ::arrow::extension::json() Review Comment: In which case does this happen? ########## cpp/src/parquet/arrow/schema.cc: ########## @@ -984,21 +992,51 @@ Result<bool> ApplyOriginalMetadata(const Field& origin_field, SchemaField* infer bool modified = false; auto& origin_type = origin_field.type(); + auto inferred_type = inferred->field->type(); if (origin_type->id() == ::arrow::Type::EXTENSION) { const auto& ex_type = checked_cast<const ::arrow::ExtensionType&>(*origin_type); - auto origin_storage_field = origin_field.WithType(ex_type.storage_type()); + if (inferred_type->id() != ::arrow::Type::EXTENSION && + ex_type.extension_name() == ::arrow::extension::JsonExtensionType::type_name()) { Review Comment: Cannot use `type_name()` for this (see other comment about it in `json.h`). ########## cpp/src/parquet/arrow/schema.cc: ########## @@ -984,21 +992,51 @@ Result<bool> ApplyOriginalMetadata(const Field& origin_field, SchemaField* infer bool modified = false; auto& origin_type = origin_field.type(); + auto inferred_type = inferred->field->type(); if (origin_type->id() == ::arrow::Type::EXTENSION) { const auto& ex_type = checked_cast<const ::arrow::ExtensionType&>(*origin_type); - auto origin_storage_field = origin_field.WithType(ex_type.storage_type()); + if (inferred_type->id() != ::arrow::Type::EXTENSION && + ex_type.extension_name() == ::arrow::extension::JsonExtensionType::type_name()) { + // Schema mismatch. + // + // Arrow extensions are DISABLED in Parquet. + // origin_type is ::arrow::extension::json() + // inferred_type is ::arrow::binary() + // + // Origin type is restored as Arrow should be considered the source of truth. + DCHECK_EQ(inferred_type->id(), ::arrow::Type::BINARY); + inferred->field = inferred->field->WithType(origin_type); + RETURN_NOT_OK(ApplyOriginalStorageMetadata(origin_field, inferred)); + } else { + auto origin_storage_field = origin_field.WithType(ex_type.storage_type()); - // Apply metadata recursively to storage type - RETURN_NOT_OK(ApplyOriginalStorageMetadata(*origin_storage_field, inferred)); + // Apply metadata recursively to storage type + RETURN_NOT_OK(ApplyOriginalStorageMetadata(*origin_storage_field, inferred)); - // Restore extension type, if the storage type is the same as inferred - // from the Parquet type - if (ex_type.storage_type()->Equals(*inferred->field->type())) { - inferred->field = inferred->field->WithType(origin_type); + // Restore extension type, if the storage type is the same as inferred + // from the Parquet type + if (ex_type.storage_type()->Equals(*inferred->field->type())) { + inferred->field = inferred->field->WithType(origin_type); + } } modified = true; } else { + if (inferred_type->id() == ::arrow::Type::EXTENSION) { + const auto& ex_type = checked_cast<const ::arrow::ExtensionType&>(*inferred_type); + if (ex_type.extension_name() == + ::arrow::extension::JsonExtensionType::type_name()) { + // Schema mismatch. + // + // Arrow extensions are ENABLED in Parquet. + // origin_type is ::arrow::binary() + // inferred_type is ::arrow::extension::json() + // + // Origin type is restored as Arrow should be considered the source of truth. Review Comment: I'm unsure that it is really desirable, since this is also losing information about the logical type. ########## cpp/src/parquet/arrow/schema.cc: ########## @@ -427,6 +428,14 @@ Status FieldToNode(const std::string& name, const std::shared_ptr<Field>& field, } case ArrowTypeId::EXTENSION: { auto ext_type = std::static_pointer_cast<::arrow::ExtensionType>(field->type()); + // Built-in JSON extension is handled differently. + if (ext_type->extension_name() == + std::static_pointer_cast<::arrow::ExtensionType>(::arrow::extension::json()) + ->extension_name()) { Review Comment: You could just hard-code `std::string("arrow.json")` here. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
