MySQL 8.3.0
Source Code Documentation
dd::tables::Index_column_usage Class Reference

#include <index_column_usage.h>

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

Public Types

enum  enum_fields {
  FIELD_INDEX_ID , FIELD_ORDINAL_POSITION , FIELD_COLUMN_ID , FIELD_LENGTH ,
  FIELD_ORDER , FIELD_HIDDEN , NUMBER_OF_FIELDS
}
 
enum  enum_indexes { INDEX_UK_INDEX_ID_ORDINAL_POSITION , INDEX_UK_INDEX_ID_COLUMN_ID_HIDDEN , INDEX_K_COLUMN_ID }
 
enum  enum_foreign_keys { FK_INDEX_ID , FK_COLUMN_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

 Index_column_usage ()
 
- 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...
 
virtual int field_number (int target_field_number, const String_type &field_label) const
 
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
 

Static Public Member Functions

static const Index_column_usageinstance ()
 
static Object_keycreate_key_by_index_id (Object_id index_id)
 
static Object_keycreate_primary_key (Object_id index_id, int ordinal_position)
 
- 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_INDEX_ID 
FIELD_ORDINAL_POSITION 
FIELD_COLUMN_ID 
FIELD_LENGTH 
FIELD_ORDER 
FIELD_HIDDEN 
NUMBER_OF_FIELDS 

◆ enum_foreign_keys

Enumerator
FK_INDEX_ID 
FK_COLUMN_ID 

◆ enum_indexes

Enumerator
INDEX_UK_INDEX_ID_ORDINAL_POSITION 
INDEX_UK_INDEX_ID_COLUMN_ID_HIDDEN 
INDEX_K_COLUMN_ID 

Constructor & Destructor Documentation

◆ Index_column_usage()

dd::tables::Index_column_usage::Index_column_usage ( )

Member Function Documentation

◆ create_key_by_index_id()

Object_key * dd::tables::Index_column_usage::create_key_by_index_id ( Object_id  index_id)
static

◆ create_primary_key()

Object_key * dd::tables::Index_column_usage::create_primary_key ( Object_id  index_id,
int  ordinal_position 
)
static

◆ instance()

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

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