file_metadata.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 <optional>
#include <string>
#include <string_view>
#include <unordered_map>
#include <vector>
 
#include "iceberg/iceberg_data_export.h"
#include "iceberg/result.h"
 
namespace iceberg::puffin {
 
enum class PuffinCompressionCodec {
  kNone,
  kLz4,
  kZstd,
};
 
ICEBERG_DATA_EXPORT std::string_view CodecName(PuffinCompressionCodec codec);
 
ICEBERG_DATA_EXPORT Result<PuffinCompressionCodec> PuffinCompressionCodecFromName(
    std::string_view codec_name);
 
ICEBERG_DATA_EXPORT std::string ToString(PuffinCompressionCodec codec);
 
struct StandardBlobTypes {
  static constexpr std::string_view kApacheDatasketchesThetaV1 =
      "apache-datasketches-theta-v1";
 
  static constexpr std::string_view kDeletionVectorV1 = "deletion-vector-v1";
};
 
struct StandardPuffinProperties {
  static constexpr std::string_view kCreatedBy = "created-by";
};
 
struct ICEBERG_DATA_EXPORT Blob {
  std::string type;
  std::vector<int32_t> input_fields;
  int64_t snapshot_id;
  int64_t sequence_number;
  std::vector<uint8_t> data;
  std::optional<PuffinCompressionCodec> requested_compression;
  std::unordered_map<std::string, std::string> properties;
 
  friend bool operator==(const Blob& lhs, const Blob& rhs) = default;
};
 
ICEBERG_DATA_EXPORT std::string ToString(const Blob& blob);
 
struct ICEBERG_DATA_EXPORT BlobMetadata {
  std::string type;
  std::vector<int32_t> input_fields;
  int64_t snapshot_id;
  int64_t sequence_number;
  int64_t offset;
  int64_t length;
  std::string compression_codec;
  std::unordered_map<std::string, std::string> properties;
 
  friend bool operator==(const BlobMetadata& lhs, const BlobMetadata& rhs) = default;
};
 
ICEBERG_DATA_EXPORT std::string ToString(const BlobMetadata& blob_metadata);
 
struct ICEBERG_DATA_EXPORT FileMetadata {
  std::vector<BlobMetadata> blobs;
  std::unordered_map<std::string, std::string> properties;
 
  friend bool operator==(const FileMetadata& lhs, const FileMetadata& rhs) = default;
};
 
ICEBERG_DATA_EXPORT std::string ToString(const FileMetadata& file_metadata);
 
}  // namespace iceberg::puffin