MySQL 8.3.0
Source Code Documentation
dd::View Class Referenceabstract

#include <view.h>

Inheritance diagram for dd::View:
[legend]

Public Types

enum  enum_check_option { CO_NONE = 1 , CO_LOCAL , CO_CASCADED }
 
enum  enum_algorithm { VA_UNDEFINED = 1 , VA_TEMPORARY_TABLE , VA_MERGE }
 
enum  enum_security_type { ST_DEFAULT = 1 , ST_INVOKER , ST_DEFINER }
 
typedef Collection< View_table * > View_tables
 
typedef Collection< View_routine * > View_routines
 
typedef View_impl Impl
 
- Public Types inherited from dd::Abstract_table
enum  enum_hidden_type { HT_VISIBLE = 1 , HT_HIDDEN_SYSTEM , HT_HIDDEN_SE , HT_HIDDEN_DDL }
 Enumeration type which indicates whether the table is hidden, and if yes then which type of hidden table it is. More...
 
typedef Abstract_table_impl Impl
 
typedef Abstract_table Cache_partition
 
typedef tables::Tables DD_table
 
typedef Primary_id_key Id_key
 
typedef Item_name_key Name_key
 
typedef Se_private_id_key Aux_key
 
typedef Collection< Column * > Column_collection
 

Public Member Functions

 ~View () override=default
 
bool is_system_view () const
 
virtual void set_system_view (bool system_view)=0
 
virtual Object_id client_collation_id () const =0
 
virtual void set_client_collation_id (Object_id client_collation_id)=0
 
virtual Object_id connection_collation_id () const =0
 
virtual void set_connection_collation_id (Object_id connection_collation_id)=0
 
virtual const String_typedefinition () const =0
 
virtual void set_definition (const String_type &definition)=0
 
virtual const String_typedefinition_utf8 () const =0
 
virtual void set_definition_utf8 (const String_type &definition_utf8)=0
 
virtual enum_check_option check_option () const =0
 
virtual void set_check_option (enum_check_option check_option)=0
 
virtual bool is_updatable () const =0
 
virtual void set_updatable (bool updatable)=0
 
virtual enum_algorithm algorithm () const =0
 
virtual void set_algorithm (enum_algorithm algorithm)=0
 
virtual enum_security_type security_type () const =0
 
virtual void set_security_type (enum_security_type security_type)=0
 
virtual const String_typedefiner_user () const =0
 
virtual const String_typedefiner_host () const =0
 
virtual void set_definer (const String_type &username, const String_type &hostname)=0
 
virtual const Propertiescolumn_names () const =0
 
virtual Propertiescolumn_names ()=0
 
virtual View_tableadd_table ()=0
 
virtual const View_tablestables () const =0
 
virtual View_routineadd_routine ()=0
 
virtual const View_routinesroutines () const =0
 
Viewclone () const override=0
 Allocate a new object graph and invoke the copy constructor for each object. More...
 
Viewclone_dropped_object_placeholder () const override=0
 Allocate a new object which can serve as a placeholder for the original object in the Dictionary_client's dropped registry. More...
 
virtual void remove_children ()=0
 Clear View columns, View_tables and View_routines collections. More...
 
- Public Member Functions inherited from dd::Abstract_table
virtual bool update_id_key (Id_key *key) const
 
virtual bool update_name_key (Name_key *key) const
 
virtual bool update_aux_key (Aux_key *) const
 
 ~Abstract_table () override=default
 
virtual Object_id schema_id () const =0
 
virtual void set_schema_id (Object_id schema_id)=0
 
virtual uint mysql_version_id () const =0
 
virtual const Propertiesoptions () const =0
 
virtual Propertiesoptions ()=0
 
virtual bool set_options (const Properties &options)=0
 
virtual bool set_options (const String_type &options_raw)=0
 
virtual ulonglong created (bool convert_time) const =0
 
virtual void set_created (ulonglong created)=0
 
virtual ulonglong last_altered (bool convert_time) const =0
 
virtual void set_last_altered (ulonglong last_altered)=0
 
virtual enum_table_type type () const =0
 
virtual enum_hidden_type hidden () const =0
 
virtual void set_hidden (enum_hidden_type hidden)=0
 
virtual Columnadd_column ()=0
 
virtual bool drop_column (const String_type &name)=0
 
virtual const Column_collectioncolumns () const =0
 
virtual Column_collectioncolumns ()=0
 
virtual const Columnget_column (const String_type &name) const =0
 
- Public Member Functions inherited from dd::Entity_object
virtual Object_id id () const =0
 The unique dictionary object id. More...
 
virtual bool is_persistent () const =0
 Is dictionary object persistent in dictionary tables ? More...
 
virtual const String_typename () const =0
 
virtual void set_name (const String_type &name)=0
 
- Public Member Functions inherited from dd::Weak_object
virtual void debug_print (String_type &outb) const =0
 
 Weak_object ()=default
 
 Weak_object (const Weak_object &)=default
 
virtual ~Weak_object ()=default
 

Additional Inherited Members

- Static Public Member Functions inherited from dd::Abstract_table
static bool update_id_key (Id_key *key, Object_id id)
 
static bool update_name_key (Name_key *key, Object_id schema_id, const String_type &name)
 

Member Typedef Documentation

◆ Impl

◆ View_routines

◆ View_tables

Member Enumeration Documentation

◆ enum_algorithm

Enumerator
VA_UNDEFINED 
VA_TEMPORARY_TABLE 
VA_MERGE 

◆ enum_check_option

Enumerator
CO_NONE 
CO_LOCAL 
CO_CASCADED 

◆ enum_security_type

Enumerator
ST_DEFAULT 
ST_INVOKER 
ST_DEFINER 

Constructor & Destructor Documentation

◆ ~View()

dd::View::~View ( )
overridedefault

Member Function Documentation

◆ add_routine()

virtual View_routine * dd::View::add_routine ( )
pure virtual

Implemented in dd::View_impl.

◆ add_table()

virtual View_table * dd::View::add_table ( )
pure virtual

Implemented in dd::View_impl.

◆ algorithm()

virtual enum_algorithm dd::View::algorithm ( ) const
pure virtual

Implemented in dd::View_impl.

◆ check_option()

virtual enum_check_option dd::View::check_option ( ) const
pure virtual

Implemented in dd::View_impl.

◆ client_collation_id()

virtual Object_id dd::View::client_collation_id ( ) const
pure virtual

Implemented in dd::View_impl.

◆ clone()

View * dd::View::clone ( ) const
overridepure virtual

Allocate a new object graph and invoke the copy constructor for each object.

Returns
pointer to dynamically allocated copy

Implements dd::Abstract_table.

Implemented in dd::View_impl.

◆ clone_dropped_object_placeholder()

View * dd::View::clone_dropped_object_placeholder ( ) const
overridepure virtual

Allocate a new object which can serve as a placeholder for the original object in the Dictionary_client's dropped registry.

Such object has the same keys as the original but has no other info and as result occupies less memory.

Implements dd::Abstract_table.

Implemented in dd::View_impl.

◆ column_names() [1/2]

virtual const Properties & dd::View::column_names ( ) const
pure virtual

Implemented in dd::View_impl.

◆ column_names() [2/2]

virtual Properties & dd::View::column_names ( )
pure virtual

Implemented in dd::View_impl.

◆ connection_collation_id()

virtual Object_id dd::View::connection_collation_id ( ) const
pure virtual

Implemented in dd::View_impl.

◆ definer_host()

virtual const String_type & dd::View::definer_host ( ) const
pure virtual

Implemented in dd::View_impl.

◆ definer_user()

virtual const String_type & dd::View::definer_user ( ) const
pure virtual

Implemented in dd::View_impl.

◆ definition()

virtual const String_type & dd::View::definition ( ) const
pure virtual

Implemented in dd::View_impl.

◆ definition_utf8()

virtual const String_type & dd::View::definition_utf8 ( ) const
pure virtual

Implemented in dd::View_impl.

◆ is_system_view()

bool dd::View::is_system_view ( ) const
inline

◆ is_updatable()

virtual bool dd::View::is_updatable ( ) const
pure virtual

Implemented in dd::View_impl.

◆ remove_children()

virtual void dd::View::remove_children ( )
pure virtual

Clear View columns, View_tables and View_routines collections.

Implemented in dd::View_impl.

◆ routines()

virtual const View_routines & dd::View::routines ( ) const
pure virtual

Implemented in dd::View_impl.

◆ security_type()

virtual enum_security_type dd::View::security_type ( ) const
pure virtual

Implemented in dd::View_impl.

◆ set_algorithm()

virtual void dd::View::set_algorithm ( enum_algorithm  algorithm)
pure virtual

Implemented in dd::View_impl.

◆ set_check_option()

virtual void dd::View::set_check_option ( enum_check_option  check_option)
pure virtual

Implemented in dd::View_impl.

◆ set_client_collation_id()

virtual void dd::View::set_client_collation_id ( Object_id  client_collation_id)
pure virtual

Implemented in dd::View_impl.

◆ set_connection_collation_id()

virtual void dd::View::set_connection_collation_id ( Object_id  connection_collation_id)
pure virtual

Implemented in dd::View_impl.

◆ set_definer()

virtual void dd::View::set_definer ( const String_type username,
const String_type hostname 
)
pure virtual

Implemented in dd::View_impl.

◆ set_definition()

virtual void dd::View::set_definition ( const String_type definition)
pure virtual

Implemented in dd::View_impl.

◆ set_definition_utf8()

virtual void dd::View::set_definition_utf8 ( const String_type definition_utf8)
pure virtual

Implemented in dd::View_impl.

◆ set_security_type()

virtual void dd::View::set_security_type ( enum_security_type  security_type)
pure virtual

Implemented in dd::View_impl.

◆ set_system_view()

virtual void dd::View::set_system_view ( bool  system_view)
pure virtual

Implemented in dd::View_impl.

◆ set_updatable()

virtual void dd::View::set_updatable ( bool  updatable)
pure virtual

Implemented in dd::View_impl.

◆ tables()

virtual const View_tables & dd::View::tables ( ) const
pure virtual

Implemented in dd::View_impl.


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