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

Functions
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)

Variables
const int	DEFAULT_INITIAL_VERSION = 1
const int	MAPD_TEMP_TABLE_START_ID
const int	MAPD_TEMP_DICT_START_ID
bool	g_log_user_id {false}

Typedef Documentation

using Catalog_Namespace::cat_read_lock = typedef read_lock<Catalog>

Definition at line 112 of file Catalog.cpp.

using Catalog_Namespace::cat_sqlite_lock = typedef sqlite_lock<Catalog>

Definition at line 114 of file Catalog.cpp.

using Catalog_Namespace::cat_write_lock = typedef write_lock<Catalog>

Definition at line 113 of file Catalog.cpp.

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

Definition at line 37 of file Types.h.

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

Definition at line 39 of file Types.h.

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

Definition at line 38 of file Types.h.

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

Definition at line 36 of file Types.h.

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

Definition at line 42 of file Types.h.

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

Definition at line 123 of file SysCatalog.h.

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

Definition at line 46 of file Types.h.

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

Definition at line 40 of file Types.h.

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

Definition at line 48 of file Types.h.

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

Definition at line 50 of file Types.h.

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

Definition at line 43 of file Types.h.

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

Definition at line 44 of file Types.h.

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

Definition at line 35 of file Types.h.

typedef read_lock< SysCatalog > Catalog_Namespace::sys_read_lock

Definition at line 111 of file Catalog.cpp.

using Catalog_Namespace::sys_sqlite_lock = typedef sqlite_lock<SysCatalog>

Definition at line 81 of file SysCatalog.cpp.

using Catalog_Namespace::sys_write_lock = typedef write_lock<SysCatalog>

Definition at line 80 of file SysCatalog.cpp.

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

Definition at line 33 of file Types.h.

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

Definition at line 34 of file Types.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 4314 of file Catalog.cpp.

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

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

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

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

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

References reserved_keywords, and to_upper().

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

                                                        {
  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:

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

Definition at line 53 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  )

static

Definition at line 1250 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::SysCatalog::getMetadataForUser(), and Catalog_Namespace::SysCatalog::getMetadataForUserById().

                                                            {
  int numRows = conn->getNumRows();
  if (numRows == 0) {
    return false;
  }
  user.userId = conn->getData<int>(0, 0);
  user.userName = conn->getData<string>(0, 1);
  user.passwd_hash = conn->getData<string>(0, 2);
  user.isSuper = conn->getData<bool>(0, 3);
  user.defaultDbId = conn->isNull(0, 4) ? -1 : conn->getData<int>(0, 4);
  if (conn->isNull(0, 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(0, 5) ? false : conn->getData<bool>(0, 5);
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

const int Catalog_Namespace::DEFAULT_INITIAL_VERSION = 1

Definition at line 101 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 83 of file SysCatalog.cpp.

Referenced by 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 int Catalog_Namespace::MAPD_TEMP_DICT_START_ID

Initial value:

=
    1073741824

Definition at line 104 of file Catalog.cpp.

const int Catalog_Namespace::MAPD_TEMP_TABLE_START_ID

Initial value:

=
    1073741824

Definition at line 102 of file Catalog.cpp.