DBObject Class Reference

#include <DBObject.h>

Collaboration diagram for DBObject:

Public Member Functions
	DBObject (const std::string &name, const DBObjectType &objectAndPermissionType)
	DBObject (const int32_t id, const DBObjectType &objectAndPermissionType)
	DBObject (DBObjectKey key, AccessPrivileges privs, int32_t owner)
	DBObject (const DBObject &object)
	DBObject (const std::string &name, DBObjectType type, DBObjectKey key, AccessPrivileges privs, int32_t owner)
	~DBObject ()
void	setObjectType (const DBObjectType &objectType)
void	setName (std::string name)
std::string	getName () const
DBObjectType	getType () const
DBObjectKey	getObjectKey () const
void	setObjectKey (const DBObjectKey &objectKey)
const AccessPrivileges &	getPrivileges () const
void	setPrivileges (const AccessPrivileges &privs)
void	resetPrivileges ()
void	copyPrivileges (const DBObject &object)
void	updatePrivileges (const DBObject &object)
void	grantPrivileges (const DBObject &object)
void	revokePrivileges (const DBObject &object)
void	setPermissionType (const DBObjectType &permissionType)
int32_t	getOwner () const
void	setOwner (int32_t userId)
std::vector< std::string >	toString () const
void	loadKey ()
void	loadKey (const Catalog_Namespace::Catalog &catalog)
bool	valid () const

Private Attributes
std::string	objectName_
DBObjectType	objectType_
DBObjectKey	objectKey_
AccessPrivileges	objectPrivs_
int32_t	ownerId_

Detailed Description

Definition at line 194 of file DBObject.h.

Constructor & Destructor Documentation

DBObject::DBObject	(	const std::string &	name,
		const DBObjectType &	objectAndPermissionType
	)

Definition at line 126 of file DBObject.cpp.

References objectKey_, objectType_, ownerId_, and DBObjectKey::permissionType.

    : objectName_(name) {
  objectType_ = objectAndPermissionType;
  objectKey_.permissionType = objectAndPermissionType;
  ownerId_ = 0;
}

DBObject::DBObject	(	const int32_t	id,
		const DBObjectType &	objectAndPermissionType
	)

Definition at line 133 of file DBObject.cpp.

References DBObjectKey::objectId, objectKey_, objectType_, ownerId_, and DBObjectKey::permissionType.

    : objectName_("") {
  objectType_ = objectAndPermissionType;
  objectKey_.permissionType = objectAndPermissionType;
  objectKey_.objectId = id;
  ownerId_ = 0;
}

DBObject::DBObject ( DBObjectKey  key, AccessPrivileges  privs, int32_t  owner  )

inline

Definition at line 198 of file DBObject.h.

      : objectName_("")
      , objectType_(AbstractDBObjectType)
      , objectKey_(key)
      , objectPrivs_(privs)
      , ownerId_(owner){};

DBObject::DBObject

(

const DBObject &

object

)

Definition at line 141 of file DBObject.cpp.

References copyPrivileges(), objectKey_, objectType_, and setObjectKey().

    : objectName_(object.objectName_), ownerId_(object.ownerId_) {
  objectType_ = object.objectType_;
  setObjectKey(object.objectKey_);
  copyPrivileges(object);
}

Here is the call graph for this function:

DBObject::DBObject ( const std::string &  name, DBObjectType  type, DBObjectKey  key, AccessPrivileges  privs, int32_t  owner  )

inline

Definition at line 205 of file DBObject.h.

      : objectName_(name)
      , objectType_(type)
      , objectKey_(key)
      , objectPrivs_(privs)
      , ownerId_(owner){};

DBObject::~DBObject ( )

inline

Definition at line 215 of file DBObject.h.

{}

Member Function Documentation

void DBObject::copyPrivileges

(

const DBObject &

object

)

Definition at line 148 of file DBObject.cpp.

References objectPrivs_.

Referenced by DBObject().

                                                    {
  objectPrivs_ = object.objectPrivs_;
}

Here is the caller graph for this function:

std::string DBObject::getName ( ) const

inline

Definition at line 219 of file DBObject.h.

References objectName_.

Referenced by loadKey(), and serialize_db_object().

{ return objectName_; }

Here is the caller graph for this function:

DBObjectKey DBObject::getObjectKey ( ) const

inline

load key not called?

Definition at line 221 of file DBObject.h.

References CHECK, DBObjectKey::dbId, and objectKey_.

Referenced by Grantee::checkPrivileges(), DBHandler::get_db_object_privs(), DBHandler::has_object_privilege(), Grantee::hasAnyPrivileges(), Catalog_Namespace::SysCatalog::revokeDBObjectPrivilegesFromAll_unsafe(), and serialize_db_object().

                                   {
    CHECK(-1 != objectKey_.dbId); 
    return objectKey_;
  }

Here is the caller graph for this function:

int32_t DBObject::getOwner ( ) const

inline

Definition at line 234 of file DBObject.h.

References ownerId_.

{ return ownerId_; }

const AccessPrivileges& DBObject::getPrivileges ( ) const

inline

Definition at line 226 of file DBObject.h.

References objectPrivs_.

Referenced by Parser::ShowPrivilegesStmt::execute(), DBHandler::get_dashboard_impl(), hasAnyPrivs(), hasEnoughPrivs(), and serialize_db_object().

{ return objectPrivs_; }

Here is the caller graph for this function:

DBObjectType DBObject::getType ( ) const

inline

Definition at line 220 of file DBObject.h.

References objectType_.

Referenced by serialize_db_object().

{ return objectType_; }

Here is the caller graph for this function:

void DBObject::grantPrivileges ( const DBObject &  object )

inline

Definition at line 231 of file DBObject.h.

References updatePrivileges().

{ updatePrivileges(object); }

Here is the call graph for this function:

void DBObject::loadKey

(

)

Definition at line 190 of file DBObject.cpp.

References CHECK, DatabaseDBObjectType, DBObjectKey::dbId, Catalog_Namespace::DBMetadata::dbId, Catalog_Namespace::DBMetadata::dbName, Catalog_Namespace::DBMetadata::dbOwner, getName(), Catalog_Namespace::SysCatalog::instance(), objectKey_, objectName_, objectType_, and ownerId_.

Referenced by Parser::check_alter_table_privilege(), anonymous_namespace{Calcite.cpp}::check_db_access(), DBHandler::check_table_load_privileges(), DBHandler::connect(), ShowCreateServerCommand::execute(), ShowCreateTableCommand::execute(), ShowUserDetailsCommand::execute(), Parser::TruncateTableStmt::execute(), Parser::CopyTableStmt::execute(), Catalog_Namespace::Catalog::filterTableByTypeAndUser(), DBHandler::get_db_object_privs(), Catalog_Namespace::SysCatalog::getDatabaseListForUser(), Catalog_Namespace::Catalog::getForeignServersForUser(), DBHandler::has_object_privilege(), DBHandler::hasTableAccessPrivileges(), DBHandler::internal_connect(), loadKey(), Catalog_Namespace::SysCatalog::revokeDBObjectPrivilegesFromAll_unsafe(), Catalog_Namespace::SysCatalog::switchDatabase(), DBHandler::user_can_access_table(), and Parser::anonymous_namespace{ParserNode.cpp}::user_can_access_table().

                       {
  CHECK(objectType_ == DatabaseDBObjectType);
  if (!getName().empty()) {
    Catalog_Namespace::DBMetadata db;
    if (!Catalog_Namespace::SysCatalog::instance().getMetadataForDB(getName(), db)) {
      throw std::runtime_error("Failure generating DB object key. Database " + getName() +
                               " does not exist.");
    }
    objectKey_.dbId = db.dbId;
    ownerId_ = db.dbOwner;
    objectName_ = db.dbName;
  } else {
    objectKey_.dbId = 0;  // very special case only used for initialisation of a role
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void DBObject::loadKey

(

const Catalog_Namespace::Catalog &

catalog

)

Definition at line 206 of file DBObject.cpp.

References CHECK, DashboardDBObjectType, DatabaseDBObjectType, DBObjectKey::dbId, Catalog_Namespace::DBMetadata::dbId, Catalog_Namespace::DBMetadata::dbOwner, Catalog_Namespace::Catalog::getCurrentDB(), Catalog_Namespace::Catalog::getForeignServer(), Catalog_Namespace::Catalog::getMetadataForDashboard(), Catalog_Namespace::Catalog::getMetadataForTable(), getName(), loadKey(), DBObjectKey::objectId, objectKey_, objectName_, objectType_, ownerId_, ServerDBObjectType, TableDBObjectType, to_string(), and ViewDBObjectType.

                                                              {
  switch (objectType_) {
    case DatabaseDBObjectType: {
      loadKey();
      break;
    }
    case ServerDBObjectType: {
      objectKey_.dbId = catalog.getCurrentDB().dbId;

      if (!getName().empty()) {
        auto server = catalog.getForeignServer(getName());
        if (!server) {
          throw std::runtime_error("Failure generating DB object key. Server " +
                                   getName() + " does not exist.");
        }
        objectKey_.objectId = server->id;
        ownerId_ = server->user_id;
      } else {
        ownerId_ = catalog.getCurrentDB().dbOwner;
      }

      break;
    }
    case ViewDBObjectType:
    case TableDBObjectType: {
      objectKey_.dbId = catalog.getCurrentDB().dbId;

      if (!getName().empty()) {
        auto table =
            catalog.getMetadataForTable(getName(), false /* do not populate fragments */);
        if (!table) {
          throw std::runtime_error("Failure generating DB object key. Table/View " +
                                   getName() + " does not exist.");
        }
        objectKey_.objectId = table->tableId;
        ownerId_ = table->userId;
      } else {
        ownerId_ = catalog.getCurrentDB().dbOwner;
      }

      break;
    }
    case DashboardDBObjectType: {
      objectKey_.dbId = catalog.getCurrentDB().dbId;

      if (objectKey_.objectId > 0) {
        auto dashboard = catalog.getMetadataForDashboard(objectKey_.objectId);
        if (!dashboard) {
          throw std::runtime_error(
              "Failure generating DB object key. Dashboard with ID " +
              std::to_string(objectKey_.objectId) + " does not exist.");
        }
        objectName_ = dashboard->dashboardName;
        ownerId_ = dashboard->userId;
      } else {
        ownerId_ = catalog.getCurrentDB().dbOwner;
      }

      break;
    }
    default:
      CHECK(false);
  }
}

Here is the call graph for this function:

void DBObject::resetPrivileges ( )

inline

Definition at line 228 of file DBObject.h.

References objectPrivs_, and AccessPrivileges::reset().

{ objectPrivs_.reset(); }

Here is the call graph for this function:

void DBObject::revokePrivileges

(

const DBObject &

object

)

Definition at line 156 of file DBObject.cpp.

References objectPrivs_, and AccessPrivileges::privileges.

                                                      {
  objectPrivs_.privileges &= ~(object.objectPrivs_.privileges);
}

void DBObject::setName ( std::string  name )

inline

Definition at line 218 of file DBObject.h.

References setup::name, and objectName_.

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

{ objectName_ = name; }

Here is the caller graph for this function:

void DBObject::setObjectKey ( const DBObjectKey &  objectKey )

inline

Definition at line 225 of file DBObject.h.

References objectKey_.

Referenced by Catalog_Namespace::SysCatalog::createRole_unsafe(), DBObject(), Catalog_Namespace::Catalog::recordOwnershipOfObjectsInObjectPermissions(), and Catalog_Namespace::SysCatalog::renameDBObject().

{ objectKey_ = objectKey; }

Here is the caller graph for this function:

void DBObject::setObjectType

(

const DBObjectType &

objectType

)

Definition at line 163 of file DBObject.cpp.

References objectType_.

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

                                                           {
  objectType_ = objectType;
}

Here is the caller graph for this function:

void DBObject::setOwner ( int32_t  userId )

inline

Definition at line 235 of file DBObject.h.

References ownerId_.

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

{ ownerId_ = userId; }

Here is the caller graph for this function:

void DBObject::setPermissionType

(

const DBObjectType &

permissionType

)

Definition at line 160 of file DBObject.cpp.

References objectKey_, and DBObjectKey::permissionType.

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

                                                                   {
  objectKey_.permissionType = permissionType;
}

Here is the caller graph for this function:

void DBObject::setPrivileges ( const AccessPrivileges &  privs )

inline

Definition at line 227 of file DBObject.h.

References objectPrivs_.

Referenced by Catalog_Namespace::anonymous_namespace{Catalog.cpp}::add_db_object(), Parser::check_alter_table_privilege(), anonymous_namespace{Calcite.cpp}::check_db_access(), DBHandler::check_table_load_privileges(), DBHandler::connect(), Parser::TruncateTableStmt::execute(), Parser::CopyTableStmt::execute(), Catalog_Namespace::SysCatalog::getDatabaseListForUser(), Catalog_Namespace::SysCatalog::grantAllOnDatabase_unsafe(), DBHandler::internal_connect(), Catalog_Namespace::Catalog::recordOwnershipOfObjectsInObjectPermissions(), Catalog_Namespace::SysCatalog::revokeDBObjectPrivilegesFromAll_unsafe(), Catalog_Namespace::SysCatalog::switchDatabase(), DBHandler::user_can_access_table(), and Parser::anonymous_namespace{ParserNode.cpp}::user_can_access_table().

{ objectPrivs_ = privs; }

Here is the caller graph for this function:

std::vector< std::string > DBObject::toString

(

)

const

Definition at line 167 of file DBObject.cpp.

References CHECK, DashboardDBObjectType, DatabaseDBObjectType, DBObjectKey::dbId, DBObjectKey::objectId, objectKey_, DBObjectKey::permissionType, ServerDBObjectType, TableDBObjectType, to_string(), and ViewDBObjectType.

                                              {
  std::vector<std::string> objectKey;
  switch (objectKey_.permissionType) {
    case DatabaseDBObjectType:
      objectKey.push_back(std::to_string(objectKey_.permissionType));
      objectKey.push_back(std::to_string(objectKey_.dbId));
      objectKey.push_back(std::to_string(-1));
      break;
    case TableDBObjectType:
    case DashboardDBObjectType:
    case ViewDBObjectType:
    case ServerDBObjectType:
      objectKey.push_back(std::to_string(objectKey_.permissionType));
      objectKey.push_back(std::to_string(objectKey_.dbId));
      objectKey.push_back(std::to_string(objectKey_.objectId));
      break;
    default: {
      CHECK(false);
    }
  }
  return objectKey;
}

Here is the call graph for this function:

void DBObject::updatePrivileges

(

const DBObject &

object

)

Definition at line 152 of file DBObject.cpp.

References objectPrivs_, and AccessPrivileges::privileges.

Referenced by grantPrivileges(), and Catalog_Namespace::SysCatalog::migrateDBAccessPrivileges().

                                                      {
  objectPrivs_.privileges |= object.objectPrivs_.privileges;
}

Here is the caller graph for this function:

bool DBObject::valid ( ) const

inline

Definition at line 240 of file DBObject.h.

References AbstractDBObjectType, DBObjectKey::dbId, objectKey_, objectType_, and DBObjectKey::permissionType.

                     {
    return (objectType_ != AbstractDBObjectType && objectKey_.permissionType != -1 &&
            objectKey_.dbId != -1);
  }

Member Data Documentation

DBObjectKey DBObject::objectKey_

private

Definition at line 248 of file DBObject.h.

Referenced by DBObject(), getObjectKey(), loadKey(), setObjectKey(), setPermissionType(), toString(), and valid().

std::string DBObject::objectName_

private

Definition at line 246 of file DBObject.h.

Referenced by getName(), loadKey(), and setName().

AccessPrivileges DBObject::objectPrivs_

private

Definition at line 249 of file DBObject.h.

Referenced by copyPrivileges(), getPrivileges(), resetPrivileges(), revokePrivileges(), setPrivileges(), and updatePrivileges().

DBObjectType DBObject::objectType_

private

Definition at line 247 of file DBObject.h.

Referenced by DBObject(), getType(), loadKey(), setObjectType(), and valid().

int32_t DBObject::ownerId_

private

Definition at line 250 of file DBObject.h.

Referenced by DBObject(), getOwner(), loadKey(), and setOwner().

---

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

• /home/jenkins-slave/workspace/core-os-doxygen/Catalog/DBObject.h
• /home/jenkins-slave/workspace/core-os-doxygen/Catalog/DBObject.cpp