file_io_registry.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 <functional>
#include <memory>
#include <string>
#include <string_view>
#include <unordered_map>
 
#include "iceberg/file_io.h"
#include "iceberg/iceberg_export.h"
#include "iceberg/result.h"
 
namespace iceberg {
 
class ICEBERG_EXPORT FileIORegistry {
 public:
  static constexpr std::string_view kArrowLocalFileIO = "arrow-fs-local";
  static constexpr std::string_view kArrowS3FileIO = "arrow-fs-s3";
 
  using Properties = std::unordered_map<std::string, std::string>;
 
  struct Factory {
    using CreateFunction =
        std::function<Result<std::unique_ptr<FileIO>>(const Properties& properties)>;
    using AcceptsFunction = std::function<bool(std::string_view scheme)>;
 
    CreateFunction create;
    AcceptsFunction accepts;
  };
 
  static void Register(std::string name, Factory factory);
 
  static Result<std::unique_ptr<FileIO>> Load(std::string_view name,
                                              const Properties& properties);
 
  static Result<std::string> Resolve(std::string_view scheme);
};
 
}  // namespace iceberg