s3_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 <algorithm>
#include <array>
#include <string_view>
 
namespace iceberg::arrow {
 
struct S3Properties {
  static constexpr std::string_view kS3Schema = "s3";
  static constexpr std::string_view kAccessKeyId = "s3.access-key-id";
  static constexpr std::string_view kSecretAccessKey = "s3.secret-access-key";
  static constexpr std::string_view kSessionToken = "s3.session-token";
  static constexpr std::string_view kSessionTokenExpiresAtMs =
      "s3.session-token-expires-at-ms";
  static constexpr std::string_view kClientRegion = "client.region";
  static constexpr std::string_view kEndpoint = "s3.endpoint";
  static constexpr std::string_view kPathStyleAccess = "s3.path-style-access";
  static constexpr std::string_view kSslEnabled = "s3.ssl.enabled";
  static constexpr std::string_view kConnectTimeoutMs = "s3.connect-timeout-ms";
  static constexpr std::string_view kSocketTimeoutMs = "s3.socket-timeout-ms";
  static constexpr std::string_view kDeleteNumThreads = "s3.delete.num-threads";
};
 
inline constexpr std::array<std::string_view, 4> kS3Schemes = {"s3", "s3a", "s3n", "oss"};
 
inline constexpr bool EqualsIgnoreAsciiCase(std::string_view left,
                                            std::string_view right) {
  constexpr auto lower = [](char c) {
    return (c >= 'A' && c <= 'Z') ? static_cast<char>(c - 'A' + 'a') : c;
  };
  return std::ranges::equal(left, right,
                            [&](char a, char b) { return lower(a) == lower(b); });
}
 
inline constexpr bool IsS3Scheme(std::string_view scheme) {
  return std::ranges::any_of(kS3Schemes, [scheme](std::string_view alias) {
    return EqualsIgnoreAsciiCase(scheme, alias);
  });
}
 
inline constexpr bool IsS3CredentialPrefix(std::string_view prefix) {
  if (prefix == S3Properties::kS3Schema) {
    return true;
  }
  const auto delimiter = prefix.find("://");
  return delimiter != std::string_view::npos && IsS3Scheme(prefix.substr(0, delimiter));
}
 
}  // namespace iceberg::arrow