MySQL 8.4.2
Source Code Documentation
dd::tables::Tables Class Reference

#include <tables.h>

Inheritance diagram for dd::tables::Tables:
[legend]

Public Types

enum  enum_fields {
  FIELD_ID , FIELD_SCHEMA_ID , FIELD_NAME , FIELD_TYPE ,
  FIELD_ENGINE , FIELD_MYSQL_VERSION_ID , FIELD_ROW_FORMAT , FIELD_COLLATION_ID ,
  FIELD_COMMENT , FIELD_HIDDEN , FIELD_OPTIONS , FIELD_SE_PRIVATE_DATA ,
  FIELD_SE_PRIVATE_ID , FIELD_TABLESPACE_ID , FIELD_PARTITION_TYPE , FIELD_PARTITION_EXPRESSION ,
  FIELD_PARTITION_EXPRESSION_UTF8 , FIELD_DEFAULT_PARTITIONING , FIELD_SUBPARTITION_TYPE , FIELD_SUBPARTITION_EXPRESSION ,
  FIELD_SUBPARTITION_EXPRESSION_UTF8 , FIELD_DEFAULT_SUBPARTITIONING , FIELD_CREATED , FIELD_LAST_ALTERED ,
  FIELD_VIEW_DEFINITION , FIELD_VIEW_DEFINITION_UTF8 , FIELD_VIEW_CHECK_OPTION , FIELD_VIEW_IS_UPDATABLE ,
  FIELD_VIEW_ALGORITHM , FIELD_VIEW_SECURITY_TYPE , FIELD_VIEW_DEFINER , FIELD_VIEW_CLIENT_COLLATION_ID ,
  FIELD_VIEW_CONNECTION_COLLATION_ID , FIELD_VIEW_COLUMN_NAMES , FIELD_LAST_CHECKED_FOR_UPGRADE_VERSION_ID , FIELD_ENGINE_ATTRIBUTE ,
  FIELD_SECONDARY_ENGINE_ATTRIBUTE , NUMBER_OF_FIELDS
}
 
enum  enum_indexes {
  INDEX_PK_ID = static_cast<uint>(Common_index::PK_ID) , INDEX_UK_SCHEMA_ID_NAME = static_cast<uint>(Common_index::UK_NAME) , INDEX_UK_ENGINE_SE_PRIVATE_ID , INDEX_K_ENGINE ,
  INDEX_K_COLLATION_ID , INDEX_K_TABLESPACE_ID , INDEX_K_TYPE , INDEX_K_VIEW_CLIENT_COLLATION_ID ,
  INDEX_K_VIEW_CONNECTION_COLLATION_ID , INDEX_K_TYPE_VIEW_DEFINER
}
 
enum  enum_foreign_keys {
  FK_SCHEMA_ID , FK_COLLATION_ID , FK_TABLESPACE_ID , FK_VIEW_CLIENT_COLLATION_ID ,
  FK_VIEW_CONNECTION_COLLATION_ID
}
 
- Public Types inherited from dd::Object_table_impl
enum class  Common_option {
  ENGINE , CHARSET , COLLATION , ROW_FORMAT ,
  STATS_PERSISTENT , TABLESPACE
}
 
enum class  Common_index { PK_ID , UK_NAME }
 
enum class  Common_field { ID }
 

Public Member Functions

 Tables ()
 
Abstract_tablecreate_entity_object (const Raw_record &r) const override
 
- Public Member Functions inherited from dd::Entity_object_table_impl
 ~Entity_object_table_impl () override=default
 
bool restore_object_from_record (Open_dictionary_tables_ctx *otx, const Raw_record &record, Entity_object **o) const override
 Prepare a DD object by given raw record. More...
 
const String_typename () const override
 Get the table name used by the target definition for the dictionary table. More...
 
Object_table_definition_impltarget_table_definition () override
 Get the target definition for the dictionary table. More...
 
const Object_table_definition_impltarget_table_definition () const override
 
void set_abandoned (uint last_dd_version) const override
 Mark the target definition for the dictionary table as abandoned. More...
 
bool is_abandoned () const override
 Check if the dictionary table is abandoned. More...
 
const Object_table_definition_implactual_table_definition () const override
 Get the actual definition for the dictionary table. More...
 
bool set_actual_table_definition (const Properties &table_def_properties) const override
 Set the actual definition for the dictionary table. More...
 
int field_number (int target_field_number, const String_type &field_label) const override
 
int field_number (const String_type &field_label) const override
 Get the field ordinal position in the object table. More...
 
bool populate (THD *thd) const override
 Execute low level code for populating the table. More...
 
bool is_hidden () const override
 Check if the table should be hidden. More...
 
void set_hidden (bool hidden) override
 Mark the dictionary table as hidden or visible. More...
 
- Public Member Functions inherited from dd::Object_table_impl
 Object_table_impl (const String_type &schema_name, const String_type &table_name, const String_type &ddl_statement)
 
 Object_table_impl ()
 
const String_typename () const override
 Get the table name used by the target definition for the dictionary table. More...
 
Object_table_definition_impltarget_table_definition () override
 Get the target definition for the dictionary table. More...
 
const Object_table_definition_impltarget_table_definition () const override
 
void set_abandoned (uint last_dd_version) const override
 Mark the target definition for the dictionary table as abandoned. More...
 
bool is_abandoned () const override
 Check if the dictionary table is abandoned. More...
 
const Object_table_definition_implactual_table_definition () const override
 Get the actual definition for the dictionary table. More...
 
bool set_actual_table_definition (const Properties &table_def_properties) const override
 Set the actual definition for the dictionary table. More...
 
int field_number (const String_type &field_label) const override
 Get the field ordinal position in the object table. More...
 
bool populate (THD *) const override
 Execute low level code for populating the table. More...
 
bool is_hidden () const override
 Check if the table should be hidden. More...
 
void set_hidden (bool hidden) override
 Mark the dictionary table as hidden or visible. More...
 
 ~Object_table_impl () override=default
 
- Public Member Functions inherited from dd::Object_table
virtual ~Object_table ()=default
 
- Public Member Functions inherited from dd::Entity_object_table
 ~Entity_object_table () override=default
 

Static Public Member Functions

static const Tablesinstance ()
 
static const CHARSET_INFOname_collation ()
 
static bool update_object_key (Item_name_key *key, Object_id schema_id, const String_type &table_name)
 
static bool update_aux_key (Se_private_id_key *key, const String_type &engine, ulonglong se_private_id)
 
static Object_keycreate_se_private_key (const String_type &engine, Object_id se_private_id)
 
static Object_keycreate_key_by_schema_id (Object_id schema_id)
 
static Object_keycreate_key_by_tablespace_id (Object_id tablespace_id)
 
static Object_keycreate_key_by_definer (const String_type &definer)
 Create a key to find all views for a given definer. More...
 
static ulonglong read_se_private_id (const Raw_record &r)
 
- Static Public Member Functions inherited from dd::Object_table
static Object_tablecreate_object_table ()
 Allocate a new Object_table instance on the heap. More...
 

Additional Inherited Members

- Protected Attributes inherited from dd::Object_table_impl
uint m_last_dd_version
 
Object_table_definition_impl m_target_def
 
bool m_actual_present
 
Object_table_definition_impl m_actual_def
 
bool m_hidden
 

Member Enumeration Documentation

◆ enum_fields

Enumerator
FIELD_ID 
FIELD_SCHEMA_ID 
FIELD_NAME 
FIELD_TYPE 
FIELD_ENGINE 
FIELD_MYSQL_VERSION_ID 
FIELD_ROW_FORMAT 
FIELD_COLLATION_ID 
FIELD_COMMENT 
FIELD_HIDDEN 
FIELD_OPTIONS 
FIELD_SE_PRIVATE_DATA 
FIELD_SE_PRIVATE_ID 
FIELD_TABLESPACE_ID 
FIELD_PARTITION_TYPE 
FIELD_PARTITION_EXPRESSION 
FIELD_PARTITION_EXPRESSION_UTF8 
FIELD_DEFAULT_PARTITIONING 
FIELD_SUBPARTITION_TYPE 
FIELD_SUBPARTITION_EXPRESSION 
FIELD_SUBPARTITION_EXPRESSION_UTF8 
FIELD_DEFAULT_SUBPARTITIONING 
FIELD_CREATED 
FIELD_LAST_ALTERED 
FIELD_VIEW_DEFINITION 
FIELD_VIEW_DEFINITION_UTF8 
FIELD_VIEW_CHECK_OPTION 
FIELD_VIEW_IS_UPDATABLE 
FIELD_VIEW_ALGORITHM 
FIELD_VIEW_SECURITY_TYPE 
FIELD_VIEW_DEFINER 
FIELD_VIEW_CLIENT_COLLATION_ID 
FIELD_VIEW_CONNECTION_COLLATION_ID 
FIELD_VIEW_COLUMN_NAMES 
FIELD_LAST_CHECKED_FOR_UPGRADE_VERSION_ID 
FIELD_ENGINE_ATTRIBUTE 
FIELD_SECONDARY_ENGINE_ATTRIBUTE 
NUMBER_OF_FIELDS 

◆ enum_foreign_keys

Enumerator
FK_SCHEMA_ID 
FK_COLLATION_ID 
FK_TABLESPACE_ID 
FK_VIEW_CLIENT_COLLATION_ID 
FK_VIEW_CONNECTION_COLLATION_ID 

◆ enum_indexes

Enumerator
INDEX_PK_ID 
INDEX_UK_SCHEMA_ID_NAME 
INDEX_UK_ENGINE_SE_PRIVATE_ID 
INDEX_K_ENGINE 
INDEX_K_COLLATION_ID 
INDEX_K_TABLESPACE_ID 
INDEX_K_TYPE 
INDEX_K_VIEW_CLIENT_COLLATION_ID 
INDEX_K_VIEW_CONNECTION_COLLATION_ID 
INDEX_K_TYPE_VIEW_DEFINER 

Constructor & Destructor Documentation

◆ Tables()

dd::tables::Tables::Tables ( )

Member Function Documentation

◆ create_entity_object()

Abstract_table * dd::tables::Tables::create_entity_object ( const Raw_record r) const
overridevirtual

◆ create_key_by_definer()

Object_key * dd::tables::Tables::create_key_by_definer ( const String_type definer)
static

Create a key to find all views for a given definer.

Parameters
definerName of the definer.
Returns
Pointer to Object_key.

◆ create_key_by_schema_id()

Object_key * dd::tables::Tables::create_key_by_schema_id ( Object_id  schema_id)
static

◆ create_key_by_tablespace_id()

Object_key * dd::tables::Tables::create_key_by_tablespace_id ( Object_id  tablespace_id)
static

◆ create_se_private_key()

Object_key * dd::tables::Tables::create_se_private_key ( const String_type engine,
Object_id  se_private_id 
)
static

◆ instance()

const Tables & dd::tables::Tables::instance ( )
static

◆ name_collation()

const CHARSET_INFO * dd::tables::Tables::name_collation ( )
static

◆ read_se_private_id()

Object_id dd::tables::Tables::read_se_private_id ( const Raw_record r)
static

◆ update_aux_key()

bool dd::tables::Tables::update_aux_key ( Se_private_id_key key,
const String_type engine,
ulonglong  se_private_id 
)
static

◆ update_object_key()

bool dd::tables::Tables::update_object_key ( Item_name_key key,
Object_id  schema_id,
const String_type table_name 
)
static

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