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

#include <routines.h>

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

Public Types

enum  enum_fields {
  FIELD_ID , FIELD_SCHEMA_ID , FIELD_NAME , FIELD_TYPE ,
  FIELD_RESULT_DATA_TYPE , FIELD_RESULT_DATA_TYPE_UTF8 , FIELD_RESULT_IS_ZEROFILL , FIELD_RESULT_IS_UNSIGNED ,
  FIELD_RESULT_CHAR_LENGTH , FIELD_RESULT_NUMERIC_PRECISION , FIELD_RESULT_NUMERIC_SCALE , FIELD_RESULT_DATETIME_PRECISION ,
  FIELD_RESULT_COLLATION_ID , FIELD_DEFINITION , FIELD_DEFINITION_UTF8 , FIELD_PARAMETER_STR ,
  FIELD_IS_DETERMINISTIC , FIELD_SQL_DATA_ACCESS , FIELD_SECURITY_TYPE , FIELD_DEFINER ,
  FIELD_SQL_MODE , FIELD_CLIENT_COLLATION_ID , FIELD_CONNECTION_COLLATION_ID , FIELD_SCHEMA_COLLATION_ID ,
  FIELD_CREATED , FIELD_LAST_ALTERED , FIELD_COMMENT , FIELD_OPTIONS ,
  FIELD_EXTERNAL_LANGUAGE , NUMBER_OF_FIELDS
}
 
enum  enum_indexes {
  INDEX_PK_ID = static_cast<uint>(Common_index::PK_ID) , INDEX_UK_SCHEMA_ID_TYPE_NAME , INDEX_K_RESULT_COLLATION_ID , INDEX_K_CLIENT_COLLATION_ID ,
  INDEX_K_CONNECTION_COLLATION_ID , INDEX_K_SCHEMA_COLLATION_ID , INDEX_K_DEFINER
}
 
enum  enum_foreign_keys {
  FK_SCHEMA_ID , FK_RESULT_COLLATION_ID , FK_CLIENT_COLLATION_ID , FK_CONNECTION_COLLATION_ID ,
  FK_SCHEMA_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

 Routines ()
 
Routinecreate_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 Routinesinstance ()
 
static const CHARSET_INFOname_collation ()
 
static bool update_object_key (Routine_name_key *key, Object_id schema_id, Routine::enum_routine_type type, const String_type &routine_name)
 
static Object_keycreate_key_by_schema_id (Object_id schema_id)
 
static Object_keycreate_key_by_definer (const String_type &definer)
 Create a key to find all routines for a given definer. More...
 
- 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_RESULT_DATA_TYPE 
FIELD_RESULT_DATA_TYPE_UTF8 
FIELD_RESULT_IS_ZEROFILL 
FIELD_RESULT_IS_UNSIGNED 
FIELD_RESULT_CHAR_LENGTH 
FIELD_RESULT_NUMERIC_PRECISION 
FIELD_RESULT_NUMERIC_SCALE 
FIELD_RESULT_DATETIME_PRECISION 
FIELD_RESULT_COLLATION_ID 
FIELD_DEFINITION 
FIELD_DEFINITION_UTF8 
FIELD_PARAMETER_STR 
FIELD_IS_DETERMINISTIC 
FIELD_SQL_DATA_ACCESS 
FIELD_SECURITY_TYPE 
FIELD_DEFINER 
FIELD_SQL_MODE 
FIELD_CLIENT_COLLATION_ID 
FIELD_CONNECTION_COLLATION_ID 
FIELD_SCHEMA_COLLATION_ID 
FIELD_CREATED 
FIELD_LAST_ALTERED 
FIELD_COMMENT 
FIELD_OPTIONS 
FIELD_EXTERNAL_LANGUAGE 
NUMBER_OF_FIELDS 

◆ enum_foreign_keys

Enumerator
FK_SCHEMA_ID 
FK_RESULT_COLLATION_ID 
FK_CLIENT_COLLATION_ID 
FK_CONNECTION_COLLATION_ID 
FK_SCHEMA_COLLATION_ID 

◆ enum_indexes

Enumerator
INDEX_PK_ID 
INDEX_UK_SCHEMA_ID_TYPE_NAME 
INDEX_K_RESULT_COLLATION_ID 
INDEX_K_CLIENT_COLLATION_ID 
INDEX_K_CONNECTION_COLLATION_ID 
INDEX_K_SCHEMA_COLLATION_ID 
INDEX_K_DEFINER 

Constructor & Destructor Documentation

◆ Routines()

dd::tables::Routines::Routines ( )

Member Function Documentation

◆ create_entity_object()

Routine * dd::tables::Routines::create_entity_object ( const Raw_record r) const
overridevirtual

◆ create_key_by_definer()

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

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

Parameters
definerName of the definer.
Returns
Pointer to Object_key.

◆ create_key_by_schema_id()

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

◆ instance()

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

◆ name_collation()

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

◆ update_object_key()

bool dd::tables::Routines::update_object_key ( Routine_name_key key,
Object_id  schema_id,
Routine::enum_routine_type  type,
const String_type routine_name 
)
static

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