ForeignTable.cpp

Go to the documentation of this file.

/*
 * Copyright 2022 HEAVY.AI, Inc.
 *
 * Licensed 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.
 */

#include "ForeignTable.h"

#include <regex>

#include "DataMgr/ForeignStorage/ForeignDataWrapperFactory.h"
#include "RefreshTimeCalculator.h"
#include "Shared/DateTimeParser.h"
#include "Shared/misc.h"

bool g_enable_seconds_refresh{false};

namespace foreign_storage {
ForeignTable::ForeignTable()
    : OptionsContainer({{foreign_storage::ForeignTable::REFRESH_TIMING_TYPE_KEY,
                         foreign_storage::ForeignTable::MANUAL_REFRESH_TIMING_TYPE},
                        {foreign_storage::ForeignTable::REFRESH_UPDATE_TYPE_KEY,
                         foreign_storage::ForeignTable::ALL_REFRESH_UPDATE_TYPE}}) {}

void ForeignTable::validateOptionValues() const {
  validateRefreshOptionValues();
  validateDataWrapperOptions();
}

bool ForeignTable::isAppendMode() const {
  auto update_mode = options.find(REFRESH_UPDATE_TYPE_KEY);
  return (update_mode != options.end() &&
          update_mode->second == APPEND_REFRESH_UPDATE_TYPE);
}

void ForeignTable::initializeOptions() {
  OptionsMap options_map;
  populateOptionsMap(std::move(options_map));
  validateOptionValues();
}

void ForeignTable::initializeOptions(const rapidjson::Value& options) {
  // Create the options map first because the json version is not guaranteed to be
  // upper-case, which we need to compare reliably with alterable_options.
  auto options_map = createOptionsMap(options);
  validateSupportedOptionKeys(options_map);
  populateOptionsMap(std::move(options_map));
  validateOptionValues();
}

// This function can't be static because it needs to know the data wrapper type.
void ForeignTable::validateSupportedOptionKeys(const OptionsMap& options_map) const {
  const auto& data_wrapper_options =
      foreign_storage::ForeignDataWrapperFactory::createForValidation(
          foreign_server->data_wrapper_type, this)
          ->getSupportedTableOptions();
  for (const auto& [key, value] : options_map) {
    if (!shared::contains(supported_options, key) &&
        !shared::contains(data_wrapper_options, key)) {
      throw std::runtime_error{"Invalid foreign table option \"" + key + "\"."};
    }
  }
}

void ForeignTable::validateRefreshOptionValues() const {
  auto update_type_entry =
      options.find(foreign_storage::ForeignTable::REFRESH_UPDATE_TYPE_KEY);
  CHECK(update_type_entry != options.end());
  auto update_type_value = update_type_entry->second;
  if (update_type_value != ALL_REFRESH_UPDATE_TYPE &&
      update_type_value != APPEND_REFRESH_UPDATE_TYPE) {
    std::string error_message =
        "Invalid value \"" + update_type_value + "\" for " + REFRESH_UPDATE_TYPE_KEY +
        " option." + " Value must be \"" + std::string{APPEND_REFRESH_UPDATE_TYPE} +
        "\" or \"" + std::string{ALL_REFRESH_UPDATE_TYPE} + "\".";
    throw std::runtime_error{error_message};
  }

  auto refresh_timing_entry =
      options.find(foreign_storage::ForeignTable::REFRESH_TIMING_TYPE_KEY);
  CHECK(refresh_timing_entry != options.end());
  if (auto refresh_timing_value = refresh_timing_entry->second;
      refresh_timing_value == SCHEDULE_REFRESH_TIMING_TYPE) {
    auto start_date_entry = options.find(REFRESH_START_DATE_TIME_KEY);
    if (start_date_entry == options.end()) {
      throw std::runtime_error{std::string{REFRESH_START_DATE_TIME_KEY} +
                               " option must be provided for scheduled refreshes."};
    }
    auto start_date_time = dateTimeParse<kTIMESTAMP>(start_date_entry->second, 0);
    int64_t current_time = RefreshTimeCalculator::getCurrentTime();
    if (start_date_time < current_time) {
      throw std::runtime_error{std::string{REFRESH_START_DATE_TIME_KEY} +
                               " cannot be a past date time."};
    }

    auto interval_entry = options.find(REFRESH_INTERVAL_KEY);
    if (interval_entry != options.end()) {
      std::string interval_types{"HD"};
      if (g_enable_seconds_refresh) {
        interval_types += "S";
      }
      boost::regex interval_regex{"^\\d{1,}[" + interval_types + "]$",
                                  boost::regex::extended | boost::regex::icase};
      if (!boost::regex_match(interval_entry->second, interval_regex)) {
        throw std::runtime_error{"Invalid value provided for the " +
                                 std::string{REFRESH_INTERVAL_KEY} + " option."};
      }
    }
  } else if (refresh_timing_value != MANUAL_REFRESH_TIMING_TYPE) {
    throw std::runtime_error{"Invalid value provided for the " +
                             std::string{REFRESH_TIMING_TYPE_KEY} +
                             " option. Value must be \"" + MANUAL_REFRESH_TIMING_TYPE +
                             "\" or \"" + SCHEDULE_REFRESH_TIMING_TYPE + "\"."};
  }
}

void ForeignTable::validateDataWrapperOptions() const {
  foreign_storage::ForeignDataWrapperFactory::createForValidation(
      foreign_server->data_wrapper_type, this)
      ->validateTableOptions(this);
}

OptionsMap ForeignTable::createOptionsMap(const rapidjson::Value& json_options) {
  OptionsMap options_map;
  CHECK(json_options.IsObject());
  for (auto itr = json_options.MemberBegin(); itr != json_options.MemberEnd(); ++itr) {
    auto key = to_upper(itr->name.GetString());
    if (std::find(upper_case_options.begin(), upper_case_options.end(), key) !=
        upper_case_options.end()) {
      options_map[key] = to_upper(itr->value.GetString());
    } else {
      options_map[key] = itr->value.GetString();
    }
  }
  return options_map;
}

void ForeignTable::validateAlterOptions(const OptionsMap& options_map) const {
  const auto& data_wrapper_options =
      foreign_storage::ForeignDataWrapperFactory::createForValidation(
          foreign_server->data_wrapper_type, this)
          ->getAlterableTableOptions();

  for (const auto& [key, value] : options_map) {
    if (!shared::contains(alterable_options, key) &&
        !shared::contains(data_wrapper_options, key)) {
      throw std::runtime_error{std::string("Altering foreign table option \"") + key +
                               "\" is not currently supported."};
    }
  }
}

void ForeignTable::validateSchema(const std::list<ColumnDescriptor>& columns) const {
  foreign_storage::ForeignDataWrapperFactory::createForValidation(
      foreign_server->data_wrapper_type, this)
      ->validateSchema(columns);
}

}  // namespace foreign_storage