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

class	SessionsStore

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	SessionInfoPtr = std::shared_ptr< SessionInfo >

using	DisconnectCallback = std::function< void(SessionInfoPtr &session)>

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 TableDescriptor *	lookupTableDescriptor (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

const size_t	CALCITE_SESSION_ID_LENGTH = 64

const size_t	SESSION_ID_LENGTH = 32

bool	g_log_user_id {false}

Typedef Documentation

using Catalog_Namespace::cat_read_lock = typedef read_lock<Catalog>

Definition at line 121 of file Catalog.cpp.

using Catalog_Namespace::cat_sqlite_lock = typedef sqlite_lock<Catalog>

Definition at line 123 of file Catalog.cpp.

using Catalog_Namespace::cat_write_lock = typedef write_lock<Catalog>

Definition at line 122 of file Catalog.cpp.

using Catalog_Namespace::ColumnDescriptorMap = typedef std::map<ColumnKey, ColumnDescriptor*>

Definition at line 38 of file Types.h.

using Catalog_Namespace::ColumnDescriptorMapById = typedef std::map<ColumnIdKey, ColumnDescriptor*>

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::DisconnectCallback = typedef std::function<void(SessionInfoPtr& session)>

Definition at line 29 of file SessionsStore.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.

using Catalog_Namespace::LinkDescriptorMapById = typedef std::map<int, LinkDescriptor*>

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.

using Catalog_Namespace::SessionInfoPtr = typedef std::shared_ptr<SessionInfo>

Definition at line 27 of file SessionsStore.h.

typedef read_lock< SysCatalog > Catalog_Namespace::sys_read_lock

Definition at line 120 of file Catalog.cpp.

using Catalog_Namespace::sys_sqlite_lock = typedef sqlite_lock<SysCatalog>

Definition at line 154 of file SysCatalog.cpp.

using Catalog_Namespace::sys_write_lock = typedef write_lock<SysCatalog>

Definition at line 153 of file SysCatalog.cpp.

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

Definition at line 34 of file Types.h.

using Catalog_Namespace::TableDescriptorMapById = typedef std::map<int, TableDescriptor*>

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

enum Catalog_Namespace::DataSourceType

strong

Enumerator
TABLE

Definition at line 22 of file CustomExpression.h.

22 { TABLE = 0 };

Catalog_Namespace::DataSourceType::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 5191 of file Catalog.cpp.

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

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

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

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

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

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

References reserved_keywords, and to_upper().

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

                                                         {
   return reserved_keywords.find(to_upper(std::string(str))) != reserved_keywords.end();
 }

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

References Catalog_Namespace::Catalog::getMetadataForTable().

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

                                                                       {
   auto iter = cachedTableMap.find(curTableName);
   if ((iter != cachedTableMap.end())) {
     // get the cached tableId
     //   and use that to lookup the TableDescriptor
     int tableId = (*iter).second;
     if (tableId == -1) {
       return NULL;
     } else {
       return cat->getMetadataForTable(tableId);
     }
   }
 
   // else ... lookup in standard location
   return cat->getMetadataForTable(curTableName);
 }

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().

                                                                         {
   os << session_info.get_public_session_id();
   return os;
 }

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 1654 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().

                                                  {
   int numRows = conn->getNumRows();
   if (numRows == 0) {
     return false;
   }
   user.userId = conn->getData<int>(row, 0);
   user.userName = conn->getData<string>(row, 1);
   user.passwd_hash = conn->getData<string>(row, 2);
   user.isSuper = conn->getData<bool>(row, 3);
   user.defaultDbId = conn->isNull(row, 4) ? -1 : conn->getData<int>(row, 4);
   if (conn->isNull(row, 5)) {
     LOG(WARNING)
         << "User property 'can_login' not set for user " << user.userLoggable()
         << ". Disabling login ability. Set the users login ability with \"ALTER USER "
         << (g_log_user_id ? std::string("[username]") : user.userName)
         << " (can_login='true');\".";
   }
   user.can_login = conn->isNull(row, 5) ? false : conn->getData<bool>(row, 5);
   return true;
 }

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

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

                                    {
   // mark old/cur name as deleted
   cachedTableMap[curTableName] = -1;
 
   // insert the 'new' name
   cachedTableMap[newTableName] = tableId;
 }

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().

                                   {
   if (!g_enable_fsi) {
     CHECK(!g_enable_system_tables) << "System tables require FSI to be enabled";
     CHECK(!g_enable_s3_fsi) << "S3 FSI requires FSI to be enabled";
   }
 
   if (!is_new_db && !g_multi_instance) {
     CheckAndExecuteMigrations();
   }
 
   buildMaps();
 
   if (g_enable_fsi) {
     createDefaultServersIfNotExists();
   }
   if (!is_new_db) {
     CheckAndExecuteMigrationsPostBuildMaps();
   }
   if (g_serialize_temp_tables) {
     boost::filesystem::remove(table_json_filepath(basePath_, currentDB_.dbName));
   }
   conditionallyInitializeSystemObjects();
   // once all initialized use real object
   initialized_ = true;
 }

Here is the call graph for this function:

Variable Documentation

const size_t Catalog_Namespace::CALCITE_SESSION_ID_LENGTH = 64

Definition at line 126 of file SessionInfo.h.

Referenced by DBHandler::createInMemoryCalciteSession(), DBHandler::get_session_copy(), and DBHandler::get_session_ptr().

constexpr const char* Catalog_Namespace::DASHBOARDS_SYS_TABLE_NAME {"dashboards"}

static

Definition at line 106 of file Catalog.h.

Referenced by Catalog_Namespace::Catalog::initializeDashboardsSystemTable(), foreign_storage::InternalCatalogDataWrapper::initializeObjectsForTable(), and foreign_storage::InternalCatalogDataWrapper::populateChunkBuffersForTable().

constexpr const char* Catalog_Namespace::DATABASES_SYS_TABLE_NAME {"databases"}

static

Definition at line 107 of file Catalog.h.

Referenced by Catalog_Namespace::Catalog::initializeDatabasesSystemTable(), foreign_storage::InternalCatalogDataWrapper::initializeObjectsForTable(), and foreign_storage::InternalCatalogDataWrapper::populateChunkBuffersForTable().

const int Catalog_Namespace::DEFAULT_INITIAL_VERSION = 1

Definition at line 110 of file Catalog.cpp.

Referenced by Catalog_Namespace::Catalog::updateDeletedColumnIndicator(), Catalog_Namespace::Catalog::updateDictionaryNames(), and Catalog_Namespace::Catalog::updatePageSize().

bool Catalog_Namespace::g_log_user_id {false}

Definition at line 156 of file SysCatalog.cpp.

Referenced by Catalog_Namespace::SysCatalog::alterUser(), Catalog_Namespace::SysCatalog::checkPrivileges(), Catalog_Namespace::SysCatalog::createUser(), Catalog_Namespace::SysCatalog::dropUser(), CommandLineOptions::fillOptions(), Catalog_Namespace::SysCatalog::getMetadataWithDefaultDB(), parseUserMetadataFromSQLite(), Catalog_Namespace::SysCatalog::renameUser(), Catalog_Namespace::UserMetadata::userLoggable(), and CommandLineOptions::validate().

const std::array<std::string, 4> Catalog_Namespace::kAggregatorOnlySystemTables

static

Initial value:

{
    DASHBOARDS_SYS_TABLE_NAME,
    REQUEST_LOGS_SYS_TABLE_NAME,
    WS_SERVER_LOGS_SYS_TABLE_NAME,
    WS_SERVER_ACCESS_LOGS_SYS_TABLE_NAME}

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

const int Catalog_Namespace::MAPD_TEMP_TABLE_START_ID

Initial value:

=

1073741824

Definition at line 111 of file Catalog.cpp.

constexpr const char* Catalog_Namespace::MEMORY_DETAILS_SYS_TABLE_NAME {"memory_details"}

static

Definition at line 112 of file Catalog.h.

Referenced by Catalog_Namespace::Catalog::initializeMemoryDetailsSystemTable(), foreign_storage::InternalMemoryStatsDataWrapper::initializeObjectsForTable(), and foreign_storage::InternalMemoryStatsDataWrapper::populateChunkBuffersForTable().

constexpr const char* Catalog_Namespace::MEMORY_SUMMARY_SYS_TABLE_NAME {"memory_summary"}

static

Definition at line 111 of file Catalog.h.

Referenced by Catalog_Namespace::Catalog::initializeMemorySummarySystemTable(), foreign_storage::InternalMemoryStatsDataWrapper::initializeObjectsForTable(), and foreign_storage::InternalMemoryStatsDataWrapper::populateChunkBuffersForTable().

constexpr const char* Catalog_Namespace::PERMISSIONS_SYS_TABLE_NAME {"permissions"}

static

Definition at line 108 of file Catalog.h.

Referenced by foreign_storage::InternalCatalogDataWrapper::initializeObjectsForTable(), Catalog_Namespace::Catalog::initializePermissionsSystemTable(), and foreign_storage::InternalCatalogDataWrapper::populateChunkBuffersForTable().

constexpr const char* Catalog_Namespace::REQUEST_LOGS_SYS_TABLE_NAME {"request_logs"}

static

Definition at line 115 of file Catalog.h.

Referenced by RefreshForeignTablesCommand::execute(), Catalog_Namespace::Catalog::initializeRequestLogsSystemTables(), and Catalog_Namespace::Catalog::initializeSystemTables().

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

static

Definition at line 110 of file Catalog.h.

Referenced by foreign_storage::InternalCatalogDataWrapper::initializeObjectsForTable(), Catalog_Namespace::Catalog::initializeRoleAssignmentsSystemTable(), and foreign_storage::InternalCatalogDataWrapper::populateChunkBuffersForTable().

constexpr const char* Catalog_Namespace::ROLES_SYS_TABLE_NAME {"roles"}

static

Definition at line 109 of file Catalog.h.

Referenced by foreign_storage::InternalCatalogDataWrapper::initializeObjectsForTable(), Catalog_Namespace::Catalog::initializeRolesSystemTable(), and foreign_storage::InternalCatalogDataWrapper::populateChunkBuffersForTable().

constexpr const char* Catalog_Namespace::SERVER_LOGS_SYS_TABLE_NAME {"server_logs"}

static

Definition at line 114 of file Catalog.h.

Referenced by RefreshForeignTablesCommand::execute(), Catalog_Namespace::Catalog::initializeServerLogsSystemTables(), and Catalog_Namespace::Catalog::initializeSystemTables().

const size_t Catalog_Namespace::SESSION_ID_LENGTH = 32

Definition at line 127 of file SessionInfo.h.

Referenced by CachedSessionStore::add().

constexpr const char* Catalog_Namespace::STORAGE_DETAILS_SYS_TABLE_NAME {"storage_details"}

static

Definition at line 113 of file Catalog.h.

Referenced by foreign_storage::InternalStorageStatsDataWrapper::initializeObjectsForTable(), Catalog_Namespace::Catalog::initializeStorageDetailsSystemTable(), and foreign_storage::InternalStorageStatsDataWrapper::populateChunkBuffersForTable().

constexpr const char* Catalog_Namespace::TABLES_SYS_TABLE_NAME {"tables"}

static

Definition at line 105 of file Catalog.h.

Referenced by foreign_storage::InternalCatalogDataWrapper::initializeObjectsForTable(), Catalog_Namespace::Catalog::initializeTablesSystemTable(), and foreign_storage::InternalCatalogDataWrapper::populateChunkBuffersForTable().

constexpr const char* Catalog_Namespace::USERS_SYS_TABLE_NAME {"users"}

static

Definition at line 104 of file Catalog.h.

Referenced by foreign_storage::InternalCatalogDataWrapper::initializeObjectsForTable(), Catalog_Namespace::Catalog::initializeUsersSystemTable(), and foreign_storage::InternalCatalogDataWrapper::populateChunkBuffersForTable().

constexpr const char* Catalog_Namespace::WS_SERVER_ACCESS_LOGS_SYS_TABLE_NAME

static

Initial value:

{

"web_server_access_logs"}

Definition at line 117 of file Catalog.h.

Referenced by RefreshForeignTablesCommand::execute(), Catalog_Namespace::Catalog::initializeSystemTables(), and Catalog_Namespace::Catalog::initializeWebServerAccessLogsSystemTables().

constexpr const char* Catalog_Namespace::WS_SERVER_LOGS_SYS_TABLE_NAME {"web_server_logs"}

static

Definition at line 116 of file Catalog.h.

Referenced by RefreshForeignTablesCommand::execute(), Catalog_Namespace::Catalog::initializeSystemTables(), and Catalog_Namespace::Catalog::initializeWebServerLogsSystemTables().

Namespaces

Classes

Typedefs

Enumerations

Functions

Variables

Typedef Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation