diff options
Diffstat (limited to 'sql/events.h')
-rw-r--r-- | sql/events.h | 164 |
1 files changed, 164 insertions, 0 deletions
diff --git a/sql/events.h b/sql/events.h new file mode 100644 index 00000000000..2bc87517748 --- /dev/null +++ b/sql/events.h @@ -0,0 +1,164 @@ +#ifndef _EVENT_H_ +#define _EVENT_H_ +/* Copyright (C) 2004-2006 MySQL AB + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; version 2 of the License. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ + +/** + @defgroup Event_Scheduler Event Scheduler + @ingroup Runtime_Environment + @{ + + @file events.h + + A public interface of Events_Scheduler module. +*/ + +class Event_parse_data; +class Event_db_repository; +class Event_queue; +class Event_scheduler; + +/* Return codes */ +enum enum_events_error_code +{ + OP_OK= 0, + OP_NOT_RUNNING, + OP_CANT_KILL, + OP_CANT_INIT, + OP_DISABLED_EVENT, + OP_LOAD_ERROR, + OP_ALREADY_EXISTS +}; + + +int +sortcmp_lex_string(LEX_STRING s, LEX_STRING t, CHARSET_INFO *cs); + +/** + @brief A facade to the functionality of the Event Scheduler. + + Every public operation against the scheduler has to be executed via the + interface provided by a static method of this class. No instance of this + class is ever created and it has no non-static data members. + + The life cycle of the Events module is the following: + + At server start up: + set_opt_event_scheduler() -> init_mutexes() -> init() + When the server is running: + create_event(), drop_event(), start_or_stop_event_scheduler(), etc + At shutdown: + deinit(), destroy_mutexes(). + + The peculiar initialization and shutdown cycle is an adaptation to the + outside server startup/shutdown framework and mimics the rest of MySQL + subsystems (ACL, time zone tables, etc). +*/ + +class Events +{ +public: + /* The order should match the order in opt_typelib */ + enum enum_opt_event_scheduler + { + EVENTS_OFF= 0, + EVENTS_ON= 1, + EVENTS_DISABLED= 4 + }; + + /* Possible values of @@event_scheduler variable */ + static const TYPELIB var_typelib; + + static bool + set_opt_event_scheduler(char *argument); + + static const char * + get_opt_event_scheduler_str(); + + /* A hack needed for Event_queue_element */ + static Event_db_repository * + get_db_repository() { return db_repository; } + + static bool + init(my_bool opt_noacl); + + static void + deinit(); + + static void + init_mutexes(); + + static void + destroy_mutexes(); + + static bool + switch_event_scheduler_state(enum enum_opt_event_scheduler new_state); + + static bool + create_event(THD *thd, Event_parse_data *parse_data, bool if_exists); + + static bool + update_event(THD *thd, Event_parse_data *parse_data, + LEX_STRING *new_dbname, LEX_STRING *new_name); + + static bool + drop_event(THD *thd, LEX_STRING dbname, LEX_STRING name, bool if_exists); + + static void + drop_schema_events(THD *thd, char *db); + + static bool + show_create_event(THD *thd, LEX_STRING dbname, LEX_STRING name); + + /* Needed for both SHOW CREATE EVENT and INFORMATION_SCHEMA */ + static int + reconstruct_interval_expression(String *buf, interval_type interval, + longlong expression); + + static int + fill_schema_events(THD *thd, TABLE_LIST *tables, COND * /* cond */); + + static void + dump_internal_status(); + +private: + static bool check_if_system_tables_error(); + + static bool + load_events_from_db(THD *thd); + +private: + /* Command line option names */ + static const TYPELIB opt_typelib; + static pthread_mutex_t LOCK_event_metadata; + static Event_queue *event_queue; + static Event_scheduler *scheduler; + static Event_db_repository *db_repository; + /* Current state of Event Scheduler */ + static enum enum_opt_event_scheduler opt_event_scheduler; + /* Set to TRUE if an error at start up */ + static bool check_system_tables_error; + +private: + /* Prevent use of these */ + Events(const Events &); + void operator=(Events &); +}; + +/** + @} (end of group Event Scheduler) +*/ + +#endif /* _EVENT_H_ */ |