OmniSciDB  06b3bd477c
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
TableArchiver Class Reference

#include <TableArchiver.h>

+ Collaboration diagram for TableArchiver:

Public Member Functions

 TableArchiver (Catalog_Namespace::Catalog *cat)
 
void dumpTable (const TableDescriptor *td, const std::string &archive_path, const std::string &compression)
 
void restoreTable (const Catalog_Namespace::SessionInfo &session, const TableDescriptor *td, const std::string &archive_path, const std::string &compression)
 
void restoreTable (const Catalog_Namespace::SessionInfo &session, const std::string &table_name, const std::string &archive_path, const std::string &compression)
 

Private Attributes

Catalog_Namespace::Catalogcat_
 

Detailed Description

Definition at line 24 of file TableArchiver.h.

Constructor & Destructor Documentation

TableArchiver::TableArchiver ( Catalog_Namespace::Catalog cat)
inline

Definition at line 26 of file TableArchiver.h.

26 : cat_(cat){};
Catalog_Namespace::Catalog * cat_
Definition: TableArchiver.h:43

Member Function Documentation

void TableArchiver::dumpTable ( const TableDescriptor td,
const std::string &  archive_path,
const std::string &  compression 
)

Definition at line 240 of file TableArchiver.cpp.

References anonymous_namespace{TableArchiver.cpp}::abs_path(), cat_, Catalog_Namespace::DBMetadata::dbId, Data_Namespace::DISK_LEVEL, Catalog_Namespace::Catalog::dumpSchema(), filename_security_check(), g_cluster, get_quoted_string(), Catalog_Namespace::Catalog::getAllColumnMetadataForTable(), Catalog_Namespace::Catalog::getColumnDictDirectory(), Catalog_Namespace::Catalog::getCurrentDB(), Catalog_Namespace::Catalog::getDataMgr(), Data_Namespace::DataMgr::getGlobalFileMgr(), lockmgr::TableLockMgrImpl< TableSchemaLockMgr >::getReadLockForTable(), Catalog_Namespace::Catalog::getTableDataDirectories(), Catalog_Namespace::Catalog::getTableDictDirectories(), Catalog_Namespace::Catalog::getTableEpoch(), TableDescriptor::isView, join(), TableDescriptor::persistenceLevel, run, anonymous_namespace{TableArchiver.cpp}::simple_file_closer, table_epoch_filename, table_oldinfo_filename, table_schema_filename, TableDescriptor::tableId, TableDescriptor::tableName, and to_string().

Referenced by Parser::DumpTableStmt::execute().

242  {
243  filename_security_check(archive_path);
244  if (g_cluster) {
245  throw std::runtime_error("DUMP/RESTORE is not supported yet on distributed setup.");
246  }
247  if (boost::filesystem::exists(archive_path)) {
248  throw std::runtime_error("Archive " + archive_path + " already exists.");
249  }
251  throw std::runtime_error("Dumping view or temporary table is not supported.");
252  }
253  // collect paths of files to archive
254  const auto global_file_mgr = cat_->getDataMgr().getGlobalFileMgr();
255  std::vector<std::string> file_paths;
256  auto file_writer = [&file_paths, global_file_mgr](const std::string& file_name,
257  const std::string& file_type,
258  const std::string& file_data) {
259  const auto file_path = abs_path(global_file_mgr) + "/" + file_name;
260  std::unique_ptr<FILE, decltype(simple_file_closer)> fp(
261  std::fopen(file_path.c_str(), "w"), simple_file_closer);
262  if (!fp) {
263  throw std::runtime_error("Failed to create " + file_type + " file '" + file_path +
264  "': " + std::strerror(errno));
265  }
266  if (std::fwrite(file_data.data(), 1, file_data.size(), fp.get()) < file_data.size()) {
267  throw std::runtime_error("Failed to write " + file_type + " file '" + file_path +
268  "': " + std::strerror(errno));
269  }
270  file_paths.push_back(file_name);
271  };
272  // Prevent modification of the table schema during a dump operation, while allowing
273  // concurrent inserts.
274  auto table_read_lock =
276  const auto table_name = td->tableName;
277  {
278  // - gen schema file
279  const auto schema_str = cat_->dumpSchema(td);
280  file_writer(table_schema_filename, "table schema", schema_str);
281  // - gen column-old-info file
282  const auto cds = cat_->getAllColumnMetadataForTable(td->tableId, true, true, true);
283  std::vector<std::string> column_oldinfo;
284  std::transform(cds.begin(),
285  cds.end(),
286  std::back_inserter(column_oldinfo),
287  [&](const auto cd) -> std::string {
288  return cd->columnName + ":" + std::to_string(cd->columnId) + ":" +
290  });
291  const auto column_oldinfo_str = boost::algorithm::join(column_oldinfo, " ");
292  file_writer(table_oldinfo_filename, "table old info", column_oldinfo_str);
293  // - gen table epoch
294  const auto epoch = cat_->getTableEpoch(cat_->getCurrentDB().dbId, td->tableId);
295  file_writer(table_epoch_filename, "table epoch", std::to_string(epoch));
296  // - collect table data file paths ...
297  const auto data_file_dirs = cat_->getTableDataDirectories(td);
298  file_paths.insert(file_paths.end(), data_file_dirs.begin(), data_file_dirs.end());
299  // - collect table dict file paths ...
300  const auto dict_file_dirs = cat_->getTableDictDirectories(td);
301  file_paths.insert(file_paths.end(), dict_file_dirs.begin(), dict_file_dirs.end());
302  // tar takes time. release cat lock to yield the cat to concurrent CREATE statements.
303  }
304  // run tar to archive the files ... this may take a while !!
305  run("tar " + compression + " -cvf " + get_quoted_string(archive_path) + " " +
306  boost::algorithm::join(file_paths, " "),
307  abs_path(global_file_mgr));
308 }
static ReadLock getReadLockForTable(const Catalog_Namespace::Catalog &cat, const std::string &table_name)
Definition: LockMgrImpl.h:164
static constexpr char const * table_schema_filename
std::string tableName
std::string abs_path(const File_Namespace::GlobalFileMgr *global_file_mgr)
Data_Namespace::DataMgr & getDataMgr() const
Definition: Catalog.h:195
std::string join(T const &container, std::string const &delim)
static constexpr char const * table_oldinfo_filename
int32_t getTableEpoch(const int32_t db_id, const int32_t table_id) const
Definition: Catalog.cpp:2688
std::vector< std::string > getTableDataDirectories(const TableDescriptor *td) const
Definition: Catalog.cpp:3836
std::string to_string(char const *&&v)
std::string getColumnDictDirectory(const ColumnDescriptor *cd) const
Definition: Catalog.cpp:3850
std::string get_quoted_string(const std::string &filename, char quote, char escape)
Quote a string while escaping any existing quotes in the string.
void filename_security_check(const std::string &filename)
Throw exception if security problems found in a filename.
const DBMetadata & getCurrentDB() const
Definition: Catalog.h:194
std::vector< std::string > getTableDictDirectories(const TableDescriptor *td) const
Definition: Catalog.cpp:3866
std::list< const ColumnDescriptor * > getAllColumnMetadataForTable(const int tableId, const bool fetchSystemColumns, const bool fetchVirtualColumns, const bool fetchPhysicalColumns) const
Returns a list of pointers to constant ColumnDescriptor structs for all the columns from a particular...
Definition: Catalog.cpp:1704
Data_Namespace::MemoryLevel persistenceLevel
static constexpr char const * table_epoch_filename
bool g_cluster
static bool run
std::string dumpSchema(const TableDescriptor *td) const
Definition: Catalog.cpp:3882
File_Namespace::GlobalFileMgr * getGlobalFileMgr() const
Definition: DataMgr.cpp:526
Catalog_Namespace::Catalog * cat_
Definition: TableArchiver.h:43

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void TableArchiver::restoreTable ( const Catalog_Namespace::SessionInfo session,
const TableDescriptor td,
const std::string &  archive_path,
const std::string &  compression 
)

Definition at line 311 of file TableArchiver.cpp.

References anonymous_namespace{TableArchiver.cpp}::abs_path(), anonymous_namespace{TableArchiver.cpp}::adjust_altered_table_files(), cat_, Catalog_Namespace::DBMetadata::dbId, Data_Namespace::DISK_LEVEL, measure< TimeT >::execution(), filename_security_check(), g_cluster, g_test_rollback_dump_restore, get_quoted_string(), anonymous_namespace{TableArchiver.cpp}::get_table_schema(), Catalog_Namespace::Catalog::getAllColumnMetadataForTable(), Catalog_Namespace::Catalog::getColumnDictDirectory(), Catalog_Namespace::Catalog::getCurrentDB(), Catalog_Namespace::Catalog::getDataMgr(), Data_Namespace::DataMgr::getGlobalFileMgr(), lockmgr::TableLockMgrImpl< TableSchemaLockMgr >::getReadLockForTable(), Catalog_Namespace::Catalog::getTableDataDirectories(), Catalog_Namespace::Catalog::getTableDictDirectories(), lockmgr::TableLockMgrImpl< InsertDataLockMgr >::getWriteLockForTable(), TableDescriptor::hasDeletedCol, TableDescriptor::isView, join(), TableDescriptor::nShards, TableDescriptor::persistenceLevel, anonymous_namespace{TableArchiver.cpp}::rename_table_directories(), run, Catalog_Namespace::Catalog::setTableEpoch(), anonymous_namespace{TableArchiver.cpp}::simple_file_cat(), split(), table_epoch_filename, table_oldinfo_filename, table_schema_filename, TableDescriptor::tableId, TableDescriptor::tableName, to_string(), and VLOG.

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

314  {
315  filename_security_check(archive_path);
316  if (g_cluster) {
317  throw std::runtime_error("DUMP/RESTORE is not supported yet on distributed setup.");
318  }
319  if (!boost::filesystem::exists(archive_path)) {
320  throw std::runtime_error("Archive " + archive_path + " does not exist.");
321  }
323  throw std::runtime_error("Restoring view or temporary table is not supported.");
324  }
325  // Obtain table schema read lock to prevent modification of the schema during
326  // restoration
327  const auto table_read_lock =
329  // prevent concurrent inserts into table during restoration
330  const auto insert_data_lock =
332 
333  // untar takes time. no grab of cat lock to yield to concurrent CREATE stmts.
334  const auto global_file_mgr = cat_->getDataMgr().getGlobalFileMgr();
335  // dirs where src files are untarred and dst files are backed up
336  constexpr static const auto temp_data_basename = "_data";
337  constexpr static const auto temp_back_basename = "_back";
338  const auto temp_data_dir = abs_path(global_file_mgr) + "/" + temp_data_basename;
339  const auto temp_back_dir = abs_path(global_file_mgr) + "/" + temp_back_basename;
340  // clean up tmp dirs and files in any case
341  auto tmp_files_cleaner = [&](void*) {
342  run("rm -rf " + temp_data_dir + " " + temp_back_dir);
343  run("rm -f " + abs_path(global_file_mgr) + "/" + table_schema_filename);
344  run("rm -f " + abs_path(global_file_mgr) + "/" + table_oldinfo_filename);
345  run("rm -f " + abs_path(global_file_mgr) + "/" + table_epoch_filename);
346  };
347  std::unique_ptr<decltype(tmp_files_cleaner), decltype(tmp_files_cleaner)> tfc(
348  &tmp_files_cleaner, tmp_files_cleaner);
349  // extract & parse schema
350  const auto schema_str = get_table_schema(archive_path, td->tableName, compression);
351  const auto create_table_stmt =
352  Parser::parseDDL<Parser::CreateTableStmt>("table schema", schema_str);
353  // verify compatibility between source and destination schemas
354  TableDescriptor src_td;
355  std::list<ColumnDescriptor> src_columns;
356  std::vector<Parser::SharedDictionaryDef> shared_dict_defs;
357  create_table_stmt->executeDryRun(session, src_td, src_columns, shared_dict_defs);
358  // - sanity check table-level compatibility
359  if (src_td.hasDeletedCol != td->hasDeletedCol) {
360  // TODO: allow the case, in which src data enables vacuum while
361  // dst doesn't, by simply discarding src $deleted column data.
362  throw std::runtime_error("Incompatible table VACCUM option");
363  }
364  if (src_td.nShards != td->nShards) {
365  // TODO: allow different shard numbers if they have a "GCD",
366  // by splitting/merging src data files before drop into dst.
367  throw std::runtime_error("Unmatched number of table shards");
368  }
369  // - sanity check column-level compatibility (based on column names)
370  const auto dst_columns =
371  cat_->getAllColumnMetadataForTable(td->tableId, false, false, false);
372  if (dst_columns.size() != src_columns.size()) {
373  throw std::runtime_error("Unmatched number of table columns");
374  }
375  for (const auto& [src_cd, dst_cd] : boost::combine(src_columns, dst_columns)) {
376  if (src_cd.columnType.get_type_name() != dst_cd->columnType.get_type_name() ||
377  src_cd.columnType.get_compression_name() !=
378  dst_cd->columnType.get_compression_name()) {
379  throw std::runtime_error("Incompatible types on column " + src_cd.columnName);
380  }
381  }
382  // extract src table column ids (ALL columns incl. system/virtual/phy geo cols)
383  const auto all_src_oldinfo_str =
384  simple_file_cat(archive_path, table_oldinfo_filename, compression);
385  std::vector<std::string> src_oldinfo_strs;
386  boost::algorithm::split(src_oldinfo_strs,
387  all_src_oldinfo_str,
388  boost::is_any_of(" "),
389  boost::token_compress_on);
390  auto all_dst_columns =
391  cat_->getAllColumnMetadataForTable(td->tableId, true, true, true);
392  if (src_oldinfo_strs.size() != all_dst_columns.size()) {
393  throw std::runtime_error("Source table has a unmatched number of columns: " +
394  std::to_string(src_oldinfo_strs.size()) + " vs " +
395  std::to_string(all_dst_columns.size()));
396  }
397  // build a map of src column ids and dst column ids, just in case src table has been
398  // ALTERed before and chunk keys of src table needs to be adjusted accordingly.
399  // note: this map is used only for the case of migrating a table and not for restoring
400  // a table. When restoring a table, the two tables must have the same column ids.
401  //
402  // also build a map of src dict paths and dst dict paths for relocating src dicts
403  std::unordered_map<int, int> column_ids_map;
404  std::unordered_map<std::string, std::string> dict_paths_map;
405  // sort inputs of transform in lexical order of column names for correct mappings
406  std::list<std::vector<std::string>> src_oldinfo_tokens;
407  std::transform(
408  src_oldinfo_strs.begin(),
409  src_oldinfo_strs.end(),
410  std::back_inserter(src_oldinfo_tokens),
411  [](const auto& src_oldinfo_str) -> auto {
412  std::vector<std::string> tokens;
414  tokens, src_oldinfo_str, boost::is_any_of(":"), boost::token_compress_on);
415  return tokens;
416  });
417  src_oldinfo_tokens.sort(
418  [](const auto& lhs, const auto& rhs) { return lhs[0].compare(rhs[0]) < 0; });
419  all_dst_columns.sort(
420  [](auto a, auto b) { return a->columnName.compare(b->columnName) < 0; });
421  // transform inputs into the maps
422  std::transform(src_oldinfo_tokens.begin(),
423  src_oldinfo_tokens.end(),
424  all_dst_columns.begin(),
425  std::inserter(column_ids_map, column_ids_map.end()),
426  [&](const auto& tokens, const auto& cd) -> std::pair<int, int> {
427  VLOG(3) << boost::algorithm::join(tokens, ":") << " ==> "
428  << cd->columnName << ":" << cd->columnId;
429  dict_paths_map[tokens[2]] = cat_->getColumnDictDirectory(cd);
430  return {boost::lexical_cast<int>(tokens[1]), cd->columnId};
431  });
432  bool was_table_altered = false;
433  std::for_each(column_ids_map.begin(), column_ids_map.end(), [&](auto& it) {
434  was_table_altered = was_table_altered || it.first != it.second;
435  });
436  VLOG(3) << "was_table_altered = " << was_table_altered;
437  // extract all data files to a temp dir. will swap with dst table dir after all set,
438  // otherwise will corrupt table in case any bad thing happens in the middle.
439  run("rm -rf " + temp_data_dir);
440  run("mkdir -p " + temp_data_dir);
441  run("tar " + compression + " -xvf " + get_quoted_string(archive_path), temp_data_dir);
442  // if table was ever altered after it was created, update column ids in chunk headers.
443  if (was_table_altered) {
444  const auto time_ms = measure<>::execution(
445  [&]() { adjust_altered_table_files(temp_data_dir, column_ids_map); });
446  VLOG(3) << "adjust_altered_table_files: " << time_ms << " ms";
447  }
448  // finally,,, swap table data/dict dirs!
449  const auto data_file_dirs = cat_->getTableDataDirectories(td);
450  const auto dict_file_dirs = cat_->getTableDictDirectories(td);
451  // move current target dirs, if exists, to backup dir
452  std::vector<std::string> both_file_dirs;
453  std::merge(data_file_dirs.begin(),
454  data_file_dirs.end(),
455  dict_file_dirs.begin(),
456  dict_file_dirs.end(),
457  std::back_inserter(both_file_dirs));
458  bool backup_completed = false;
459  try {
460  run("rm -rf " + temp_back_dir);
461  run("mkdir -p " + temp_back_dir);
462  for (const auto& dir : both_file_dirs) {
463  const auto dir_full_path = abs_path(global_file_mgr) + "/" + dir;
464  if (boost::filesystem::is_directory(dir_full_path)) {
465  run("mv " + dir_full_path + " " + temp_back_dir);
466  }
467  }
468  backup_completed = true;
469  // accord src data dirs to dst
471  cat_->getDataMgr().getGlobalFileMgr(), temp_data_dir, data_file_dirs, "table_");
472  // accord src dict dirs to dst
473  for (const auto& dit : dict_paths_map) {
474  if (!dit.first.empty() && !dit.second.empty()) {
475  const auto src_dict_path = temp_data_dir + "/" + dit.first;
476  const auto dst_dict_path = abs_path(global_file_mgr) + "/" + dit.second;
477  run("mv " + src_dict_path + " " + dst_dict_path);
478  }
479  }
480  // throw if sanity test forces a rollback
482  throw std::runtime_error("lol!");
483  }
484  } catch (...) {
485  // once backup is completed, whatever in abs_path(global_file_mgr) is the "src"
486  // dirs that are to be rolled back and discarded
487  if (backup_completed) {
488  run("rm -rf " + boost::algorithm::join(both_file_dirs, " "),
489  abs_path(global_file_mgr));
490  }
491  // complete rollback by recovering original "dst" table dirs from backup dir
492  boost::filesystem::path base_path(temp_back_dir);
493  boost::filesystem::directory_iterator end_it;
494  for (boost::filesystem::directory_iterator fit(base_path); fit != end_it; ++fit) {
495  run("mv " + fit->path().string() + " .", abs_path(global_file_mgr));
496  }
497  throw;
498  }
499  // set for reloading table from the restored/migrated files
500  const auto epoch = simple_file_cat(archive_path, table_epoch_filename, compression);
502  cat_->getCurrentDB().dbId, td->tableId, boost::lexical_cast<int>(epoch));
503 }
std::string get_table_schema(const std::string &archive_path, const std::string &table, const std::string &compression)
static ReadLock getReadLockForTable(const Catalog_Namespace::Catalog &cat, const std::string &table_name)
Definition: LockMgrImpl.h:164
static constexpr char const * table_schema_filename
std::string tableName
static TimeT::rep execution(F func, Args &&...args)
Definition: sample.cpp:29
std::string abs_path(const File_Namespace::GlobalFileMgr *global_file_mgr)
Data_Namespace::DataMgr & getDataMgr() const
Definition: Catalog.h:195
static WriteLock getWriteLockForTable(const Catalog_Namespace::Catalog &cat, const std::string &table_name)
Definition: LockMgrImpl.h:155
void adjust_altered_table_files(const std::string &temp_data_dir, const std::unordered_map< int, int > &column_ids_map)
std::string join(T const &container, std::string const &delim)
static constexpr char const * table_oldinfo_filename
std::vector< std::string > getTableDataDirectories(const TableDescriptor *td) const
Definition: Catalog.cpp:3836
std::string to_string(char const *&&v)
std::vector< std::string > split(std::string_view str, std::string_view delim, std::optional< size_t > maxsplit)
split apart a string into a vector of substrings
std::string getColumnDictDirectory(const ColumnDescriptor *cd) const
Definition: Catalog.cpp:3850
std::string get_quoted_string(const std::string &filename, char quote, char escape)
Quote a string while escaping any existing quotes in the string.
void filename_security_check(const std::string &filename)
Throw exception if security problems found in a filename.
const DBMetadata & getCurrentDB() const
Definition: Catalog.h:194
void rename_table_directories(const File_Namespace::GlobalFileMgr *global_file_mgr, const std::string &temp_data_dir, const std::vector< std::string > &target_paths, const std::string &name_prefix)
void setTableEpoch(const int db_id, const int table_id, const int new_epoch)
Definition: Catalog.cpp:2718
std::vector< std::string > getTableDictDirectories(const TableDescriptor *td) const
Definition: Catalog.cpp:3866
std::list< const ColumnDescriptor * > getAllColumnMetadataForTable(const int tableId, const bool fetchSystemColumns, const bool fetchVirtualColumns, const bool fetchPhysicalColumns) const
Returns a list of pointers to constant ColumnDescriptor structs for all the columns from a particular...
Definition: Catalog.cpp:1704
Data_Namespace::MemoryLevel persistenceLevel
static constexpr char const * table_epoch_filename
bool g_cluster
static bool run
specifies the content in-memory of a row in the table metadata table
std::string simple_file_cat(const std::string &archive_path, const std::string &file_name, const std::string &compression)
#define VLOG(n)
Definition: Logger.h:291
bool g_test_rollback_dump_restore
File_Namespace::GlobalFileMgr * getGlobalFileMgr() const
Definition: DataMgr.cpp:526
Catalog_Namespace::Catalog * cat_
Definition: TableArchiver.h:43

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void TableArchiver::restoreTable ( const Catalog_Namespace::SessionInfo session,
const std::string &  table_name,
const std::string &  archive_path,
const std::string &  compression 
)

Definition at line 507 of file TableArchiver.cpp.

References cat_, anonymous_namespace{TableArchiver.cpp}::get_table_schema(), Catalog_Namespace::Catalog::getMetadataForTable(), and restoreTable().

510  {
511  // replace table name and drop foreign dict references
512  const auto schema_str = get_table_schema(archive_path, table_name, compression);
513  Parser::parseDDL<Parser::CreateTableStmt>("table schema", schema_str)->execute(session);
514  try {
515  restoreTable(
516  session, cat_->getMetadataForTable(table_name), archive_path, compression);
517  } catch (...) {
518  Parser::parseDDL<Parser::DropTableStmt>("statement",
519  "DROP TABLE IF EXISTS " + table_name + ";")
520  ->execute(session);
521  throw;
522  }
523 }
std::string get_table_schema(const std::string &archive_path, const std::string &table, const std::string &compression)
void restoreTable(const Catalog_Namespace::SessionInfo &session, const TableDescriptor *td, const std::string &archive_path, const std::string &compression)
const TableDescriptor * getMetadataForTable(const std::string &tableName, const bool populateFragmenter=true) const
Returns a pointer to a const TableDescriptor struct matching the provided tableName.
Catalog_Namespace::Catalog * cat_
Definition: TableArchiver.h:43

+ Here is the call graph for this function:

Member Data Documentation

Catalog_Namespace::Catalog* TableArchiver::cat_
private

Definition at line 43 of file TableArchiver.h.

Referenced by dumpTable(), and restoreTable().


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