catalog_properties.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 <string>
#include <unordered_map>
 
#include "iceberg/catalog/rest/iceberg_rest_export.h"
#include "iceberg/result.h"
#include "iceberg/util/config.h"
 
 
namespace iceberg::rest {
 
enum class SnapshotMode : uint8_t { kAll, kRefs };
 
enum class ScanPlanningMode : uint8_t { kClient, kServer };
 
class ICEBERG_REST_EXPORT RestCatalogProperties
    : public ConfigBase<RestCatalogProperties> {
 public:
  template <typename T>
  using Entry = const ConfigBase<RestCatalogProperties>::Entry<T>;
 
  inline static Entry<std::string> kUri{"uri", ""};
  inline static Entry<std::string> kName{"name", ""};
  inline static Entry<std::string> kWarehouse{"warehouse", ""};
  inline static Entry<std::string> kIOImpl{"io-impl", ""};
  inline static Entry<std::string> kPrefix{"prefix", ""};
  inline static Entry<std::string> kNamespaceSeparator{"namespace-separator", "%1F"};
  inline static Entry<std::string> kSnapshotLoadingMode{"snapshot-loading-mode", "ALL"};
  inline static Entry<std::string> kMetricsReportingEnabled{
      "rest-metrics-reporting-enabled", "true"};
  inline static Entry<std::string> kScanPlanningMode{"scan-planning-mode", "client"};
  inline static Entry<int64_t> kScanPlanningPollTimeoutMs{
      "rest-scan-planning.poll-timeout-ms", 300000};
  inline static Entry<int32_t> kScanPlanningPollNumRetries{
      "rest-scan-planning.poll-num-retries", 10};
  inline static constexpr std::string_view kHeaderPrefix = "header.";
  inline static Entry<int64_t> kClientConnectionTimeoutMs{
      "rest.client.connection-timeout-ms", 0};
  inline static Entry<int64_t> kClientSocketTimeoutMs{"rest.client.socket-timeout-ms", 0};
 
  inline static Entry<bool> kTrustServerOAuth2Uri{"rest.auth.oauth2.trust-server-uri",
                                                  true};
 
  static RestCatalogProperties default_properties();
 
  static RestCatalogProperties FromMap(
      std::unordered_map<std::string, std::string> properties);
 
  std::unordered_map<std::string, std::string> ExtractHeaders() const;
 
  Result<std::string_view> Uri() const;
 
  Result<SnapshotMode> SnapshotLoadingMode() const;
 
  static Result<std::optional<ScanPlanningMode>> ScanPlanningModeFrom(
      const std::unordered_map<std::string, std::string>& config);
};
 
}  // namespace iceberg::rest