OmniSciDB  91042dcc5b
 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  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 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

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"}
 
bool g_log_user_id {false}
 

Typedef Documentation

Definition at line 116 of file Catalog.cpp.

Definition at line 118 of file Catalog.cpp.

Definition at line 117 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 52 of file Types.h.

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

Definition at line 43 of file Types.h.

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

Definition at line 137 of file SysCatalog.h.

Definition at line 47 of file Types.h.

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

Definition at line 41 of file Types.h.

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

Definition at line 49 of file Types.h.

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

Definition at line 51 of file Types.h.

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

Definition at line 44 of file Types.h.

Definition at line 45 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 115 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.

Enumeration Type Documentation

Enumerator
TABLE 

Definition at line 22 of file CustomExpression.h.

22 { TABLE = 0 };
#define TABLE

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 4648 of file Catalog.cpp.

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

4648  {
4649  return std::find_if(str.begin(), str.end(), [](const unsigned char& ch) {
4650  return std::isspace(ch);
4651  }) != str.end();
4652 }

+ 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 4655 of file Catalog.cpp.

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

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

+ 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 4662 of file Catalog.cpp.

References reserved_keywords, and to_upper().

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

4662  {
4663  return reserved_keywords.find(to_upper(std::string(str))) != reserved_keywords.end();
4664 }
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 3742 of file Catalog.cpp.

References Catalog_Namespace::Catalog::getMetadataForTable().

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

3744  {
3745  auto iter = cachedTableMap.find(curTableName);
3746  if ((iter != cachedTableMap.end())) {
3747  // get the cached tableId
3748  // and use that to lookup the TableDescriptor
3749  int tableId = (*iter).second;
3750  if (tableId == -1) {
3751  return NULL;
3752  } else {
3753  return cat->getMetadataForTable(tableId);
3754  }
3755  }
3756 
3757  // else ... lookup in standard location
3758  return cat->getMetadataForTable(curTableName);
3759 }
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 1404 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().

1406  {
1407  int numRows = conn->getNumRows();
1408  if (numRows == 0) {
1409  return false;
1410  }
1411  user.userId = conn->getData<int>(row, 0);
1412  user.userName = conn->getData<string>(row, 1);
1413  user.passwd_hash = conn->getData<string>(row, 2);
1414  user.isSuper = conn->getData<bool>(row, 3);
1415  user.defaultDbId = conn->isNull(row, 4) ? -1 : conn->getData<int>(row, 4);
1416  if (conn->isNull(row, 5)) {
1417  LOG(WARNING)
1418  << "User property 'can_login' not set for user " << user.userLoggable()
1419  << ". Disabling login ability. Set the users login ability with \"ALTER USER "
1420  << (g_log_user_id ? std::string("[username]") : user.userName)
1421  << " (can_login='true');\".";
1422  }
1423  user.can_login = conn->isNull(row, 5) ? false : conn->getData<bool>(row, 5);
1424  return true;
1425 }
#define LOG(tag)
Definition: Logger.h:205

+ 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 3761 of file Catalog.cpp.

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

3764  {
3765  // mark old/cur name as deleted
3766  cachedTableMap[curTableName] = -1;
3767 
3768  // insert the 'new' name
3769  cachedTableMap[newTableName] = tableId;
3770 }

+ Here is the caller graph for this function:

Variable Documentation

const int Catalog_Namespace::MAPD_TEMP_DICT_START_ID
Initial value:
=
1073741824

Definition at line 108 of file Catalog.cpp.

const int Catalog_Namespace::MAPD_TEMP_TABLE_START_ID
Initial value:
=
1073741824

Definition at line 106 of file Catalog.cpp.

constexpr const char* Catalog_Namespace::ROLE_ASSIGNMENTS_SYS_TABLE_NAME {"role_assignments"}
static