MySQL 8.0.39
Source Code Documentation
dd::tables::Collations Class Reference

#include <collations.h>

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

Public Types

enum  enum_fields {
  FIELD_ID = static_cast<uint>(Common_field::ID) , FIELD_NAME , FIELD_CHARACTER_SET_ID , FIELD_IS_COMPILED ,
  FIELD_SORT_LENGTH , FIELD_PAD_ATTRIBUTE , FIELD_OPTIONS , NUMBER_OF_FIELDS
}
 
enum  enum_indexes { INDEX_PK_ID = static_cast<uint>(Common_index::PK_ID) , INDEX_UK_NAME = static_cast<uint>(Common_index::UK_NAME) , INDEX_K_CHARACTER_SET_ID }
 
enum  enum_foreign_keys { FK_CHARACTER_SET_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

 Collations ()
 
bool populate (THD *thd) const override
 Execute low level code for populating the table. More...
 
Collationcreate_entity_object (const Raw_record &) 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 Collationsinstance ()
 
static const CHARSET_INFOname_collation ()
 
static bool update_object_key (Global_name_key *key, const String_type &collation_name)
 
- 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_NAME 
FIELD_CHARACTER_SET_ID 
FIELD_IS_COMPILED 
FIELD_SORT_LENGTH 
FIELD_PAD_ATTRIBUTE 
FIELD_OPTIONS 
NUMBER_OF_FIELDS 

◆ enum_foreign_keys

Enumerator
FK_CHARACTER_SET_ID 

◆ enum_indexes

Enumerator
INDEX_PK_ID 
INDEX_UK_NAME 
INDEX_K_CHARACTER_SET_ID 

Constructor & Destructor Documentation

◆ Collations()

dd::tables::Collations::Collations ( )

Member Function Documentation

◆ create_entity_object()

Collation * dd::tables::Collations::create_entity_object ( const Raw_record ) const
overridevirtual

◆ instance()

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

◆ name_collation()

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

◆ populate()

bool dd::tables::Collations::populate ( THD thd) const
overridevirtual

Execute low level code for populating the table.

Returns
Boolean operation outcome, false if success.

Implements dd::Object_table.

◆ update_object_key()

bool dd::tables::Collations::update_object_key ( Global_name_key key,
const String_type collation_name 
)
static

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