schema_field.h

Go to the documentation of this file.

/*
 * 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 <cstdint>
#include <memory>
#include <string>
#include <string_view>
 
#include "iceberg/iceberg_export.h"
#include "iceberg/result.h"
#include "iceberg/type_fwd.h"
#include "iceberg/util/formattable.h"
 
namespace iceberg {
 
class ICEBERG_EXPORT SchemaField : public iceberg::util::Formattable {
 public:
  static constexpr int32_t kInvalidFieldId = -1;
 
  SchemaField(int32_t field_id, std::string_view name, std::shared_ptr<Type> type,
              bool optional, std::string_view doc = {},
              std::shared_ptr<const Literal> initial_default = nullptr,
              std::shared_ptr<const Literal> write_default = nullptr);
 
  static SchemaField MakeOptional(int32_t field_id, std::string_view name,
                                  std::shared_ptr<Type> type, std::string_view doc = {});
  static SchemaField MakeRequired(int32_t field_id, std::string_view name,
                                  std::shared_ptr<Type> type, std::string_view doc = {});
 
  SchemaField WithName(std::string_view name) const;
 
  SchemaField WithType(std::shared_ptr<Type> type) const;
 
  SchemaField WithDoc(std::string_view doc) const;
 
  SchemaField WithInitialDefault(std::shared_ptr<const Literal> initial_default) const;
 
  SchemaField WithWriteDefault(std::shared_ptr<const Literal> write_default) const;
 
  static Result<Literal> CastDefaultValue(
      const Literal& value, const std::shared_ptr<PrimitiveType>& target_type);
 
  int32_t field_id() const;
 
  std::string_view name() const;
 
  const std::shared_ptr<Type>& type() const;
 
  [[nodiscard]] bool optional() const;
 
  std::string_view doc() const;
 
  const std::shared_ptr<const Literal>& initial_default() const;
 
  const std::shared_ptr<const Literal>& write_default() const;
 
  std::string ToString() const override;
 
  Status Validate() const;
 
  friend bool operator==(const SchemaField& lhs, const SchemaField& rhs) {
    return lhs.Equals(rhs);
  }
 
  SchemaField AsRequired() const {
    auto copy = *this;
    copy.optional_ = false;
    return copy;
  }
 
  SchemaField AsOptional() const {
    auto copy = *this;
    copy.optional_ = true;
    return copy;
  }
 
 private:
  bool Equals(const SchemaField& other) const;
 
  int32_t field_id_;
  std::string name_;
  std::shared_ptr<Type> type_;
  bool optional_;
  std::string doc_;
  std::shared_ptr<const Literal> initial_default_;
  std::shared_ptr<const Literal> write_default_;
};
 
}  // namespace iceberg