dd::Event Class Reference

#include <event.h>

Inheritance diagram for dd::Event:

Public Types
enum	enum_interval_field {   IF_YEAR = 1 , IF_QUARTER , IF_MONTH , IF_DAY ,   IF_HOUR , IF_MINUTE , IF_WEEK , IF_SECOND ,   IF_MICROSECOND , IF_YEAR_MONTH , IF_DAY_HOUR , IF_DAY_MINUTE ,   IF_DAY_SECOND , IF_HOUR_MINUTE , IF_HOUR_SECOND , IF_MINUTE_SECOND ,   IF_DAY_MICROSECOND , IF_HOUR_MICROSECOND , IF_MINUTE_MICROSECOND , IF_SECOND_MICROSECOND }
enum	enum_event_status { ES_ENABLED = 1 , ES_DISABLED , ES_REPLICA_SIDE_DISABLED }
enum	enum_on_completion { OC_DROP = 1 , OC_PRESERVE }
typedef Event_impl	Impl
typedef Event	Cache_partition
typedef tables::Events	DD_table
typedef Primary_id_key	Id_key
typedef Item_name_key	Name_key
typedef Void_key	Aux_key

Public Member Functions
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
	~Event () override=default
virtual Object_id	schema_id () const =0
virtual void	set_schema_id (Object_id schema_id)=0
virtual const String_type &	definer_user () const =0
virtual const String_type &	definer_host () const =0
virtual void	set_definer (const String_type &username, const String_type &hostname)=0
virtual const String_type &	time_zone () const =0
virtual void	set_time_zone (const String_type &time_zone)=0
virtual const String_type &	definition () const =0
virtual void	set_definition (const String_type &definition)=0
virtual const String_type &	definition_utf8 () const =0
virtual void	set_definition_utf8 (const String_type &definition_utf8)=0
virtual my_time_t	execute_at () const =0
virtual void	set_execute_at (my_time_t execute_at)=0
virtual void	set_execute_at_null (bool is_null)=0
virtual bool	is_execute_at_null () const =0
virtual uint	interval_value () const =0
virtual void	set_interval_value (uint interval_value)=0
virtual void	set_interval_value_null (bool is_null)=0
virtual bool	is_interval_value_null () const =0
virtual enum_interval_field	interval_field () const =0
virtual void	set_interval_field (enum_interval_field interval_field)=0
virtual void	set_interval_field_null (bool is_null)=0
virtual bool	is_interval_field_null () const =0
virtual ulonglong	sql_mode () const =0
virtual void	set_sql_mode (ulonglong sm)=0
virtual my_time_t	starts () const =0
virtual void	set_starts (my_time_t starts)=0
virtual void	set_starts_null (bool is_null)=0
virtual bool	is_starts_null () const =0
virtual my_time_t	ends () const =0
virtual void	set_ends (my_time_t ends)=0
virtual void	set_ends_null (bool is_null)=0
virtual bool	is_ends_null () const =0
virtual enum_event_status	event_status () const =0
virtual void	set_event_status (enum_event_status event_status)=0
virtual void	set_event_status_null (bool is_null)=0
virtual bool	is_event_status_null () const =0
virtual enum_on_completion	on_completion () const =0
virtual void	set_on_completion (enum_on_completion on_completion)=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 my_time_t	last_executed () const =0
virtual void	set_last_executed (my_time_t last_executed)=0
virtual void	set_last_executed_null (bool is_null)=0
virtual bool	is_last_executed_null () const =0
virtual const String_type &	comment () const =0
virtual void	set_comment (const String_type &comment)=0
virtual ulonglong	originator () const =0
virtual void	set_originator (ulonglong originator)=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 Object_id	schema_collation_id () const =0
virtual void	set_schema_collation_id (Object_id schema_collation_id)=0
virtual Event *	clone () const =0
	Allocate a new object graph and invoke the copy constructor for each object. More...
virtual Event *	clone_dropped_object_placeholder () const =0
	Allocate a new object which can serve as a placeholder for the original object in the Dictionary_client's dropped registry. More...
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_type &	name () 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

Static Public Member Functions
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)
static void	create_mdl_key (const String_type &schema_name, const String_type &name, MDL_key *key)

Member Typedef Documentation

Aux_key

typedef Void_key dd::Event::Aux_key

Cache_partition

typedef Event dd::Event::Cache_partition

DD_table

typedef tables::Events dd::Event::DD_table

Id_key

typedef Primary_id_key dd::Event::Id_key

Impl

typedef Event_impl dd::Event::Impl

Name_key

typedef Item_name_key dd::Event::Name_key

Member Enumeration Documentation

enum_event_status

enum dd::Event::enum_event_status

Enumerator
ES_ENABLED
ES_DISABLED
ES_REPLICA_SIDE_DISABLED

enum_interval_field

enum dd::Event::enum_interval_field

Enumerator
IF_YEAR
IF_QUARTER
IF_MONTH
IF_DAY
IF_HOUR
IF_MINUTE
IF_WEEK
IF_SECOND
IF_MICROSECOND
IF_YEAR_MONTH
IF_DAY_HOUR
IF_DAY_MINUTE
IF_DAY_SECOND
IF_HOUR_MINUTE
IF_HOUR_SECOND
IF_MINUTE_SECOND
IF_DAY_MICROSECOND
IF_HOUR_MICROSECOND
IF_MINUTE_MICROSECOND
IF_SECOND_MICROSECOND

enum_on_completion

enum dd::Event::enum_on_completion

Enumerator
OC_DROP
OC_PRESERVE

Constructor & Destructor Documentation

~Event()

dd::Event::~Event ( )

overridedefault

Member Function Documentation

client_collation_id()

virtual Object_id dd::Event::client_collation_id ( ) const

pure virtual

Implemented in dd::Event_impl.

clone()

virtual Event * dd::Event::clone ( ) const

pure virtual

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

Only used in unit testing.

Returns

pointer to dynamically allocated copy

Implemented in dd::Event_impl.

clone_dropped_object_placeholder()

virtual Event * dd::Event::clone_dropped_object_placeholder ( ) const

pure 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.

Implemented in dd::Event_impl.

comment()

virtual const String_type & dd::Event::comment ( ) const

pure virtual

Implemented in dd::Event_impl.

connection_collation_id()

virtual Object_id dd::Event::connection_collation_id ( ) const

pure virtual

Implemented in dd::Event_impl.

create_mdl_key()

void dd::Event::create_mdl_key ( const String_type &  schema_name, const String_type &  name, MDL_key *  key  )

static

created()

virtual ulonglong dd::Event::created ( bool  convert_time ) const

pure virtual

Implemented in dd::Event_impl.

definer_host()

virtual const String_type & dd::Event::definer_host ( ) const

pure virtual

Implemented in dd::Event_impl.

definer_user()

virtual const String_type & dd::Event::definer_user ( ) const

pure virtual

Implemented in dd::Event_impl.

definition()

virtual const String_type & dd::Event::definition ( ) const

pure virtual

Implemented in dd::Event_impl.

definition_utf8()

virtual const String_type & dd::Event::definition_utf8 ( ) const

pure virtual

Implemented in dd::Event_impl.

ends()

virtual my_time_t dd::Event::ends ( ) const

pure virtual

Implemented in dd::Event_impl.

event_status()

virtual enum_event_status dd::Event::event_status ( ) const

pure virtual

Implemented in dd::Event_impl.

execute_at()

virtual my_time_t dd::Event::execute_at ( ) const

pure virtual

Implemented in dd::Event_impl.

interval_field()

virtual enum_interval_field dd::Event::interval_field ( ) const

pure virtual

Implemented in dd::Event_impl.

interval_value()

virtual uint dd::Event::interval_value ( ) const

pure virtual

Implemented in dd::Event_impl.

is_ends_null()

virtual bool dd::Event::is_ends_null ( ) const

pure virtual

Implemented in dd::Event_impl.

is_event_status_null()

virtual bool dd::Event::is_event_status_null ( ) const

pure virtual

Implemented in dd::Event_impl.

is_execute_at_null()

virtual bool dd::Event::is_execute_at_null ( ) const

pure virtual

Implemented in dd::Event_impl.

is_interval_field_null()

virtual bool dd::Event::is_interval_field_null ( ) const

pure virtual

Implemented in dd::Event_impl.

is_interval_value_null()

virtual bool dd::Event::is_interval_value_null ( ) const

pure virtual

Implemented in dd::Event_impl.

is_last_executed_null()

virtual bool dd::Event::is_last_executed_null ( ) const

pure virtual

Implemented in dd::Event_impl.

is_starts_null()

virtual bool dd::Event::is_starts_null ( ) const

pure virtual

Implemented in dd::Event_impl.

last_altered()

virtual ulonglong dd::Event::last_altered ( bool  convert_time ) const

pure virtual

Implemented in dd::Event_impl.

last_executed()

virtual my_time_t dd::Event::last_executed ( ) const

pure virtual

Implemented in dd::Event_impl.

on_completion()

virtual enum_on_completion dd::Event::on_completion ( ) const

pure virtual

Implemented in dd::Event_impl.

originator()

virtual ulonglong dd::Event::originator ( ) const

pure virtual

Implemented in dd::Event_impl.

schema_collation_id()

virtual Object_id dd::Event::schema_collation_id ( ) const

pure virtual

Implemented in dd::Event_impl.

schema_id()

virtual Object_id dd::Event::schema_id ( ) const

pure virtual

Implemented in dd::Event_impl.

set_client_collation_id()

virtual void dd::Event::set_client_collation_id ( Object_id  client_collation_id )

pure virtual

Implemented in dd::Event_impl.

set_comment()

virtual void dd::Event::set_comment ( const String_type &  comment )

pure virtual

Implemented in dd::Event_impl.

set_connection_collation_id()

virtual void dd::Event::set_connection_collation_id ( Object_id  connection_collation_id )

pure virtual

Implemented in dd::Event_impl.

set_created()

virtual void dd::Event::set_created ( ulonglong  created )

pure virtual

Implemented in dd::Event_impl.

set_definer()

virtual void dd::Event::set_definer ( const String_type &  username, const String_type &  hostname  )

pure virtual

Implemented in dd::Event_impl.

set_definition()

virtual void dd::Event::set_definition ( const String_type &  definition )

pure virtual

Implemented in dd::Event_impl.

set_definition_utf8()

virtual void dd::Event::set_definition_utf8 ( const String_type &  definition_utf8 )

pure virtual

Implemented in dd::Event_impl.

set_ends()

virtual void dd::Event::set_ends ( my_time_t  ends )

pure virtual

Implemented in dd::Event_impl.

set_ends_null()

virtual void dd::Event::set_ends_null ( bool  is_null )

pure virtual

Implemented in dd::Event_impl.

set_event_status()

virtual void dd::Event::set_event_status ( enum_event_status  event_status )

pure virtual

Implemented in dd::Event_impl.

set_event_status_null()

virtual void dd::Event::set_event_status_null ( bool  is_null )

pure virtual

Implemented in dd::Event_impl.

set_execute_at()

virtual void dd::Event::set_execute_at ( my_time_t  execute_at )

pure virtual

Implemented in dd::Event_impl.

set_execute_at_null()

virtual void dd::Event::set_execute_at_null ( bool  is_null )

pure virtual

Implemented in dd::Event_impl.

set_interval_field()

virtual void dd::Event::set_interval_field ( enum_interval_field  interval_field )

pure virtual

Implemented in dd::Event_impl.

set_interval_field_null()

virtual void dd::Event::set_interval_field_null ( bool  is_null )

pure virtual

Implemented in dd::Event_impl.

set_interval_value()

virtual void dd::Event::set_interval_value ( uint  interval_value )

pure virtual

Implemented in dd::Event_impl.

set_interval_value_null()

virtual void dd::Event::set_interval_value_null ( bool  is_null )

pure virtual

Implemented in dd::Event_impl.

set_last_altered()

virtual void dd::Event::set_last_altered ( ulonglong  last_altered )

pure virtual

Implemented in dd::Event_impl.

set_last_executed()

virtual void dd::Event::set_last_executed ( my_time_t  last_executed )

pure virtual

Implemented in dd::Event_impl.

set_last_executed_null()

virtual void dd::Event::set_last_executed_null ( bool  is_null )

pure virtual

Implemented in dd::Event_impl.

set_on_completion()

virtual void dd::Event::set_on_completion ( enum_on_completion  on_completion )

pure virtual

Implemented in dd::Event_impl.

set_originator()

virtual void dd::Event::set_originator ( ulonglong  originator )

pure virtual

Implemented in dd::Event_impl.

set_schema_collation_id()

virtual void dd::Event::set_schema_collation_id ( Object_id  schema_collation_id )

pure virtual

Implemented in dd::Event_impl.

set_schema_id()

virtual void dd::Event::set_schema_id ( Object_id  schema_id )

pure virtual

Implemented in dd::Event_impl.

set_sql_mode()

virtual void dd::Event::set_sql_mode ( ulonglong  sm )

pure virtual

Implemented in dd::Event_impl.

set_starts()

virtual void dd::Event::set_starts ( my_time_t  starts )

pure virtual

Implemented in dd::Event_impl.

set_starts_null()

virtual void dd::Event::set_starts_null ( bool  is_null )

pure virtual

Implemented in dd::Event_impl.

set_time_zone()

virtual void dd::Event::set_time_zone ( const String_type &  time_zone )

pure virtual

Implemented in dd::Event_impl.

sql_mode()

virtual ulonglong dd::Event::sql_mode ( ) const

pure virtual

Implemented in dd::Event_impl.

starts()

virtual my_time_t dd::Event::starts ( ) const

pure virtual

Implemented in dd::Event_impl.

time_zone()

virtual const String_type & dd::Event::time_zone ( ) const

pure virtual

Implemented in dd::Event_impl.

update_aux_key()

virtual bool dd::Event::update_aux_key ( Aux_key *  ) const

inlinevirtual

update_id_key() [1/2]

virtual bool dd::Event::update_id_key ( Id_key *  key ) const

inlinevirtual

update_id_key() [2/2]

bool dd::Event::update_id_key ( Id_key *  key, Object_id  id  )

static

update_name_key() [1/2]

virtual bool dd::Event::update_name_key ( Name_key *  key ) const

inlinevirtual

update_name_key() [2/2]

bool dd::Event::update_name_key ( Name_key *  key, Object_id  schema_id, const String_type &  name  )

static

---

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

• sql/dd/types/event.h
• sql/dd/impl/types/event_impl.cc