AbstractFileStorageDataWrapper.h

Go to the documentation of this file.

#pragma once

#include "ForeignDataWrapper.h"

#include "Shared/file_path_util.h"

namespace foreign_storage {

size_t get_num_threads(const ForeignTable& table);

class AbstractFileStorageDataWrapper : public ForeignDataWrapper {
 public:
  AbstractFileStorageDataWrapper();

  void validateServerOptions(const ForeignServer* foreign_server) const override;

  void validateTableOptions(const ForeignTable* foreign_table) const override;

  const std::set<std::string_view>& getSupportedTableOptions() const override;

  void validateUserMappingOptions(const UserMapping* user_mapping,
                                  const ForeignServer* foreign_server) const override;

  const std::set<std::string_view>& getSupportedUserMappingOptions() const override;

  const std::set<std::string> getAlterableTableOptions() const override;

  static shared::FilePathOptions getFilePathOptions(const ForeignTable* foreign_table);

  inline static const std::string STORAGE_TYPE_KEY = "STORAGE_TYPE";
  inline static const std::string BASE_PATH_KEY = "BASE_PATH";
  inline static const std::string FILE_PATH_KEY = "FILE_PATH";
  inline static const std::string REGEX_PATH_FILTER_KEY = "REGEX_PATH_FILTER";
  inline static const std::string LOCAL_FILE_STORAGE_TYPE = "LOCAL_FILE";
  inline static const std::string S3_STORAGE_TYPE = "AWS_S3";
  inline static const std::string FILE_SORT_ORDER_BY_KEY = shared::FILE_SORT_ORDER_BY_KEY;
  inline static const std::string FILE_SORT_REGEX_KEY = shared::FILE_SORT_REGEX_KEY;
  inline static const std::string ALLOW_FILE_ROLL_OFF_KEY = "ALLOW_FILE_ROLL_OFF";
  inline static const std::string THREADS_KEY = "THREADS";

  inline static const std::array<std::string, 1> supported_storage_types{
      LOCAL_FILE_STORAGE_TYPE};

 protected:
  static std::string getFullFilePath(const ForeignTable* foreign_table);

  static bool allowFileRollOff(const ForeignTable* foreign_table);

 private:
  static void validateFilePath(const ForeignTable* foreign_table);

  // A valid path is a concatenation of the file_path and the base_path (for local
  // storage). One of the two must be present.
  static void validateFilePathOptionKey(const ForeignTable* foreign_table);

  static void validateFileRollOffOption(const ForeignTable* foreign_table);

  static const std::set<std::string_view> supported_table_options_;
  static const std::set<std::string_view> supported_server_options_;
  static const std::set<std::string_view> supported_user_mapping_options_;
};
}  // namespace foreign_storage