dd::Dictionary Class Reference

Main interface class enabling users to operate on data dictionary. More...

#include <dictionary.h>

Inheritance diagram for dd::Dictionary:

Public Member Functions
virtual const Object_table *	get_dd_table (const String_type &schema_name, const String_type &table_name) const =0
	Get dictionary object for a given dictionary table name. More...
virtual bool	is_dd_schema_name (const String_type &schema_name) const =0
	Check if the given schema name is 'mysql', which where the DD tables are stored. More...
virtual bool	is_dd_table_name (const String_type &schema_name, const String_type &table_name) const =0
	Check if given table name is a dictionary table name. More...
virtual bool	is_system_table_name (const String_type &schema_name, const String_type &table_name) const =0
	Check if given table name is a system table name. More...
virtual int	table_type_error_code (const String_type &schema_name, const String_type &table_name) const =0
	Get the error code representing the type name string for a dictionary or system table. More...
virtual bool	is_dd_table_access_allowed (bool is_dd_internal_thread, bool is_ddl_statement, const char *schema_name, size_t schema_length, const char *table_name) const =0
	Check if given table name can be accessed by the given thread type. More...
virtual bool	is_system_view_name (const char *schema_name, const char *table_name, bool *hidden) const =0
	Check if given table name is a system view name. More...
virtual bool	is_system_view_name (const char *schema_name, const char *table_name) const =0
	Check if given table name is a system view name. More...
virtual	~Dictionary ()=default

Detailed Description

Main interface class enabling users to operate on data dictionary.

Constructor & Destructor Documentation

~Dictionary()

virtual dd::Dictionary::~Dictionary ( )

virtualdefault

Member Function Documentation

get_dd_table()

virtual const Object_table * dd::Dictionary::get_dd_table ( const String_type &  schema_name, const String_type &  table_name  ) const

pure virtual

Get dictionary object for a given dictionary table name.

If the given schema_name and table_name is not a dictionary table name, then the function returns NULL.

Returns

Pointer to dictionary object for the given dictionary table name, else NULL.

Implemented in dd::Dictionary_impl.

is_dd_schema_name()

virtual bool dd::Dictionary::is_dd_schema_name ( const String_type &  schema_name ) const

pure virtual

Check if the given schema name is 'mysql', which where the DD tables are stored.

Parameters

schema_name

Schema name to check.

Returns

true - If schema_name is 'mysql'

false - If schema_name is not 'mysql'

Implemented in dd::Dictionary_impl.

is_dd_table_access_allowed()

virtual bool dd::Dictionary::is_dd_table_access_allowed ( bool  is_dd_internal_thread, bool  is_ddl_statement, const char *  schema_name, size_t  schema_length, const char *  table_name  ) const

pure virtual

Check if given table name can be accessed by the given thread type.

Parameters

is_dd_internal_thread	'true' if this is a DD internal thread.
is_ddl_statement	'true' if this is a DDL statement.
schema_name	Schema name to check.
schema_length	Length of schema name to check.
table_name	Table name to check.

Returns

true - If given table name is accessible by the thread type.

false - If table name is not accessible.

Implemented in dd::Dictionary_impl.

is_dd_table_name()

virtual bool dd::Dictionary::is_dd_table_name ( const String_type &  schema_name, const String_type &  table_name  ) const

pure virtual

Check if given table name is a dictionary table name.

Parameters

schema_name	Schema name to check.
table_name	Table name to check.

Returns

true - If given table name is a dictionary table.

false - If table name is not a dictionary table.

Implemented in dd::Dictionary_impl.

is_system_table_name()

virtual bool dd::Dictionary::is_system_table_name ( const String_type &  schema_name, const String_type &  table_name  ) const

pure virtual

Check if given table name is a system table name.

Parameters

schema_name	Schema name to check.
table_name	Table name to check.

Returns

true - If given table name is a system table.

false - If table name is not a system table.

Implemented in dd::Dictionary_impl.

is_system_view_name() [1/2]

virtual bool dd::Dictionary::is_system_view_name ( const char *  schema_name, const char *  table_name  ) const

pure virtual

Check if given table name is a system view name.

Parameters

schema_name	Schema name to check.
table_name	Table name to check.

Returns

true - If given table name is a system view.

false - If table name is not a system view.

Implemented in dd::Dictionary_impl.

is_system_view_name() [2/2]

virtual bool dd::Dictionary::is_system_view_name ( const char *  schema_name, const char *  table_name, bool *  hidden  ) const

pure virtual

Check if given table name is a system view name.

Parameters

	schema_name	Schema name to check.
	table_name	Table name to check.
[out]	hidden	Pointer to boolean flag indicating if the object is hidden.

Returns

true - If given table name is a system view.

false - If table name is not a system view.

Implemented in dd::Dictionary_impl.

table_type_error_code()

virtual int dd::Dictionary::table_type_error_code ( const String_type &  schema_name, const String_type &  table_name  ) const

pure virtual

Get the error code representing the type name string for a dictionary or system table.

Necessary to support localization of error messages.

Parameters

schema_name	Schema name to check.
table_name	Table name to check.

Returns

The error code representing the type name associated with the table, for being used in error messages.

Implemented in dd::Dictionary_impl.

---

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

• sql/dd/dictionary.h