Parser::DumpRestoreTableStmtBase Class Reference

#include <ParserNode.h>

Inheritance diagram for Parser::DumpRestoreTableStmtBase:

Collaboration diagram for Parser::DumpRestoreTableStmtBase:

Public Types
enum	CompressionType { CompressionType::kGZIP, CompressionType::kLZ4, CompressionType::kNONE }

Public Member Functions
	DumpRestoreTableStmtBase (const rapidjson::Value &payload, const bool is_restore)
CompressionType	defaultCompression (bool is_restore)
CompressionType	validateCompression (const std::string &compression, const bool is_restore)
std::string	tarCompressionStr (CompressionType compression, const bool is_restore)
const std::string *	getTable () const
const std::string *	getPath () const
const CompressionType	getCompression () const
Public Member Functions inherited from Parser::DDLStmt
virtual void	execute (const Catalog_Namespace::SessionInfo &session, bool read_only_mode)=0
void	setColumnDescriptor (ColumnDescriptor &cd, const ColumnDef *coldef)
Public Member Functions inherited from Parser::Node
virtual	~Node ()

Protected Attributes
std::unique_ptr< std::string >	table_
std::unique_ptr< std::string >	path_
CompressionType	compression_
TableArchiverS3Options	s3_options_

Detailed Description

Definition at line 1411 of file ParserNode.h.

Member Enumeration Documentation

enum Parser::DumpRestoreTableStmtBase::CompressionType

strong

Enumerator
kGZIP
kLZ4
kNONE

Definition at line 1415 of file ParserNode.h.

{ kGZIP, kLZ4, kNONE };

Constructor & Destructor Documentation

Parser::DumpRestoreTableStmtBase::DumpRestoreTableStmtBase	(	const rapidjson::Value &	payload,
		const bool	is_restore
	)

Definition at line 7101 of file ParserNode.cpp.

References CHECK, compression_, defaultCompression(), Parser::anonymous_namespace{ParserNode.cpp}::get_string_option(), json_str(), Parser::anonymous_namespace{ParserNode.cpp}::parse_options(), path_, TableArchiverS3Options::s3_access_key, TableArchiverS3Options::s3_endpoint, s3_options_, TableArchiverS3Options::s3_region, TableArchiverS3Options::s3_secret_key, TableArchiverS3Options::s3_session_token, table_, and validateCompression().

                                                                          {
  CHECK(payload.HasMember("tableName"));
  table_ = std::make_unique<std::string>(json_str(payload["tableName"]));

  CHECK(payload.HasMember("filePath"));
  path_ = std::make_unique<std::string>(json_str(payload["filePath"]));

  compression_ = defaultCompression(is_restore);

  std::list<std::unique_ptr<NameValueAssign>> options;
  parse_options(payload, options);

  if (!options.empty()) {
    for (const auto& option : options) {
      if (auto compression = get_string_option(option.get(), "compression");
          compression.has_value()) {
        compression_ = validateCompression(compression.value(), is_restore);
#ifdef HAVE_AWS_S3
      } else if (auto s3_access_key = get_string_option(option.get(), "s3_access_key");
                 s3_access_key.has_value()) {
        s3_options_.s3_access_key = s3_access_key.value();
      } else if (auto s3_secret_key = get_string_option(option.get(), "s3_secret_key");
                 s3_secret_key.has_value()) {
        s3_options_.s3_secret_key = s3_secret_key.value();
      } else if (auto s3_session_token =
                     get_string_option(option.get(), "s3_session_token");
                 s3_session_token.has_value()) {
        s3_options_.s3_session_token = s3_session_token.value();
      } else if (auto s3_region = get_string_option(option.get(), "s3_region");
                 s3_region.has_value()) {
        s3_options_.s3_region = s3_region.value();
      } else if (auto s3_endpoint = get_string_option(option.get(), "s3_endpoint");
                 s3_endpoint.has_value()) {
        s3_options_.s3_endpoint = s3_endpoint.value();
#endif
      } else {
        throw std::runtime_error("Invalid WITH option: " + *option->get_name());
      }
    }
  }

  for (const auto& program : {"tar", "rm", "mkdir", "mv", "cat"}) {
    if (boost::process::search_path(program).empty()) {
      throw std::runtime_error{"Required program \"" + std::string{program} +
                               "\" was not found."};
    }
  }
}

Here is the call graph for this function:

Member Function Documentation

DumpRestoreTableStmtBase::CompressionType Parser::DumpRestoreTableStmtBase::defaultCompression

(

bool

is_restore

)

Definition at line 7152 of file ParserNode.cpp.

References kGZIP, kLZ4, kNONE, Parser::Compress::sGZIP, Parser::Compress::sLZ4, Parser::Compress::sUNGZIP, and Parser::Compress::sUNLZ4.

Referenced by DumpRestoreTableStmtBase().

                           {
  if (boost::process::search_path(is_restore ? Compress::sUNGZIP : Compress::sGZIP)
          .string()
          .size()) {
    return CompressionType::kGZIP;
  } else if (boost::process::search_path(is_restore ? Compress::sUNLZ4 : Compress::sLZ4)
                 .string()
                 .size()) {
    return CompressionType::kLZ4;
  }
  return CompressionType::kNONE;
}

Here is the caller graph for this function:

const CompressionType Parser::DumpRestoreTableStmtBase::getCompression ( ) const

inline

Definition at line 1429 of file ParserNode.h.

References compression_.

{ return compression_; }

const std::string* Parser::DumpRestoreTableStmtBase::getPath ( ) const

inline

Definition at line 1428 of file ParserNode.h.

References path_.

{ return path_.get(); }

const std::string* Parser::DumpRestoreTableStmtBase::getTable ( ) const

inline

Definition at line 1427 of file ParserNode.h.

References table_.

{ return table_.get(); }

std::string Parser::DumpRestoreTableStmtBase::tarCompressionStr	(	CompressionType	compression,
		const bool	is_restore
	)

Definition at line 7197 of file ParserNode.cpp.

References kGZIP, kLZ4, Parser::Compress::sGZIP, Parser::Compress::sLZ4, Parser::Compress::sUNGZIP, and Parser::Compress::sUNLZ4.

Referenced by Parser::DumpTableStmt::execute(), and Parser::RestoreTableStmt::execute().

                                                                               {
  if (compression_type == CompressionType::kGZIP) {
    return "--use-compress-program=" + (is_restore ? Compress::sUNGZIP : Compress::sGZIP);
  } else if (compression_type == CompressionType::kLZ4) {
    return "--use-compress-program=" + (is_restore ? Compress::sUNLZ4 : Compress::sLZ4);
  }
  // kNONE uses "none' as a user input, but an empty string "" for tar
  return "";
}

Here is the caller graph for this function:

DumpRestoreTableStmtBase::CompressionType Parser::DumpRestoreTableStmtBase::validateCompression	(	const std::string &	compression,
		const bool	is_restore
	)

Definition at line 7166 of file ParserNode.cpp.

References kGZIP, kLZ4, kNONE, Parser::Compress::sGZIP, Parser::Compress::sLZ4, Parser::Compress::sNONE, Parser::Compress::sUNGZIP, and Parser::Compress::sUNLZ4.

Referenced by DumpRestoreTableStmtBase().

                           {
  // only allow ('gzip', 'lz4', 'none') compression types
  const std::string compression = boost::algorithm::to_lower_copy(compression_type);

  // verify correct compression executable is available
  if (boost::iequals(compression, Compress::sGZIP)) {
    const auto prog_name = is_restore ? Compress::sUNGZIP : Compress::sGZIP;
    const auto prog_path = boost::process::search_path(prog_name);
    if (prog_path.string().empty()) {
      throw std::runtime_error("Compression program " + prog_name + " is not found.");
    }
    return CompressionType::kGZIP;

  } else if (boost::iequals(compression, Compress::sLZ4)) {
    const auto prog_name = is_restore ? Compress::sUNLZ4 : Compress::sLZ4;
    const auto prog_path = boost::process::search_path(prog_name);
    if (prog_path.string().empty()) {
      throw std::runtime_error("Compression program " + prog_name + " is not found.");
    }
    return CompressionType::kLZ4;

  } else if (!boost::iequals(compression, Compress::sNONE)) {
    throw std::runtime_error("Compression program " + compression + " is not supported.");
  }

  return CompressionType::kNONE;
}

Here is the caller graph for this function:

Member Data Documentation

CompressionType Parser::DumpRestoreTableStmtBase::compression_

protected

Definition at line 1434 of file ParserNode.h.

Referenced by DumpRestoreTableStmtBase(), Parser::DumpTableStmt::execute(), Parser::RestoreTableStmt::execute(), and getCompression().

std::unique_ptr<std::string> Parser::DumpRestoreTableStmtBase::path_

protected

Definition at line 1433 of file ParserNode.h.

Referenced by DumpRestoreTableStmtBase(), Parser::DumpTableStmt::execute(), Parser::RestoreTableStmt::execute(), and getPath().

TableArchiverS3Options Parser::DumpRestoreTableStmtBase::s3_options_

protected

Definition at line 1435 of file ParserNode.h.

Referenced by DumpRestoreTableStmtBase(), and Parser::RestoreTableStmt::execute().

std::unique_ptr<std::string> Parser::DumpRestoreTableStmtBase::table_

protected

Definition at line 1432 of file ParserNode.h.

Referenced by DumpRestoreTableStmtBase(), Parser::DumpTableStmt::execute(), Parser::RestoreTableStmt::execute(), and getTable().

---

The documentation for this class was generated from the following files:

• /home/jenkins-slave/workspace/core-os-doxygen/Parser/ParserNode.h
• /home/jenkins-slave/workspace/core-os-doxygen/Parser/ParserNode.cpp