rest_table_scan.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 <functional>
#include <memory>
#include <optional>
#include <string>
#include <unordered_map>
#include <unordered_set>
#include <vector>
 
#include "iceberg/catalog/rest/endpoint.h"
#include "iceberg/catalog/rest/iceberg_rest_export.h"
#include "iceberg/catalog/rest/type_fwd.h"
#include "iceberg/data_table_scan.h"
#include "iceberg/incremental_append_scan.h"
#include "iceberg/result.h"
#include "iceberg/table_identifier.h"
#include "iceberg/table_scan.h"
#include "iceberg/type_fwd.h"
 
 
namespace iceberg::rest {
 
struct ICEBERG_REST_EXPORT RestScanContext {
  std::shared_ptr<HttpClient> client;
  std::shared_ptr<ResourcePaths> paths;
  std::shared_ptr<auth::AuthSession> session;
  std::unordered_set<Endpoint> supported_endpoints;
  TableIdentifier identifier;
  std::unordered_map<std::string, std::string> catalog_config;
  std::unordered_map<std::string, std::string> table_config;
  std::function<Result<std::shared_ptr<StorageCredentialProvider>>(
      const std::string& plan_id)>
      credential_provider_factory;
};
 
class ICEBERG_REST_EXPORT RestTableScan : public DataTableScan {
 public:
  ~RestTableScan() override = default;
 
  static Result<std::unique_ptr<DataTableScan>> Make(
      std::shared_ptr<TableMetadata> metadata, std::shared_ptr<Schema> schema,
      std::shared_ptr<FileIO> io, internal::TableScanContext context,
      std::shared_ptr<const RestScanContext> rest_context);
 
  Result<FileScanTaskStreamPtr> PlanFilesStream() const override;
 
  const std::shared_ptr<FileIO>& io() const override;
 
 private:
  RestTableScan(std::shared_ptr<TableMetadata> metadata, std::shared_ptr<Schema> schema,
                std::shared_ptr<FileIO> io, internal::TableScanContext context,
                std::shared_ptr<const RestScanContext> rest_context);
 
  std::shared_ptr<const RestScanContext> rest_context_;
  mutable std::shared_ptr<FileIO> scan_io_;
};
 
class ICEBERG_REST_EXPORT RestTableScanBuilder : public DataTableScanBuilder {
 public:
  RestTableScanBuilder(std::shared_ptr<TableMetadata> metadata,
                       std::shared_ptr<FileIO> io, std::string table_name,
                       std::shared_ptr<MetricsReporter> metrics_reporter,
                       std::shared_ptr<const RestScanContext> rest_context);
 
  Result<std::unique_ptr<DataTableScan>> Build() override;
 
 private:
  std::shared_ptr<const RestScanContext> rest_context_;
};
 
class ICEBERG_REST_EXPORT RestIncrementalAppendScan : public IncrementalAppendScan {
 public:
  ~RestIncrementalAppendScan() override = default;
 
  static Result<std::unique_ptr<IncrementalAppendScan>> Make(
      std::shared_ptr<TableMetadata> metadata, std::shared_ptr<Schema> schema,
      std::shared_ptr<FileIO> io, internal::TableScanContext context,
      std::shared_ptr<const RestScanContext> rest_context);
 
  using IncrementalAppendScan::PlanFiles;
 
  const std::shared_ptr<FileIO>& io() const override;
 
 protected:
  Result<std::vector<std::shared_ptr<FileScanTask>>> PlanFiles(
      std::optional<int64_t> from_snapshot_id_exclusive,
      int64_t to_snapshot_id_inclusive) const override;
 
 private:
  RestIncrementalAppendScan(std::shared_ptr<TableMetadata> metadata,
                            std::shared_ptr<Schema> schema, std::shared_ptr<FileIO> io,
                            internal::TableScanContext context,
                            std::shared_ptr<const RestScanContext> rest_context);
 
  std::shared_ptr<const RestScanContext> rest_context_;
  mutable std::shared_ptr<FileIO> scan_io_;
};
 
class ICEBERG_REST_EXPORT RestIncrementalAppendScanBuilder
    : public IncrementalAppendScanBuilder {
 public:
  RestIncrementalAppendScanBuilder(std::shared_ptr<TableMetadata> metadata,
                                   std::shared_ptr<FileIO> io, std::string table_name,
                                   std::shared_ptr<MetricsReporter> metrics_reporter,
                                   std::shared_ptr<const RestScanContext> rest_context);
 
  Result<std::unique_ptr<IncrementalAppendScan>> Build() override;
 
 private:
  std::shared_ptr<const RestScanContext> rest_context_;
};
 
}  // namespace iceberg::rest