OmniSciDB  cde582ebc3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Catalog_Namespace Namespace Reference

Namespaces

 anonymous_namespace{Catalog.cpp}
 
 anonymous_namespace{SysCatalog.cpp}
 

Classes

struct  TableEpochInfo
 
class  Catalog
 class for a per-database catalog. also includes metadata for the current database and the current user. More...
 
struct  CustomExpression
 
class  read_lock
 
class  sqlite_lock
 
class  write_lock
 
class  SessionInfo
 
struct  UserMetadata
 
struct  UserAlterations
 
struct  DBMetadata
 
struct  DBSummary
 
class  CommonFileOperations
 
class  SysCatalog
 

Typedefs

using sys_read_lock = read_lock< SysCatalog >
 
using cat_read_lock = read_lock< Catalog >
 
using cat_write_lock = write_lock< Catalog >
 
using cat_sqlite_lock = sqlite_lock< Catalog >
 
using sys_write_lock = write_lock< SysCatalog >
 
using sys_sqlite_lock = sqlite_lock< SysCatalog >
 
using DBSummaryList = std::list< DBSummary >
 
using TableDescriptorMap = std::map< std::string, TableDescriptor * >
 
using TableDescriptorMapById = std::map< int, TableDescriptor * >
 
using LogicalToPhysicalTableMapById = std::map< int32_t, std::vector< int32_t >>
 
using ColumnKey = std::tuple< int, std::string >
 
using ColumnDescriptorMap = std::map< ColumnKey, ColumnDescriptor * >
 
using ColumnIdKey = std::tuple< int, int >
 
using ColumnDescriptorMapById = std::map< ColumnIdKey, ColumnDescriptor * >
 
using TableDictColumnsMap = std::map< int32_t, std::set< const ColumnDescriptor * >>
 
using DictDescriptorMapById = std::map< DictRef, std::unique_ptr< DictDescriptor >>
 
using DashboardDescriptorMap = std::map< std::string, std::shared_ptr< DashboardDescriptor >>
 
using LinkDescriptorMap = std::map< std::string, LinkDescriptor * >
 
using LinkDescriptorMapById = std::map< int, LinkDescriptor * >
 
using DeletedColumnPerTableMap = std::unordered_map< const TableDescriptor *, const ColumnDescriptor * >
 
using ForeignServerMap = std::map< std::string, std::shared_ptr< foreign_storage::ForeignServer >>
 
using ForeignServerMapById = std::map< int, std::shared_ptr< foreign_storage::ForeignServer >>
 
using CustomExpressionMapById = std::map< int, std::unique_ptr< CustomExpression >>
 

Enumerations

enum  DataSourceType { DataSourceType::TABLE = 0 }
 

Functions

 dsqliteMutex_ (std::make_unique< heavyai::DistributedSharedMutex >(std::filesystem::path(basePath_)/shared::kLockfilesDirectoryName/shared::kCatalogDirectoryName/(currentDB_.dbName+".sqlite.lockfile")))
 
 sqliteMutex_ ()
 
 sharedMutex_ ()
 
 thread_holding_sqlite_lock ()
 
 thread_holding_write_lock ()
 
const TableDescriptorlookupTableDescriptor (Catalog *cat, std::map< std::string, int > &cachedTableMap, std::string &curTableName)
 
void replaceTableName (std::map< std::string, int > &cachedTableMap, std::string &curTableName, std::string &newTableName, int tableId)
 
bool contains_spaces (std::string_view str)
 returns true if the string contains one or more spaces More...
 
bool contains_sql_reserved_chars (std::string_view str, std::string_view chars="`~!@#$%^&*()-=+[{]}\\|;:'\",<.>/?")
 returns true if the string contains one or more OmniSci SQL reserved characters More...
 
bool is_reserved_sql_keyword (std::string_view str)
 returns true if the string equals an OmniSci SQL reserved keyword More...
 
std::ostream & operator<< (std::ostream &os, const SessionInfo &session_info)
 
static bool parseUserMetadataFromSQLite (const std::unique_ptr< SqliteConnector > &conn, UserMetadata &user, int row)
 

Variables

const int DEFAULT_INITIAL_VERSION = 1
 
const int MAPD_TEMP_TABLE_START_ID
 
const int MAPD_TEMP_DICT_START_ID
 
static constexpr const char * USERS_SYS_TABLE_NAME {"users"}
 
static constexpr const char * TABLES_SYS_TABLE_NAME {"tables"}
 
static constexpr const char * DASHBOARDS_SYS_TABLE_NAME {"dashboards"}
 
static constexpr const char * DATABASES_SYS_TABLE_NAME {"databases"}
 
static constexpr const char * PERMISSIONS_SYS_TABLE_NAME {"permissions"}
 
static constexpr const char * ROLES_SYS_TABLE_NAME {"roles"}
 
static constexpr const char * ROLE_ASSIGNMENTS_SYS_TABLE_NAME {"role_assignments"}
 
static constexpr const char * MEMORY_SUMMARY_SYS_TABLE_NAME {"memory_summary"}
 
static constexpr const char * MEMORY_DETAILS_SYS_TABLE_NAME {"memory_details"}
 
static constexpr const char * STORAGE_DETAILS_SYS_TABLE_NAME {"storage_details"}
 
static constexpr const char * SERVER_LOGS_SYS_TABLE_NAME {"server_logs"}
 
static constexpr const char * REQUEST_LOGS_SYS_TABLE_NAME {"request_logs"}
 
static constexpr const char * WS_SERVER_LOGS_SYS_TABLE_NAME {"web_server_logs"}
 
static constexpr const char * WS_SERVER_ACCESS_LOGS_SYS_TABLE_NAME
 
static const std::array
< std::string, 4 > 
kAggregatorOnlySystemTables
 
bool g_log_user_id {false}
 

Typedef Documentation

Definition at line 123 of file Catalog.cpp.

Definition at line 125 of file Catalog.cpp.

Definition at line 124 of file Catalog.cpp.

Definition at line 38 of file Types.h.

Definition at line 40 of file Types.h.

using Catalog_Namespace::ColumnIdKey = typedef std::tuple<int, int>

Definition at line 39 of file Types.h.

using Catalog_Namespace::ColumnKey = typedef std::tuple<int, std::string>

Definition at line 37 of file Types.h.

using Catalog_Namespace::CustomExpressionMapById = typedef std::map<int, std::unique_ptr<CustomExpression>>

Definition at line 53 of file Types.h.

using Catalog_Namespace::DashboardDescriptorMap = typedef std::map<std::string, std::shared_ptr<DashboardDescriptor>>

Definition at line 44 of file Types.h.

using Catalog_Namespace::DBSummaryList = typedef std::list<DBSummary>

Definition at line 145 of file SysCatalog.h.

using Catalog_Namespace::DeletedColumnPerTableMap = typedef std::unordered_map<const TableDescriptor*, const ColumnDescriptor*>

Definition at line 48 of file Types.h.

using Catalog_Namespace::DictDescriptorMapById = typedef std::map<DictRef, std::unique_ptr<DictDescriptor>>

Definition at line 42 of file Types.h.

using Catalog_Namespace::ForeignServerMap = typedef std::map<std::string, std::shared_ptr<foreign_storage::ForeignServer>>

Definition at line 50 of file Types.h.

using Catalog_Namespace::ForeignServerMapById = typedef std::map<int, std::shared_ptr<foreign_storage::ForeignServer>>

Definition at line 52 of file Types.h.

using Catalog_Namespace::LinkDescriptorMap = typedef std::map<std::string, LinkDescriptor*>

Definition at line 45 of file Types.h.

Definition at line 46 of file Types.h.

using Catalog_Namespace::LogicalToPhysicalTableMapById = typedef std::map<int32_t, std::vector<int32_t>>

Definition at line 36 of file Types.h.

Definition at line 122 of file Catalog.cpp.

Definition at line 123 of file SysCatalog.cpp.

Definition at line 122 of file SysCatalog.cpp.

using Catalog_Namespace::TableDescriptorMap = typedef std::map<std::string, TableDescriptor*>

Definition at line 34 of file Types.h.

Definition at line 35 of file Types.h.

using Catalog_Namespace::TableDictColumnsMap = typedef std::map<int32_t, std::set<const ColumnDescriptor*>>

Definition at line 41 of file Types.h.

Enumeration Type Documentation

Enumerator
TABLE 

Definition at line 22 of file CustomExpression.h.

Function Documentation

bool Catalog_Namespace::contains_spaces ( std::string_view  str)
inline

returns true if the string contains one or more spaces

Definition at line 5112 of file Catalog.cpp.

Referenced by Catalog_Namespace::Catalog::quoteIfRequired().

5112  {
5113  return std::find_if(str.begin(), str.end(), [](const unsigned char& ch) {
5114  return std::isspace(ch);
5115  }) != str.end();
5116 }

+ Here is the caller graph for this function:

bool Catalog_Namespace::contains_sql_reserved_chars ( std::string_view  str,
std::string_view  chars = "`~!@#$%^&*()-=+[{]}\\|;:'\",<.>/?" 
)
inline

returns true if the string contains one or more OmniSci SQL reserved characters

Definition at line 5119 of file Catalog.cpp.

Referenced by Catalog_Namespace::Catalog::quoteIfRequired().

5121  {]}\\|;:'\",<.>/?") {
5122  return str.find_first_of(chars) != std::string_view::npos;
5123 }

+ Here is the caller graph for this function:

Catalog_Namespace::dsqliteMutex_ ( std::make_unique< heavyai::DistributedSharedMutex std::filesystem::path(basePath_)/shared::kLockfilesDirectoryName/shared::kCatalogDirectoryName/(currentDB_.dbName+".sqlite.lockfile"))

Referenced by Catalog_Namespace::SysCatalog::init().

+ Here is the caller graph for this function:

bool Catalog_Namespace::is_reserved_sql_keyword ( std::string_view  str)
inline

returns true if the string equals an OmniSci SQL reserved keyword

Definition at line 5126 of file Catalog.cpp.

References reserved_keywords, and to_upper().

Referenced by Catalog_Namespace::Catalog::quoteIfRequired().

5126  {
5127  return reserved_keywords.find(to_upper(std::string(str))) != reserved_keywords.end();
5128 }
static std::set< std::string > reserved_keywords
std::string to_upper(const std::string &str)

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

const TableDescriptor* Catalog_Namespace::lookupTableDescriptor ( Catalog *  cat,
std::map< std::string, int > &  cachedTableMap,
std::string &  curTableName 
)

Definition at line 4192 of file Catalog.cpp.

References Catalog_Namespace::Catalog::getMetadataForTable().

Referenced by Catalog_Namespace::Catalog::renameTable().

4194  {
4195  auto iter = cachedTableMap.find(curTableName);
4196  if ((iter != cachedTableMap.end())) {
4197  // get the cached tableId
4198  // and use that to lookup the TableDescriptor
4199  int tableId = (*iter).second;
4200  if (tableId == -1) {
4201  return NULL;
4202  } else {
4203  return cat->getMetadataForTable(tableId);
4204  }
4205  }
4206 
4207  // else ... lookup in standard location
4208  return cat->getMetadataForTable(curTableName);
4209 }
std::string cat(Ts &&...args)

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

std::ostream & Catalog_Namespace::operator<< ( std::ostream &  os,
const SessionInfo &  session_info 
)

Definition at line 57 of file SessionInfo.cpp.

References Catalog_Namespace::SessionInfo::get_public_session_id().

57  {
58  os << session_info.get_public_session_id();
59  return os;
60 }

+ Here is the call graph for this function:

static bool Catalog_Namespace::parseUserMetadataFromSQLite ( const std::unique_ptr< SqliteConnector > &  conn,
UserMetadata &  user,
int  row 
)
static

Definition at line 1549 of file SysCatalog.cpp.

References Catalog_Namespace::UserMetadata::can_login, Catalog_Namespace::UserMetadata::defaultDbId, g_log_user_id, Catalog_Namespace::UserMetadata::isSuper, LOG, Catalog_Namespace::UserMetadata::passwd_hash, Catalog_Namespace::UserMetadata::userId, Catalog_Namespace::UserMetadata::userLoggable(), Catalog_Namespace::UserMetadata::userName, and logger::WARNING.

Referenced by Catalog_Namespace::anonymous_namespace{SysCatalog.cpp}::get_users(), Catalog_Namespace::SysCatalog::getMetadataForUser(), and Catalog_Namespace::SysCatalog::getMetadataForUserById().

1551  {
1552  int numRows = conn->getNumRows();
1553  if (numRows == 0) {
1554  return false;
1555  }
1556  user.userId = conn->getData<int>(row, 0);
1557  user.userName = conn->getData<string>(row, 1);
1558  user.passwd_hash = conn->getData<string>(row, 2);
1559  user.isSuper = conn->getData<bool>(row, 3);
1560  user.defaultDbId = conn->isNull(row, 4) ? -1 : conn->getData<int>(row, 4);
1561  if (conn->isNull(row, 5)) {
1562  LOG(WARNING)
1563  << "User property 'can_login' not set for user " << user.userLoggable()
1564  << ". Disabling login ability. Set the users login ability with \"ALTER USER "
1565  << (g_log_user_id ? std::string("[username]") : user.userName)
1566  << " (can_login='true');\".";
1567  }
1568  user.can_login = conn->isNull(row, 5) ? false : conn->getData<bool>(row, 5);
1569  return true;
1570 }
#define LOG(tag)
Definition: Logger.h:216

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void Catalog_Namespace::replaceTableName ( std::map< std::string, int > &  cachedTableMap,
std::string &  curTableName,
std::string &  newTableName,
int  tableId 
)

Definition at line 4211 of file Catalog.cpp.

Referenced by Catalog_Namespace::Catalog::renameTable().

4214  {
4215  // mark old/cur name as deleted
4216  cachedTableMap[curTableName] = -1;
4217 
4218  // insert the 'new' name
4219  cachedTableMap[newTableName] = tableId;
4220 }

+ Here is the caller graph for this function:

Catalog_Namespace::sharedMutex_ ( )
Catalog_Namespace::sqliteMutex_ ( )
Catalog_Namespace::thread_holding_sqlite_lock ( )
Catalog_Namespace::thread_holding_write_lock ( )

Definition at line 205 of file Catalog.cpp.

References CHECK, g_enable_fsi, g_enable_s3_fsi, g_enable_system_tables, g_multi_instance, g_serialize_temp_tables, and Catalog_Namespace::anonymous_namespace{Catalog.cpp}::table_json_filepath().

205  {
206  if (!g_enable_fsi) {
207  CHECK(!g_enable_system_tables) << "System tables require FSI to be enabled";
208  CHECK(!g_enable_s3_fsi) << "S3 FSI requires FSI to be enabled";
209  }
210 
211  if (!is_new_db && !g_multi_instance) {
212  CheckAndExecuteMigrations();
213  }
214 
215  buildMaps();
216 
217  if (g_enable_fsi) {
218  createDefaultServersIfNotExists();
219  }
220  if (!is_new_db) {
221  CheckAndExecuteMigrationsPostBuildMaps();
222  }
224  boost::filesystem::remove(table_json_filepath(basePath_, currentDB_.dbName));
225  }
226  conditionallyInitializeSystemObjects();
227  // once all initialized use real object
228  initialized_ = true;
229 }
bool g_multi_instance
Definition: heavyai_locks.h:21
auto table_json_filepath(const std::string &base_path, const std::string &db_name)
Definition: Catalog.cpp:164
bool g_enable_s3_fsi
Definition: Catalog.cpp:97
bool g_enable_system_tables
Definition: SysCatalog.cpp:64
bool g_serialize_temp_tables
Definition: Catalog.cpp:108
#define CHECK(condition)
Definition: Logger.h:222
bool g_enable_fsi
Definition: Catalog.cpp:96

+ Here is the call graph for this function:

Variable Documentation

const int Catalog_Namespace::DEFAULT_INITIAL_VERSION = 1
const std::array<std::string, 4> Catalog_Namespace::kAggregatorOnlySystemTables
static
Initial value:
{
static constexpr const char * WS_SERVER_ACCESS_LOGS_SYS_TABLE_NAME
Definition: Catalog.h:117
static constexpr const char * DASHBOARDS_SYS_TABLE_NAME
Definition: Catalog.h:106
static constexpr const char * REQUEST_LOGS_SYS_TABLE_NAME
Definition: Catalog.h:115
static constexpr const char * WS_SERVER_LOGS_SYS_TABLE_NAME
Definition: Catalog.h:116

Definition at line 120 of file Catalog.h.

Referenced by foreign_storage::refresh_foreign_table().

const int Catalog_Namespace::MAPD_TEMP_DICT_START_ID
Initial value:
=
1073741824

Definition at line 115 of file Catalog.cpp.

const int Catalog_Namespace::MAPD_TEMP_TABLE_START_ID
Initial value:
=
1073741824

Definition at line 113 of file Catalog.cpp.

constexpr const char* Catalog_Namespace::REQUEST_LOGS_SYS_TABLE_NAME {"request_logs"}
static
constexpr const char* Catalog_Namespace::ROLE_ASSIGNMENTS_SYS_TABLE_NAME {"role_assignments"}
static
constexpr const char* Catalog_Namespace::SERVER_LOGS_SYS_TABLE_NAME {"server_logs"}
static
constexpr const char* Catalog_Namespace::WS_SERVER_ACCESS_LOGS_SYS_TABLE_NAME
static
constexpr const char* Catalog_Namespace::WS_SERVER_LOGS_SYS_TABLE_NAME {"web_server_logs"}
static