iceberg-cpp
Loading...
Searching...
No Matches
rest_file_io.h
1/*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19
20#pragma once
21
22#include <cstdint>
23#include <memory>
24#include <string_view>
25#include <unordered_map>
26#include <vector>
27
29#include "iceberg/catalog/rest/iceberg_rest_export.h"
31#include "iceberg/file_io.h"
32#include "iceberg/file_io_registry.h"
33#include "iceberg/result.h"
34
35namespace iceberg::rest {
36
37enum class BuiltinFileIOKind : uint8_t {
38 kArrowLocal,
39 kArrowS3,
40};
41
42ICEBERG_REST_EXPORT Result<BuiltinFileIOKind> DetectBuiltinFileIO(
43 std::string_view location);
44
45ICEBERG_REST_EXPORT std::string_view BuiltinFileIOName(BuiltinFileIOKind kind);
46
47ICEBERG_REST_EXPORT Result<std::unique_ptr<FileIO>> MakeCatalogFileIO(
48 const RestCatalogProperties& config);
49
51ICEBERG_REST_EXPORT Result<std::unique_ptr<FileIO>> MakeTableFileIO(
52 const std::unordered_map<std::string, std::string>& catalog_config,
53 const std::unordered_map<std::string, std::string>& table_config,
54 const std::vector<StorageCredential>& storage_credentials);
55
56} // namespace iceberg::rest
RestCatalogProperties implementation for Iceberg REST API.