json_serde_internal.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 <memory>
#include <unordered_map>
#include <vector>
 
#include <nlohmann/json_fwd.hpp>
 
#include "iceberg/catalog/rest/iceberg_rest_export.h"
#include "iceberg/catalog/rest/types.h"
#include "iceberg/result.h"
#include "iceberg/type_fwd.h"
 
 
namespace iceberg::rest {
 
template <typename Model>
Result<Model> FromJson(const nlohmann::json& json);
 
#define ICEBERG_DECLARE_JSON_SERDE(Model)                                        \
  ICEBERG_REST_EXPORT Result<Model> Model##FromJson(const nlohmann::json& json); \
                                                                                 \
  template <>                                                                    \
  ICEBERG_REST_EXPORT Result<Model> FromJson(const nlohmann::json& json);        \
                                                                                 \
  ICEBERG_REST_EXPORT nlohmann::json ToJson(const Model& model);
 
ICEBERG_DECLARE_JSON_SERDE(CatalogConfig)
ICEBERG_DECLARE_JSON_SERDE(ErrorResponse)
ICEBERG_DECLARE_JSON_SERDE(ListNamespacesResponse)
ICEBERG_DECLARE_JSON_SERDE(CreateNamespaceRequest)
ICEBERG_DECLARE_JSON_SERDE(CreateNamespaceResponse)
ICEBERG_DECLARE_JSON_SERDE(GetNamespaceResponse)
ICEBERG_DECLARE_JSON_SERDE(UpdateNamespacePropertiesRequest)
ICEBERG_DECLARE_JSON_SERDE(UpdateNamespacePropertiesResponse)
ICEBERG_DECLARE_JSON_SERDE(ListTablesResponse)
ICEBERG_DECLARE_JSON_SERDE(RegisterTableRequest)
ICEBERG_DECLARE_JSON_SERDE(RenameTableRequest)
ICEBERG_DECLARE_JSON_SERDE(OAuthTokenResponse)
 
#undef ICEBERG_DECLARE_JSON_SERDE
 
// These models embed a Schema/TableMetadata whose ToJson returns Result, so their own
// ToJson returns Result too. FromJson is declared like the macro-based models above.
ICEBERG_REST_EXPORT Result<LoadTableResult> LoadTableResultFromJson(
    const nlohmann::json& json);
template <>
ICEBERG_REST_EXPORT Result<LoadTableResult> FromJson(const nlohmann::json& json);
ICEBERG_REST_EXPORT Result<nlohmann::json> ToJson(const LoadTableResult& model);
 
ICEBERG_REST_EXPORT Result<CreateTableRequest> CreateTableRequestFromJson(
    const nlohmann::json& json);
template <>
ICEBERG_REST_EXPORT Result<CreateTableRequest> FromJson(const nlohmann::json& json);
ICEBERG_REST_EXPORT Result<nlohmann::json> ToJson(const CreateTableRequest& model);
 
ICEBERG_REST_EXPORT Result<CommitTableRequest> CommitTableRequestFromJson(
    const nlohmann::json& json);
template <>
ICEBERG_REST_EXPORT Result<CommitTableRequest> FromJson(const nlohmann::json& json);
ICEBERG_REST_EXPORT Result<nlohmann::json> ToJson(const CommitTableRequest& model);
 
ICEBERG_REST_EXPORT Result<CommitTableResponse> CommitTableResponseFromJson(
    const nlohmann::json& json);
template <>
ICEBERG_REST_EXPORT Result<CommitTableResponse> FromJson(const nlohmann::json& json);
ICEBERG_REST_EXPORT Result<nlohmann::json> ToJson(const CommitTableResponse& model);
 
ICEBERG_REST_EXPORT Result<PlanTableScanResponse> PlanTableScanResponseFromJson(
    const nlohmann::json& json,
    const std::unordered_map<int32_t, std::shared_ptr<PartitionSpec>>&
        partition_specs_by_id,
    const Schema& schema);
ICEBERG_REST_EXPORT Result<nlohmann::json> ToJson(
    const PlanTableScanResponse& response,
    const std::unordered_map<int32_t, std::shared_ptr<PartitionSpec>>&
        partition_specs_by_id,
    const Schema& schema);
 
ICEBERG_REST_EXPORT Result<FetchPlanningResultResponse>
FetchPlanningResultResponseFromJson(
    const nlohmann::json& json,
    const std::unordered_map<int32_t, std::shared_ptr<PartitionSpec>>&
        partition_specs_by_id,
    const Schema& schema);
ICEBERG_REST_EXPORT Result<nlohmann::json> ToJson(
    const FetchPlanningResultResponse& response,
    const std::unordered_map<int32_t, std::shared_ptr<PartitionSpec>>&
        partition_specs_by_id,
    const Schema& schema);
 
ICEBERG_REST_EXPORT Result<FetchScanTasksResponse> FetchScanTasksResponseFromJson(
    const nlohmann::json& json,
    const std::unordered_map<int32_t, std::shared_ptr<PartitionSpec>>&
        partition_specs_by_id,
    const Schema& schema);
ICEBERG_REST_EXPORT Result<nlohmann::json> ToJson(
    const FetchScanTasksResponse& response,
    const std::unordered_map<int32_t, std::shared_ptr<PartitionSpec>>&
        partition_specs_by_id,
    const Schema& schema);
 
ICEBERG_REST_EXPORT Result<PlanTableScanRequest> PlanTableScanRequestFromJson(
    const nlohmann::json& json);
template <>
ICEBERG_REST_EXPORT Result<PlanTableScanRequest> FromJson(const nlohmann::json& json);
ICEBERG_REST_EXPORT Result<nlohmann::json> ToJson(const PlanTableScanRequest& request);
 
ICEBERG_REST_EXPORT Result<FetchScanTasksRequest> FetchScanTasksRequestFromJson(
    const nlohmann::json& json);
template <>
ICEBERG_REST_EXPORT Result<FetchScanTasksRequest> FromJson(const nlohmann::json& json);
ICEBERG_REST_EXPORT nlohmann::json ToJson(const FetchScanTasksRequest& request);
 
ICEBERG_REST_EXPORT Result<nlohmann::json> ToJson(
    const DataFile& df,
    const std::unordered_map<int32_t, std::shared_ptr<PartitionSpec>>&
        partition_specs_by_id,
    const Schema& schema);
 
ICEBERG_REST_EXPORT Result<DataFile> DataFileFromJson(
    const nlohmann::json& json,
    const std::unordered_map<int32_t, std::shared_ptr<PartitionSpec>>&
        partition_spec_by_id,
    const Schema& schema);
 
ICEBERG_REST_EXPORT Result<std::vector<std::shared_ptr<FileScanTask>>>
FileScanTasksFromJson(const nlohmann::json& json,
                      const std::vector<std::shared_ptr<DataFile>>& delete_files,
                      const std::unordered_map<int32_t, std::shared_ptr<PartitionSpec>>&
                          partition_spec_by_id,
                      const Schema& schema);
 
}  // namespace iceberg::rest