partition_spec.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 <optional>
#include <span>
#include <string>
#include <unordered_map>
#include <vector>
 
#include "iceberg/iceberg_export.h"
#include "iceberg/partition_field.h"
#include "iceberg/result.h"
#include "iceberg/type_fwd.h"
#include "iceberg/util/formattable.h"
#include "iceberg/util/lazy.h"
 
namespace iceberg {
 
class ICEBERG_EXPORT PartitionSpec : public util::Formattable {
 public:
  static constexpr int32_t kInitialSpecId = 0;
  static constexpr int32_t kLegacyPartitionDataIdStart = 1000;
  static constexpr int32_t kInvalidPartitionFieldId = -1;
 
  static const std::shared_ptr<PartitionSpec>& Unpartitioned();
 
  int32_t spec_id() const;
 
  std::span<const PartitionField> fields() const;
 
  bool IsUnpartitioned() const;
 
  Result<std::unique_ptr<StructType>> PartitionType(const Schema& schema) const;
 
  Result<std::unique_ptr<StructType>> RawPartitionType(const Schema& schema) const;
 
  Result<std::string> PartitionPath(const PartitionValues& data) const;
 
  bool CompatibleWith(const PartitionSpec& other) const;
 
  std::string ToString() const override;
 
  int32_t last_assigned_field_id() const { return last_assigned_field_id_; }
 
  friend bool operator==(const PartitionSpec& lhs, const PartitionSpec& rhs) {
    return lhs.Equals(rhs);
  }
 
  Status Validate(const Schema& schema, bool allow_missing_fields) const;
 
  // \brief Validates the partition field names are unique within the partition spec and
  // schema.
  static Status ValidatePartitionName(const Schema& schema, const PartitionSpec& spec);
 
  using PartitionFieldRef = std::reference_wrapper<const PartitionField>;
  Result<std::vector<PartitionFieldRef>> GetFieldsBySourceId(int32_t source_id) const;
 
  static Result<std::unique_ptr<PartitionSpec>> Make(
      const Schema& schema, int32_t spec_id, std::vector<PartitionField> fields,
      bool allow_missing_fields,
      std::optional<int32_t> last_assigned_field_id = std::nullopt);
 
  static Result<std::unique_ptr<PartitionSpec>> Make(
      int32_t spec_id, std::vector<PartitionField> fields,
      std::optional<int32_t> last_assigned_field_id = std::nullopt);
 
  static bool HasSequentialFieldIds(const PartitionSpec& spec);
 
 private:
  PartitionSpec(int32_t spec_id, std::vector<PartitionField> fields,
                std::optional<int32_t> last_assigned_field_id = std::nullopt);
 
  bool Equals(const PartitionSpec& other) const;
 
  static Status ValidateRedundantPartitions(const PartitionSpec& spec);
 
  using SourceIdToFieldsMap = std::unordered_map<int32_t, std::vector<PartitionFieldRef>>;
  static Result<SourceIdToFieldsMap> InitSourceIdToFieldsMap(const PartitionSpec&);
 
  const int32_t spec_id_;
  std::vector<PartitionField> fields_;
  int32_t last_assigned_field_id_;
  Lazy<InitSourceIdToFieldsMap> source_id_to_fields_;
};
 
}  // namespace iceberg