avro_schema_util_internal.h

/*
 * 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 <stack>
 
#include <avro/Node.hh>
 
#include "iceberg/name_mapping.h"
#include "iceberg/result.h"
#include "iceberg/schema_util.h"
#include "iceberg/type.h"
 
namespace avro {
class Schema;
class ValidSchema;
}  // namespace avro
 
namespace iceberg::avro {
 
struct MapLogicalType : public ::avro::CustomLogicalType {
  MapLogicalType() : ::avro::CustomLogicalType("map") {}
};
 
class ToAvroNodeVisitor {
 public:
  Status Visit(const BooleanType& type, ::avro::NodePtr* node);
  Status Visit(const IntType& type, ::avro::NodePtr* node);
  Status Visit(const LongType& type, ::avro::NodePtr* node);
  Status Visit(const FloatType& type, ::avro::NodePtr* node);
  Status Visit(const DoubleType& type, ::avro::NodePtr* node);
  Status Visit(const DecimalType& type, ::avro::NodePtr* node);
  Status Visit(const DateType& type, ::avro::NodePtr* node);
  Status Visit(const TimeType& type, ::avro::NodePtr* node);
  Status Visit(const TimestampType& type, ::avro::NodePtr* node);
  Status Visit(const TimestampTzType& type, ::avro::NodePtr* node);
  Status Visit(const TimestampNsType& type, ::avro::NodePtr* node);
  Status Visit(const TimestampTzNsType& type, ::avro::NodePtr* node);
  Status Visit(const StringType& type, ::avro::NodePtr* node);
  Status Visit(const UuidType& type, ::avro::NodePtr* node);
  Status Visit(const FixedType& type, ::avro::NodePtr* node);
  Status Visit(const BinaryType& type, ::avro::NodePtr* node);
  Status Visit(const UnknownType&, ::avro::NodePtr*);
  Status Visit(const VariantType&, ::avro::NodePtr*);
  Status Visit(const GeometryType&, ::avro::NodePtr*);
  Status Visit(const GeographyType&, ::avro::NodePtr*);
  Status Visit(const StructType& type, ::avro::NodePtr* node);
  Status Visit(const ListType& type, ::avro::NodePtr* node);
  Status Visit(const MapType& type, ::avro::NodePtr* node);
  Status Visit(const SchemaField& field, ::avro::NodePtr* node);
 
 private:
  // Store recently accessed field ids on the current visitor path.
  std::stack<int32_t> field_ids_;
};
 
class HasIdVisitor {
 public:
  HasIdVisitor() = default;
 
  Status Visit(const ::avro::NodePtr& node);
 
  Status Visit(const ::avro::ValidSchema& schema);
 
  Status Visit(const ::avro::Schema& node);
 
  bool AllHaveIds() const {
    return total_fields_ == fields_with_id_ && fields_with_id_ != 0;
  }
 
  bool HasNoIds() const { return total_fields_ == 0; }
 
 private:
  Status VisitRecord(const ::avro::NodePtr& node);
 
  Status VisitArray(const ::avro::NodePtr& node);
 
  Status VisitMap(const ::avro::NodePtr& node);
 
  Status VisitUnion(const ::avro::NodePtr& node);
 
 private:
  // Total number of fields visited.
  size_t total_fields_ = 0;
  // Number of fields with IDs.
  size_t fields_with_id_ = 0;
};
 
Result<SchemaProjection> Project(const Schema& expected_schema,
                                 const ::avro::NodePtr& avro_node, bool prune_source);
 
std::string ToString(const ::avro::NodePtr& node);
std::string ToString(const ::avro::LogicalType& logical_type);
std::string ToString(const ::avro::LogicalType::Type& logical_type);
 
bool IsAvroDateOrPlainInt(const ::avro::NodePtr& node);
 
bool HasMapLogicalType(const ::avro::NodePtr& node);
 
bool ValidAvroName(std::string_view name);
 
Result<::avro::NodePtr> MakeAvroNodeWithFieldIds(const ::avro::NodePtr& original_node,
                                                 const NameMapping& mapping);
 
std::string SanitizeFieldName(std::string_view field_name);
 
}  // namespace iceberg::avro