position_delete_index.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 <span>
#include <vector>
 
#include "iceberg/deletes/roaring_position_bitmap.h"
#include "iceberg/iceberg_export.h"
#include "iceberg/result.h"
#include "iceberg/type_fwd.h"
 
namespace iceberg {
 
class ICEBERG_EXPORT PositionDeleteIndex {
 public:
  PositionDeleteIndex() = default;
  explicit PositionDeleteIndex(std::shared_ptr<DataFile> delete_file);
  explicit PositionDeleteIndex(std::vector<std::shared_ptr<DataFile>> delete_files);
  ~PositionDeleteIndex() = default;
 
  void Delete(int64_t pos);
 
  void Delete(int64_t pos_start, int64_t pos_end);
 
  bool IsDeleted(int64_t pos) const;
 
  bool IsEmpty() const;
 
  int64_t Cardinality() const;
 
  void Merge(const PositionDeleteIndex& other);
 
  const std::vector<std::shared_ptr<DataFile>>& delete_files() const {
    return delete_files_;
  }
 
  Result<std::vector<uint8_t>> Serialize();
 
  static Result<PositionDeleteIndex> Deserialize(std::span<const uint8_t> blob,
                                                 std::shared_ptr<DataFile> delete_file);
 
 private:
  explicit PositionDeleteIndex(RoaringPositionBitmap bitmap);
 
  // Bulk-add positions sharing high-32-bit `key`. Private hook for
  // `ForEachPositionDelete`'s bulk path; keeps `Delete` the sole public
  // mutation surface.
  void BulkAddForKey(int32_t key, std::span<const uint32_t> positions);
 
  friend void ICEBERG_EXPORT ForEachPositionDelete(std::span<const int64_t> positions,
                                                   PositionDeleteIndex& target,
                                                   std::vector<uint32_t>& scratch);
 
  RoaringPositionBitmap bitmap_;
  std::vector<std::shared_ptr<DataFile>> delete_files_;
};
 
}  // namespace iceberg