foreign_storage::OptionsContainer Struct Reference

#include <OptionsContainer.h>

Inheritance diagram for foreign_storage::OptionsContainer:

Public Member Functions
	OptionsContainer ()
	OptionsContainer (const OptionsMap &options)
	OptionsContainer (const std::string &options_str)
void	populateOptionsMap (OptionsMap &&options_map, bool clear=false)
void	populateOptionsMap (const rapidjson::Value &ddl_options, bool clear=false)
void	populateOptionsMap (const std::string &options_json, bool clear=false)
std::string	getOptionsAsJsonString () const
std::optional< std::string >	getOption (const std::string_view &key) const
bool	getOptionAsBool (const std::string_view &key) const

Public Attributes
OptionsMap	options

Detailed Description

Definition at line 31 of file OptionsContainer.h.

Constructor & Destructor Documentation

foreign_storage::OptionsContainer::OptionsContainer ( )

inline

Definition at line 34 of file OptionsContainer.h.

{}

foreign_storage::OptionsContainer::OptionsContainer ( const OptionsMap &  options )

inline

Definition at line 36 of file OptionsContainer.h.

: options(options) {}

foreign_storage::OptionsContainer::OptionsContainer ( const std::string &  options_str )

inline

Definition at line 38 of file OptionsContainer.h.

References populateOptionsMap().

{ populateOptionsMap(options_str); }

Here is the call graph for this function:

Member Function Documentation

std::optional<std::string> foreign_storage::OptionsContainer::getOption ( const std::string_view &  key ) const

inline

Definition at line 87 of file OptionsContainer.h.

References options.

Referenced by foreign_storage::AbstractFileStorageDataWrapper::allowFileRollOff(), foreign_storage::anonymous_namespace{AbstractFileStorageDataWrapper.cpp}::get_file_roll_off_value(), foreign_storage::get_num_threads(), foreign_storage::AbstractFileStorageDataWrapper::getFilePathOptions(), foreign_storage::AbstractFileStorageDataWrapper::getFullFilePath(), getOptionAsBool(), and foreign_storage::AbstractFileStorageDataWrapper::validateFilePathOptionKey().

                                                                    {
    if (auto it = options.find(key); it != options.end()) {
      return it->second;
    } else {
      return {};
    }
  }

Here is the caller graph for this function:

bool foreign_storage::OptionsContainer::getOptionAsBool ( const std::string_view &  key ) const

inline

Definition at line 95 of file OptionsContainer.h.

References getOption().

Referenced by foreign_storage::LazyParquetChunkLoader::appendRowGroups(), foreign_storage::LazyParquetChunkLoader::loadRowGroups(), and foreign_storage::LazyParquetChunkLoader::metadataScan().

                                                        {
    auto option = getOption(key);
    return option.has_value() && option.value() == "TRUE";
  }

Here is the call graph for this function:

Here is the caller graph for this function:

std::string foreign_storage::OptionsContainer::getOptionsAsJsonString ( ) const

inline

Definition at line 69 of file OptionsContainer.h.

References options.

Referenced by AlterForeignServerCommand::setForeignServerOptions().

                                           {
    rapidjson::Document document;
    document.SetObject();

    for (const auto& [key, value] : options) {
      document.AddMember(rapidjson::Value().SetString(
                             key.c_str(), key.length(), document.GetAllocator()),
                         rapidjson::Value().SetString(
                             value.c_str(), value.length(), document.GetAllocator()),
                         document.GetAllocator());
    }

    rapidjson::StringBuffer buffer;
    rapidjson::Writer<rapidjson::StringBuffer> writer(buffer);
    document.Accept(writer);
    return buffer.GetString();
  }

Here is the caller graph for this function:

void foreign_storage::OptionsContainer::populateOptionsMap ( OptionsMap &&  options_map, bool  clear = false  )

inline

Definition at line 40 of file OptionsContainer.h.

References options.

Referenced by RefreshForeignTablesCommand::execute(), OptionsContainer(), populateOptionsMap(), Catalog_Namespace::Catalog::reloadForeignTableUnlocked(), AlterForeignServerCommand::setForeignServerOptions(), and Catalog_Namespace::Catalog::setForeignServerOptions().

                                                                        {
    if (clear) {
      options = options_map;
    } else {
      // The merge order here is to make sure we overwrite duplicates in options.  If we
      // used options.merge(options_map) we would preserve existing entries.
      options_map.merge(options);
      options = options_map;
    }
  }

Here is the caller graph for this function:

void foreign_storage::OptionsContainer::populateOptionsMap ( const rapidjson::Value &  ddl_options, bool  clear = false  )

inline

Definition at line 51 of file OptionsContainer.h.

References CHECK, options, and to_upper().

                                                                                 {
    CHECK(ddl_options.IsObject());
    if (clear) {
      options.clear();
    }
    for (auto itr = ddl_options.MemberBegin(); itr != ddl_options.MemberEnd(); ++itr) {
      std::string key = to_upper(itr->name.GetString());
      options[key] = itr->value.GetString();
    }
  }

Here is the call graph for this function:

void foreign_storage::OptionsContainer::populateOptionsMap ( const std::string &  options_json, bool  clear = false  )

inline

Definition at line 62 of file OptionsContainer.h.

References CHECK, options, and populateOptionsMap().

                                                                             {
    CHECK(!options_json.empty());
    rapidjson::Document options;
    options.Parse(options_json);
    populateOptionsMap(options);
  }

Here is the call graph for this function:

Member Data Documentation

OptionsMap foreign_storage::OptionsContainer::options

Definition at line 32 of file OptionsContainer.h.

Referenced by foreign_storage::ForeignDataWrapperFactory::createForeignTableProxy(), RefreshForeignTablesCommand::execute(), foreign_storage::anonymous_namespace{RegexFileBufferParser.cpp}::get_line_regex(), foreign_storage::anonymous_namespace{RegexFileBufferParser.cpp}::get_line_start_regex(), Catalog_Namespace::anonymous_namespace{Catalog.cpp}::get_next_refresh_time(), foreign_storage::ParquetDataWrapper::getAllFilePaths(), getOption(), getOptionsAsJsonString(), foreign_storage::AbstractTextFileDataWrapper::iterativeFileScan(), foreign_storage::ParquetDataWrapper::ParquetDataWrapper(), foreign_storage::ParquetImporter::ParquetImporter(), foreign_storage::AbstractTextFileDataWrapper::populateChunkMetadata(), foreign_storage::AbstractTextFileDataWrapper::populateChunks(), populateOptionsMap(), Catalog_Namespace::Catalog::recreateSystemTableIfUpdated(), foreign_storage::AbstractTextFileDataWrapper::restoreDataWrapperInternals(), Catalog_Namespace::anonymous_namespace{Catalog.cpp}::set_common_db_log_system_table_options(), Catalog_Namespace::anonymous_namespace{Catalog.cpp}::set_common_log_system_table_options(), Catalog_Namespace::Catalog::setForeignServerOptions(), foreign_storage::Csv::anonymous_namespace{CsvShared.cpp}::validate_and_get_bool_value(), foreign_storage::anonymous_namespace{CsvFileBufferParser.cpp}::validate_and_get_bool_value(), foreign_storage::anonymous_namespace{RegexFileBufferParser.cpp}::validate_and_get_bool_value(), foreign_storage::Csv::validate_and_get_copy_params(), foreign_storage::Csv::anonymous_namespace{CsvShared.cpp}::validate_and_get_delimiter(), foreign_storage::anonymous_namespace{CsvFileBufferParser.cpp}::validate_and_get_delimiter(), foreign_storage::Csv::validate_and_get_is_s3_select(), foreign_storage::Csv::anonymous_namespace{CsvShared.cpp}::validate_and_get_string_with_length(), foreign_storage::anonymous_namespace{CsvFileBufferParser.cpp}::validate_and_get_string_with_length(), foreign_storage::CsvFileBufferParser::validateAndGetCopyParams(), foreign_storage::RegexFileBufferParser::validateAndGetCopyParams(), foreign_storage::CsvDataWrapper::validateAndGetIsS3Select(), foreign_storage::AbstractFileStorageDataWrapper::validateFilePath(), foreign_storage::AbstractFileStorageDataWrapper::validateServerOptions(), foreign_storage::InternalSystemDataWrapper::validateServerOptions(), and foreign_storage::RegexParserDataWrapper::validateTableOptions().

---

The documentation for this struct was generated from the following file:

• /home/jenkins-slave/workspace/core-os-doxygen/Catalog/OptionsContainer.h