DB Restrictions representation in memory. More...

#include <partial_revokes.h>

Inheritance diagram for DB_restrictions:

Public Member Functions
	DB_restrictions (MEM_ROOT *mem_root)
	DB Restrictions constructor. More...

virtual	~DB_restrictions () override
	Destructor. More...

db_revocations &	operator() (void)

	DB_restrictions (const DB_restrictions &restrictions)
	Copy constructor for DB Restrictions. More...

	DB_restrictions (DB_restrictions &&restrictions)=delete

DB_restrictions &	operator= (const DB_restrictions &restrictions)
	Assignment operator. More...

DB_restrictions &	operator= (DB_restrictions &&restrictions)
	Assignment operator. More...

bool	operator== (const DB_restrictions &restrictions) const
	Compare the two restrictions. More...

void	add (const std::string &db_name, const ulong revoke_privs)
	Add given privileges as restricted for the database. More...

void	add (const DB_restrictions &restrictions)
	Add restriction information from source DB_restrictions. More...

bool	add (const Json_object &json_object)
	Deserializer. More...

void	remove (const std::string &db_name, const ulong revoke_privs)
	Remove given set of privilegs for a database from restriction list. More...

void	remove (const ulong revoke_privs)
	Remove given set of privs from restricted list for all databases. More...

bool	find (const std::string &db_name, ulong &access) const
	Get restricted access information for given database. More...

bool	is_empty () const override
	Status function to check if restriction list is empty. More...

bool	is_not_empty () const
	Status function to check if restriction list is non-empty. More...

size_t	size () const override
	Status function to get number of entries in restriction list. More...

void	clear () override
	Clear restriction list. More...

void	get_as_json (Json_array &restrictions_array) const
	Serializer. More...

const db_revocations &	get () const

bool	has_more_restrictions (const DB_restrictions &, ulong) const
	Compare is two restriction list for given privileges. More...

Public Member Functions inherited from Abstract_restrictions
	Abstract_restrictions (MEM_ROOT *mem_root)
	Abstract restriction constructor. More...

virtual	~Abstract_restrictions ()
	Abstract restriction destructor. More...

Private Member Functions
db_revocations &	db_restrictions ()

void	remove (const ulong remove_restrictions, ulong &restrictions_mask) const noexcept
	Private function: Remove given set of privs from restricted list. More...

Private Attributes
db_revocations	m_restrictions
	Database restrictions. More...

Additional Inherited Members
Protected Attributes inherited from Abstract_restrictions
Mem_root_base	m_mem_root_base
	MEM_ROOT manager. More...

Detailed Description

DB Restrictions representation in memory.

It uses memroot based, collation aware map to store (<dbname>, <restricted_access>) mapping.

Each object created in the MEM_ROOT has to be destroyed manually. It will be the client's responsibility that create the objects.

It also provides functions to:

Manage DB restrictions
Status functions
Transformation of in memory db restrictions

Constructor & Destructor Documentation

◆ DB_restrictions() [1/3]

DB_restrictions::DB_restrictions ( MEM_ROOT * mem_root )

DB Restrictions constructor.

Parameters

[in] mem_root MEM_ROOT handle. Can be nullptr.

◆ ~DB_restrictions()

DB_restrictions::~DB_restrictions ( )

overridevirtual

Destructor.

◆ DB_restrictions() [2/3]

DB_restrictions::DB_restrictions ( const DB_restrictions & restrictions )

Copy constructor for DB Restrictions.

Parameters

[in] restrictions Source DB restrictions

◆ DB_restrictions() [3/3]

DB_restrictions::DB_restrictions ( DB_restrictions && restrictions )

delete

Member Function Documentation

◆ add() [1/3]

void DB_restrictions::add ( const DB_restrictions & restrictions )

Add restriction information from source DB_restrictions.

Parameters

[in] restrictions List of <database, privileges>

◆ add() [2/3]

bool DB_restrictions::add ( const Json_object & json_object )

Deserializer.

Converts a JSON object to <database, privileges> list.

Parameters

[in] json_object Restrictions represented by JSON

Returns: Status of transformation.

Return values

true	Error in deserializing the data.
false	All good.

◆ add() [3/3]

void DB_restrictions::add	(	const std::string &	db_name,
		const ulong	revoke_privs
	)

Add given privileges as restricted for the database.

Parameters

[in]	db_name	Database information
[in]	revoke_privs	Privileges to be restricted

◆ clear()

void DB_restrictions::clear ( )

overridevirtual

Clear restriction list.

Implements Abstract_restrictions.

◆ db_restrictions()

db_revocations& DB_restrictions::db_restrictions ( )

inlineprivate

◆ find()

bool DB_restrictions::find	(	const std::string &	db_name,
		ulong &	access
	)		const

Get restricted access information for given database.

Parameters

[in]	db_name	Database information
[out]	access	Restricted access

Returns: Status of search

Return values

true	Entry found.
false	Entry not found. Do not rely on access.

◆ get()

const db_revocations& DB_restrictions::get ( ) const

inline

◆ get_as_json()

void DB_restrictions::get_as_json ( Json_array & restrictions_array ) const

Serializer.

Converts restriction list to JSON format.

This is used while storing restriction list in ACL table.

◆ has_more_restrictions()

bool DB_restrictions::has_more_restrictions	(	const DB_restrictions &	other,
		ulong	access
	)		const

Compare is two restriction list for given privileges.

Parameters

[in]	other	DB_restrictions to compare against
[in]	access	Privilege filter

Returns: Comparison result of two restriction lists

Return values

false	Other restriction list has less or equal restrictions
true	Otherwise

◆ is_empty()

bool DB_restrictions::is_empty ( ) const

overridevirtual

Status function to check if restriction list is empty.

Implements Abstract_restrictions.

◆ is_not_empty()

bool DB_restrictions::is_not_empty ( ) const

Status function to check if restriction list is non-empty.

◆ operator()()

db_revocations& DB_restrictions::operator() ( void )

inline

◆ operator=() [1/2]

DB_restrictions & DB_restrictions::operator= ( const DB_restrictions & restrictions )

Assignment operator.

Parameters

[in] restrictions Source DB restrictions

◆ operator=() [2/2]

DB_restrictions & DB_restrictions::operator= ( DB_restrictions && restrictions )

Assignment operator.

Parameters

[in] restrictions Source DB restrictions

◆ operator==()

bool DB_restrictions::operator== ( const DB_restrictions & restrictions ) const

Compare the two restrictions.

Parameters

[in] restrictions DB_restrictions object to be compared with this

Returns

Return values

true	If both DB_restrictions are same
false	Otherwise

◆ remove() [1/3]

void DB_restrictions::remove	(	const std::string &	db_name,
		const ulong	revoke_privs
	)

Remove given set of privilegs for a database from restriction list.

Parameters

[in]	db_name	Database information
[in]	revoke_privs	List of privileges to remove

◆ remove() [2/3]

void DB_restrictions::remove	(	const ulong	remove_restrictions,
		ulong &	restriction_mask
	)		const

privatenoexcept

Private function: Remove given set of privs from restricted list.

Parameters

[in]	remove_restrictions	Restriction to be removed
[out]	restriction_mask	Resultant value to be returned

◆ remove() [3/3]

void DB_restrictions::remove ( const ulong revoke_privs )

Remove given set of privs from restricted list for all databases.

If it turns out to be no restrictions on a DB after removal of the restrictions, then remove the db_name entry from the internal container as well.

Parameters

[in] revoke_privs Privileges to be removed

◆ size()

size_t DB_restrictions::size ( ) const

overridevirtual

Status function to get number of entries in restriction list.

Implements Abstract_restrictions.

Member Data Documentation

◆ m_restrictions

db_revocations DB_restrictions::m_restrictions

private

Database restrictions.

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

sql/auth/partial_revokes.h
sql/auth/partial_revokes.cc

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DB_restrictions() [1/3]

◆ ~DB_restrictions()

◆ DB_restrictions() [2/3]

◆ DB_restrictions() [3/3]

Member Function Documentation

◆ add() [1/3]

◆ add() [2/3]

◆ add() [3/3]

◆ clear()

◆ db_restrictions()

◆ find()

◆ get()

◆ get_as_json()

◆ has_more_restrictions()

◆ is_empty()

◆ is_not_empty()

◆ operator()()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ remove() [1/3]

◆ remove() [2/3]

◆ remove() [3/3]

◆ size()

Member Data Documentation

◆ m_restrictions