json_serde_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 <map>
#include <memory>
#include <optional>
#include <string>
#include <string_view>
#include <unordered_map>
 
#include <nlohmann/json_fwd.hpp>
 
#include "iceberg/encryption/encrypted_key.h"
#include "iceberg/result.h"
#include "iceberg/statistics_file.h"
#include "iceberg/table_metadata.h"
#include "iceberg/type_fwd.h"
 
namespace iceberg {
 
ICEBERG_EXPORT nlohmann::json ToJson(const SortField& sort_field);
 
ICEBERG_EXPORT Result<std::unique_ptr<SortField>> SortFieldFromJson(
    const nlohmann::json& json);
 
ICEBERG_EXPORT nlohmann::json ToJson(const SortOrder& sort_order);
 
ICEBERG_EXPORT Result<std::unique_ptr<SortOrder>> SortOrderFromJson(
    const nlohmann::json& json, const std::shared_ptr<Schema>& current_schema);
 
ICEBERG_EXPORT Result<std::unique_ptr<SortOrder>> SortOrderFromJson(
    const nlohmann::json& json);
 
ICEBERG_EXPORT Result<nlohmann::json> ToJson(const Schema& schema);
 
ICEBERG_EXPORT Result<std::string> ToJsonString(const Schema& schema);
 
ICEBERG_EXPORT Result<std::unique_ptr<Schema>> SchemaFromJson(const nlohmann::json& json);
 
ICEBERG_EXPORT Result<nlohmann::json> ToJson(const Type& type);
 
ICEBERG_EXPORT Result<std::unique_ptr<Type>> TypeFromJson(const nlohmann::json& json);
 
ICEBERG_EXPORT Result<nlohmann::json> ToJson(const SchemaField& field);
 
ICEBERG_EXPORT Result<std::unique_ptr<SchemaField>> FieldFromJson(
    const nlohmann::json& json);
 
ICEBERG_EXPORT nlohmann::json ToJson(const PartitionField& partition_field);
 
ICEBERG_EXPORT Result<std::unique_ptr<PartitionField>> PartitionFieldFromJson(
    const nlohmann::json& json, bool allow_field_id_missing = false);
 
ICEBERG_EXPORT nlohmann::json ToJson(const PartitionSpec& partition_spec);
 
ICEBERG_EXPORT Result<std::string> ToJsonString(const PartitionSpec& partition_spec);
 
ICEBERG_EXPORT Result<std::unique_ptr<PartitionSpec>> PartitionSpecFromJson(
    const std::shared_ptr<Schema>& schema, const nlohmann::json& json,
    int32_t default_spec_id);
 
ICEBERG_EXPORT Result<std::unique_ptr<PartitionSpec>> PartitionSpecFromJson(
    const nlohmann::json& json);
 
ICEBERG_EXPORT nlohmann::json ToJson(const SnapshotRef& snapshot_ref);
 
ICEBERG_EXPORT Result<std::unique_ptr<SnapshotRef>> SnapshotRefFromJson(
    const nlohmann::json& json);
 
ICEBERG_EXPORT nlohmann::json ToJson(const Snapshot& snapshot);
 
ICEBERG_EXPORT Result<std::unique_ptr<Snapshot>> SnapshotFromJson(
    const nlohmann::json& json);
 
ICEBERG_EXPORT nlohmann::json ToJson(const StatisticsFile& statistics_file);
 
ICEBERG_EXPORT Result<std::unique_ptr<StatisticsFile>> StatisticsFileFromJson(
    const nlohmann::json& json);
 
ICEBERG_EXPORT nlohmann::json ToJson(
    const PartitionStatisticsFile& partition_statistics_file);
 
ICEBERG_EXPORT Result<std::unique_ptr<PartitionStatisticsFile>>
PartitionStatisticsFileFromJson(const nlohmann::json& json);
 
ICEBERG_EXPORT nlohmann::json ToJson(const SnapshotLogEntry& snapshot_log_entry);
 
ICEBERG_EXPORT Result<SnapshotLogEntry> SnapshotLogEntryFromJson(
    const nlohmann::json& json);
 
ICEBERG_EXPORT nlohmann::json ToJson(const MetadataLogEntry& metadata_log_entry);
 
ICEBERG_EXPORT Result<MetadataLogEntry> MetadataLogEntryFromJson(
    const nlohmann::json& json);
 
ICEBERG_EXPORT nlohmann::json ToJson(const EncryptedKey& encrypted_key);
 
ICEBERG_EXPORT Result<EncryptedKey> EncryptedKeyFromJson(const nlohmann::json& json);
 
ICEBERG_EXPORT Result<nlohmann::json> ToJson(const TableMetadata& table_metadata);
 
ICEBERG_EXPORT Result<std::string> ToJsonString(const TableMetadata& table_metadata);
 
ICEBERG_EXPORT Result<std::unique_ptr<TableMetadata>> TableMetadataFromJson(
    const nlohmann::json& json);
 
ICEBERG_EXPORT Result<nlohmann::json> FromJsonString(const std::string& json_string);
 
ICEBERG_EXPORT Result<std::string> ToJsonString(const nlohmann::json& json);
 
ICEBERG_EXPORT nlohmann::json ToJson(const MappedField& field);
 
ICEBERG_EXPORT Result<MappedField> MappedFieldFromJson(const nlohmann::json& json);
 
ICEBERG_EXPORT nlohmann::json ToJson(const MappedFields& mapped_fields);
 
ICEBERG_EXPORT Result<std::unique_ptr<MappedFields>> MappedFieldsFromJson(
    const nlohmann::json& json);
 
ICEBERG_EXPORT nlohmann::json ToJson(const NameMapping& name_mapping);
 
ICEBERG_EXPORT Result<std::unique_ptr<NameMapping>> NameMappingFromJson(
    const nlohmann::json& json);
 
ICEBERG_EXPORT Result<std::string> UpdateMappingFromJsonString(
    std::string_view mapping_json,
    const std::unordered_map<int32_t, std::shared_ptr<SchemaField>>& updates,
    const std::multimap<int32_t, int32_t>& adds);
 
ICEBERG_EXPORT nlohmann::json ToJson(const TableIdentifier& identifier);
 
ICEBERG_EXPORT Result<TableIdentifier> TableIdentifierFromJson(
    const nlohmann::json& json);
 
ICEBERG_EXPORT nlohmann::json ToJson(const Namespace& ns);
 
ICEBERG_EXPORT Result<Namespace> NamespaceFromJson(const nlohmann::json& json);
 
ICEBERG_EXPORT Result<nlohmann::json> ToJson(const TableUpdate& update);
 
ICEBERG_EXPORT Result<std::unique_ptr<TableUpdate>> TableUpdateFromJson(
    const nlohmann::json& json);
 
ICEBERG_EXPORT nlohmann::json ToJson(const TableRequirement& requirement);
 
ICEBERG_EXPORT Result<std::unique_ptr<TableRequirement>> TableRequirementFromJson(
    const nlohmann::json& json);
 
}  // namespace iceberg