Refactor CapnProto format to improve input/output performance #49752
There are no files selected for viewing
Submodule capnproto
updated
66 files
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,298 @@ | ||
| #include <Formats/CapnProtoSchema.h> | ||
|
There was a problem hiding this comment. Code from this file is not new, it's copied from old file |
||
|
|
||
| #if USE_CAPNP | ||
|
|
||
| #include <DataTypes/DataTypeArray.h> | ||
| #include <DataTypes/DataTypeEnum.h> | ||
| #include <DataTypes/DataTypeNullable.h> | ||
| #include <DataTypes/DataTypeTuple.h> | ||
| #include <DataTypes/DataTypesNumber.h> | ||
| #include <DataTypes/DataTypeString.h> | ||
| #include <DataTypes/IDataType.h> | ||
| #include <Common/StringUtils/StringUtils.h> | ||
| #include <boost/algorithm/string/join.hpp> | ||
| #include <capnp/schema.h> | ||
| #include <capnp/schema-parser.h> | ||
| #include <fcntl.h> | ||
|
|
||
| namespace DB | ||
| { | ||
|
|
||
| namespace ErrorCodes | ||
| { | ||
| extern const int CANNOT_PARSE_CAPN_PROTO_SCHEMA; | ||
| extern const int BAD_TYPE_OF_FIELD; | ||
| extern const int FILE_DOESNT_EXIST; | ||
| extern const int UNKNOWN_EXCEPTION; | ||
| extern const int CAPN_PROTO_BAD_TYPE; | ||
| extern const int BAD_ARGUMENTS; | ||
| } | ||
|
|
||
| capnp::StructSchema CapnProtoSchemaParser::getMessageSchema(const FormatSchemaInfo & schema_info) | ||
| { | ||
| capnp::ParsedSchema schema; | ||
| try | ||
| { | ||
| int fd; | ||
| KJ_SYSCALL(fd = open(schema_info.schemaDirectory().data(), O_RDONLY)); // NOLINT(bugprone-suspicious-semicolon) | ||
| auto schema_dir = kj::newDiskDirectory(kj::OsFileHandle(fd)); | ||
| schema = impl.parseFromDirectory(*schema_dir, kj::Path::parse(schema_info.schemaPath()), {}); | ||
| } | ||
| catch (const kj::Exception & e) | ||
| { | ||
| /// That's not good to determine the type of error by its description, but | ||
| /// this is the only way to do it here, because kj doesn't specify the type of error. | ||
| auto description = std::string_view(e.getDescription().cStr()); | ||
| if (description.find("No such file or directory") != String::npos || description.find("no such directory") != String::npos || description.find("no such file") != String::npos) | ||
| throw Exception(ErrorCodes::FILE_DOESNT_EXIST, "Cannot open CapnProto schema, file {} doesn't exists", schema_info.absoluteSchemaPath()); | ||
|
|
||
| if (description.find("Parse error") != String::npos) | ||
| throw Exception(ErrorCodes::CANNOT_PARSE_CAPN_PROTO_SCHEMA, "Cannot parse CapnProto schema {}:{}", schema_info.schemaPath(), e.getLine()); | ||
|
|
||
| throw Exception(ErrorCodes::UNKNOWN_EXCEPTION, | ||
| "Unknown exception while parsing CapnProto schema: {}, schema dir and file: {}, {}", | ||
| description, schema_info.schemaDirectory(), schema_info.schemaPath()); | ||
| } | ||
|
|
||
| auto message_maybe = schema.findNested(schema_info.messageName()); | ||
| auto * message_schema = kj::_::readMaybe(message_maybe); | ||
| if (!message_schema) | ||
| throw Exception(ErrorCodes::CANNOT_PARSE_CAPN_PROTO_SCHEMA, | ||
| "CapnProto schema doesn't contain message with name {}", schema_info.messageName()); | ||
| return message_schema->asStruct(); | ||
| } | ||
|
|
||
| bool checkIfStructContainsUnnamedUnion(const capnp::StructSchema & struct_schema) | ||
| { | ||
| return struct_schema.getFields().size() != struct_schema.getNonUnionFields().size(); | ||
| } | ||
|
|
||
| bool checkIfStructIsNamedUnion(const capnp::StructSchema & struct_schema) | ||
| { | ||
| return struct_schema.getFields().size() == struct_schema.getUnionFields().size(); | ||
| } | ||
|
|
||
| /// Get full name of type for better exception messages. | ||
| String getCapnProtoFullTypeName(const capnp::Type & type) | ||
| { | ||
| static const std::map<capnp::schema::Type::Which, String> capnp_simple_type_names = | ||
| { | ||
| {capnp::schema::Type::Which::BOOL, "Bool"}, | ||
| {capnp::schema::Type::Which::VOID, "Void"}, | ||
| {capnp::schema::Type::Which::INT8, "Int8"}, | ||
| {capnp::schema::Type::Which::INT16, "Int16"}, | ||
| {capnp::schema::Type::Which::INT32, "Int32"}, | ||
| {capnp::schema::Type::Which::INT64, "Int64"}, | ||
| {capnp::schema::Type::Which::UINT8, "UInt8"}, | ||
| {capnp::schema::Type::Which::UINT16, "UInt16"}, | ||
| {capnp::schema::Type::Which::UINT32, "UInt32"}, | ||
| {capnp::schema::Type::Which::UINT64, "UInt64"}, | ||
| {capnp::schema::Type::Which::FLOAT32, "Float32"}, | ||
| {capnp::schema::Type::Which::FLOAT64, "Float64"}, | ||
| {capnp::schema::Type::Which::TEXT, "Text"}, | ||
| {capnp::schema::Type::Which::DATA, "Data"}, | ||
| {capnp::schema::Type::Which::INTERFACE, "Interface"}, | ||
| {capnp::schema::Type::Which::ANY_POINTER, "AnyPointer"}, | ||
| }; | ||
|
|
||
| switch (type.which()) | ||
| { | ||
| case capnp::schema::Type::Which::STRUCT: | ||
| { | ||
| auto struct_schema = type.asStruct(); | ||
|
|
||
| auto non_union_fields = struct_schema.getNonUnionFields(); | ||
| std::vector<String> non_union_field_names; | ||
| for (auto nested_field : non_union_fields) | ||
| non_union_field_names.push_back(String(nested_field.getProto().getName()) + " " + getCapnProtoFullTypeName(nested_field.getType())); | ||
|
|
||
| auto union_fields = struct_schema.getUnionFields(); | ||
| std::vector<String> union_field_names; | ||
| for (auto nested_field : union_fields) | ||
| union_field_names.push_back(String(nested_field.getProto().getName()) + " " + getCapnProtoFullTypeName(nested_field.getType())); | ||
|
|
||
| String union_name = "Union(" + boost::algorithm::join(union_field_names, ", ") + ")"; | ||
| /// Check if the struct is a named union. | ||
| if (non_union_field_names.empty()) | ||
| return union_name; | ||
|
|
||
| String type_name = "Struct(" + boost::algorithm::join(non_union_field_names, ", "); | ||
| /// Check if the struct contains unnamed union. | ||
| if (!union_field_names.empty()) | ||
| type_name += ", " + union_name; | ||
| type_name += ")"; | ||
| return type_name; | ||
| } | ||
| case capnp::schema::Type::Which::LIST: | ||
| return "List(" + getCapnProtoFullTypeName(type.asList().getElementType()) + ")"; | ||
| case capnp::schema::Type::Which::ENUM: | ||
| { | ||
| auto enum_schema = type.asEnum(); | ||
| String enum_name = "Enum("; | ||
| auto enumerants = enum_schema.getEnumerants(); | ||
| for (unsigned i = 0; i != enumerants.size(); ++i) | ||
| { | ||
| enum_name += String(enumerants[i].getProto().getName()) + " = " + std::to_string(enumerants[i].getOrdinal()); | ||
| if (i + 1 != enumerants.size()) | ||
| enum_name += ", "; | ||
| } | ||
| enum_name += ")"; | ||
| return enum_name; | ||
| } | ||
| default: | ||
| auto it = capnp_simple_type_names.find(type.which()); | ||
| if (it == capnp_simple_type_names.end()) | ||
| throw Exception(ErrorCodes::BAD_TYPE_OF_FIELD, "Unknown CapnProto type"); | ||
| return it->second; | ||
| } | ||
| } | ||
|
|
||
| namespace | ||
| { | ||
|
|
||
| template <typename ValueType> | ||
| DataTypePtr getEnumDataTypeFromEnumerants(const capnp::EnumSchema::EnumerantList & enumerants) | ||
| { | ||
| std::vector<std::pair<String, ValueType>> values; | ||
| for (auto enumerant : enumerants) | ||
| values.emplace_back(enumerant.getProto().getName(), ValueType(enumerant.getOrdinal())); | ||
| return std::make_shared<DataTypeEnum<ValueType>>(std::move(values)); | ||
| } | ||
|
|
||
| DataTypePtr getEnumDataTypeFromEnumSchema(const capnp::EnumSchema & enum_schema) | ||
| { | ||
| auto enumerants = enum_schema.getEnumerants(); | ||
| if (enumerants.size() < 128) | ||
| return getEnumDataTypeFromEnumerants<Int8>(enumerants); | ||
| if (enumerants.size() < 32768) | ||
| return getEnumDataTypeFromEnumerants<Int16>(enumerants); | ||
|
|
||
| throw Exception(ErrorCodes::CAPN_PROTO_BAD_TYPE, "ClickHouse supports only 8 and 16-bit Enums"); | ||
| } | ||
|
|
||
| DataTypePtr getDataTypeFromCapnProtoType(const capnp::Type & capnp_type, bool skip_unsupported_fields) | ||
| { | ||
| switch (capnp_type.which()) | ||
| { | ||
| case capnp::schema::Type::INT8: | ||
| return std::make_shared<DataTypeInt8>(); | ||
| case capnp::schema::Type::INT16: | ||
| return std::make_shared<DataTypeInt16>(); | ||
| case capnp::schema::Type::INT32: | ||
| return std::make_shared<DataTypeInt32>(); | ||
| case capnp::schema::Type::INT64: | ||
| return std::make_shared<DataTypeInt64>(); | ||
| case capnp::schema::Type::BOOL: [[fallthrough]]; | ||
| case capnp::schema::Type::UINT8: | ||
| return std::make_shared<DataTypeUInt8>(); | ||
| case capnp::schema::Type::UINT16: | ||
| return std::make_shared<DataTypeUInt16>(); | ||
| case capnp::schema::Type::UINT32: | ||
| return std::make_shared<DataTypeUInt32>(); | ||
| case capnp::schema::Type::UINT64: | ||
| return std::make_shared<DataTypeUInt64>(); | ||
| case capnp::schema::Type::FLOAT32: | ||
| return std::make_shared<DataTypeFloat32>(); | ||
| case capnp::schema::Type::FLOAT64: | ||
| return std::make_shared<DataTypeFloat64>(); | ||
| case capnp::schema::Type::DATA: [[fallthrough]]; | ||
| case capnp::schema::Type::TEXT: | ||
| return std::make_shared<DataTypeString>(); | ||
| case capnp::schema::Type::ENUM: | ||
| return getEnumDataTypeFromEnumSchema(capnp_type.asEnum()); | ||
| case capnp::schema::Type::LIST: | ||
| { | ||
| auto list_schema = capnp_type.asList(); | ||
| auto nested_type = getDataTypeFromCapnProtoType(list_schema.getElementType(), skip_unsupported_fields); | ||
| if (!nested_type) | ||
| return nullptr; | ||
| return std::make_shared<DataTypeArray>(nested_type); | ||
| } | ||
| case capnp::schema::Type::STRUCT: | ||
| { | ||
| auto struct_schema = capnp_type.asStruct(); | ||
|
|
||
|
|
||
| if (struct_schema.getFields().size() == 0) | ||
| { | ||
| if (skip_unsupported_fields) | ||
| return nullptr; | ||
| throw Exception(ErrorCodes::CAPN_PROTO_BAD_TYPE, "Empty messages are not supported"); | ||
| } | ||
|
|
||
| /// Check if it can be Nullable. | ||
| if (checkIfStructIsNamedUnion(struct_schema)) | ||
| { | ||
| auto fields = struct_schema.getUnionFields(); | ||
| if (fields.size() != 2 || (!fields[0].getType().isVoid() && !fields[1].getType().isVoid())) | ||
| { | ||
| if (skip_unsupported_fields) | ||
| return nullptr; | ||
| throw Exception(ErrorCodes::CAPN_PROTO_BAD_TYPE, "Unions are not supported"); | ||
| } | ||
| auto value_type = fields[0].getType().isVoid() ? fields[1].getType() : fields[0].getType(); | ||
| if (value_type.isStruct() || value_type.isList()) | ||
| { | ||
| if (skip_unsupported_fields) | ||
| return nullptr; | ||
| throw Exception(ErrorCodes::CAPN_PROTO_BAD_TYPE, "Tuples and Lists cannot be inside Nullable"); | ||
| } | ||
|
|
||
| auto nested_type = getDataTypeFromCapnProtoType(value_type, skip_unsupported_fields); | ||
| if (!nested_type) | ||
| return nullptr; | ||
| return std::make_shared<DataTypeNullable>(nested_type); | ||
| } | ||
|
|
||
| if (checkIfStructContainsUnnamedUnion(struct_schema)) | ||
| throw Exception(ErrorCodes::CAPN_PROTO_BAD_TYPE, "Unnamed union is not supported"); | ||
|
|
||
| /// Treat Struct as Tuple. | ||
| DataTypes nested_types; | ||
| Names nested_names; | ||
| for (auto field : struct_schema.getNonUnionFields()) | ||
| { | ||
| auto nested_type = getDataTypeFromCapnProtoType(field.getType(), skip_unsupported_fields); | ||
| if (!nested_type) | ||
| continue; | ||
| nested_names.push_back(field.getProto().getName()); | ||
| nested_types.push_back(nested_type); | ||
| } | ||
| if (nested_types.empty()) | ||
| return nullptr; | ||
| return std::make_shared<DataTypeTuple>(std::move(nested_types), std::move(nested_names)); | ||
| } | ||
| default: | ||
| { | ||
| if (skip_unsupported_fields) | ||
| return nullptr; | ||
| throw Exception(ErrorCodes::CAPN_PROTO_BAD_TYPE, "Unsupported CapnProtoType: {}", getCapnProtoFullTypeName(capnp_type)); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| } | ||
|
|
||
| NamesAndTypesList capnProtoSchemaToCHSchema(const capnp::StructSchema & schema, bool skip_unsupported_fields) | ||
| { | ||
| if (checkIfStructContainsUnnamedUnion(schema)) | ||
| throw Exception(ErrorCodes::CAPN_PROTO_BAD_TYPE, "Unnamed union is not supported"); | ||
|
|
||
| NamesAndTypesList names_and_types; | ||
| for (auto field : schema.getNonUnionFields()) | ||
| { | ||
| auto name = field.getProto().getName(); | ||
| auto type = getDataTypeFromCapnProtoType(field.getType(), skip_unsupported_fields); | ||
| if (type) | ||
| names_and_types.emplace_back(name, type); | ||
| } | ||
| if (names_and_types.empty()) | ||
| throw Exception(ErrorCodes::BAD_ARGUMENTS, | ||
| "Cannot convert CapnProto schema to ClickHouse table schema, all fields have unsupported types"); | ||
|
|
||
| return names_and_types; | ||
| } | ||
|
|
||
| } | ||
|
|
||
| #endif | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
format_capn_proto_enum_compari
sing_modeThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unfortunately, this setting exists for a long time and we cannot change it's name(