Component Services Inventory

This is a group of all component service APIs. More...

Collaboration diagram for Component Services Inventory:

Modules
	Keyring component services
	MySQL string services
	Table Access services

Classes
struct	s_mysql_mysql_audit_api_connection
	A service to generate Audit API events of the connection class (MYSQL_AUDIT_CONNECTION_CLASS). More...
struct	s_mysql_mysql_audit_api_connection_with_error
	A service to generate Audit API events of the connection class (MYSQL_AUDIT_CONNECTION_CLASS) with the explicitly specified error code value. More...
struct	s_mysql_component_sys_variable_register
	Service to register variable and get variable value. More...
struct	s_mysql_component_sys_variable_unregister
	Service to unregister variable. More...
struct	s_mysql_group_replication_message_service_send
	A service that sends content agnostic messages from a member to the group. More...
struct	s_mysql_group_replication_status_service_v1
	A service to get the status of a member of Group Replication. More...
struct	s_mysql_host_application_signal
	A service to deliver a signal to host application. More...
struct	s_mysql_mysql_keyring_iterator
	Keyring iterator component service definition, which enables to iterate over items stored within currently used keyring. More...
struct	s_mysql_mysql_admin_session
	A service to create an "admin" session that's not a subject to max connection count limits. More...
struct	s_mysql_mysql_audit_print_service_double_data_source
	Audit print service allows to obtain data of the double type associated with the THD object, which keeps various data of the user session. More...
struct	s_mysql_mysql_audit_print_service_longlong_data_source
	Audit print service allows to obtain data of the long long type associated with the THD object, which keeps various data of the user session. More...
struct	s_mysql_mysql_authentication_registration
	A service to do registration of fido device. More...
struct	s_mysql_mysql_text_consumer_factory_v1
	An implementation of these services will be called as the data resulting from calling mysql_query() service are produced by the server. More...
struct	s_mysql_mysql_text_consumer_metadata_v1
	A service that provides the apis for start_result_metadata, field_metadata, and end_result_metadata. More...
struct	s_mysql_mysql_text_consumer_row_factory_v1
	A service that provides the apis for start_row, abort_row and end_row. More...
struct	s_mysql_mysql_text_consumer_error_v1
	A service that provides the apis for handle_ok, handle_error and error. More...
struct	s_mysql_mysql_text_consumer_get_null_v1
	A service that provides the apis for get_null. More...
struct	s_mysql_mysql_text_consumer_get_integer_v1
	A service that provides the apis for get_integer. More...
struct	s_mysql_mysql_text_consumer_get_longlong_v1
	A service that provides the apis for get_longlong. More...
struct	s_mysql_mysql_text_consumer_get_decimal_v1
	A service that provides the apis for get_decimal. More...
struct	s_mysql_mysql_text_consumer_get_double_v1
	A service that provides the apis for get_double. More...
struct	s_mysql_mysql_text_consumer_get_date_time_v1
	A service that provides the apis for get_date, get_time and get_datatime. More...
struct	s_mysql_mysql_text_consumer_get_string_v1
	A service that provides the apis for get_string. More...
struct	s_mysql_mysql_text_consumer_client_capabilities_v1
	A service that provides the apis for client_capabilities. More...
struct	s_mysql_mysql_command_factory
	A service that provides the apis for mysql command init, info, connect, reset, close, commit, auto_commit and rollback. More...
struct	s_mysql_mysql_command_thread
	A service that provides the apis for mysql command session thread init and thread end. More...
struct	s_mysql_mysql_command_options
	A service that provides the apis for mysql command get_option and set_option. More...
struct	s_mysql_mysql_command_query
	A service that provides the apis for mysql command query and affected_rows. More...
struct	s_mysql_mysql_command_query_result
	A service that provides the apis for mysql command, store_result, free_result, more_results, next_result, result_metadata and fetch_row. More...
struct	s_mysql_mysql_command_field_info
	A service that provides the apis for mysql command field info, fetch_field, num_fields, fetch_fields and field_count. More...
struct	s_mysql_mysql_command_field_metadata
	Fetch the metadata of a service. More...
struct	s_mysql_mysql_command_error_info
	A service that provides the apis for mysql command error info, mysql_errno, error, sqlstate. More...
struct	s_mysql_mysql_current_thread_reader
	A service to fetch the current thread id. More...
struct	s_mysql_mysql_keyring_native_key_id
	A service to read native keybackend id. More...
struct	s_mysql_mysql_query_attributes_iterator
	A service to fetch the query attributes for the current thread. More...
struct	s_mysql_mysql_query_attribute_string
	A service to fetch the query attribute value as a string. More...
struct	s_mysql_mysql_query_attribute_isnull
	A service to fetch the query attribute null flag. More...
struct	s_mysql_mysql_scheduler
	The Scheduler queueing interface. More...
struct	s_mysql_mysql_scheduler_notify
	Notification service for the scheduler customers. More...
struct	s_mysql_mysql_status_variable_string
	Service to read the value of a status variable as a string. More...
struct	s_mysql_mysql_system_variable_update_string
	Service to set the value of system variables. More...
struct	s_mysql_mysql_system_variable_update_integer
	Service to set the value of integer system variables. More...
struct	s_mysql_mysql_system_variable_update_default
	Service to set the default value of system variables. More...
struct	s_mysql_mysql_thd_attributes
	THD Attributes service allows to obtain data associated with the THD object, which keeps various attributes of the user session. More...
struct	s_mysql_psi_tls_channel_v1
	Service for instrumentation of TLS channel in performance schema. More...
struct	s_mysql_reference_caching_channel
	A reference caching channel service. More...
struct	s_mysql_validate_password
	Interfaces to enforce a password policy. More...
struct	s_mysql_validate_password_changed_characters
	Service to enforce that new password contains N different characters compared to existing password. More...

Typedefs
typedef struct s_mysql_mysql_audit_api_connection	mysql_service_mysql_audit_api_connection_t
	A service to generate Audit API events of the connection class (MYSQL_AUDIT_CONNECTION_CLASS). More...
typedef struct s_mysql_mysql_audit_api_connection_with_error	mysql_service_mysql_audit_api_connection_with_error_t
	A service to generate Audit API events of the connection class (MYSQL_AUDIT_CONNECTION_CLASS) with the explicitly specified error code value. More...
typedef struct s_mysql_component_sys_variable_register	mysql_service_component_sys_variable_register_t
	Service to register variable and get variable value. More...
typedef struct s_mysql_component_sys_variable_unregister	mysql_service_component_sys_variable_unregister_t
	Service to unregister variable. More...
typedef struct s_mysql_group_replication_message_service_send	mysql_service_group_replication_message_service_send_t
	A service that sends content agnostic messages from a member to the group. More...
typedef struct s_mysql_group_replication_status_service_v1	mysql_service_group_replication_status_service_v1_t
	A service to get the status of a member of Group Replication. More...
typedef struct s_mysql_host_application_signal	mysql_service_host_application_signal_t
	A service to deliver a signal to host application. More...
typedef struct s_mysql_mysql_keyring_iterator	mysql_service_mysql_keyring_iterator_t
	Keyring iterator component service definition, which enables to iterate over items stored within currently used keyring. More...
typedef struct s_mysql_mysql_admin_session	mysql_service_mysql_admin_session_t
	A service to create an "admin" session that's not a subject to max connection count limits. More...
typedef struct s_mysql_mysql_audit_print_service_double_data_source	mysql_service_mysql_audit_print_service_double_data_source_t
	Audit print service allows to obtain data of the double type associated with the THD object, which keeps various data of the user session. More...
typedef struct s_mysql_mysql_audit_print_service_longlong_data_source	mysql_service_mysql_audit_print_service_longlong_data_source_t
	Audit print service allows to obtain data of the long long type associated with the THD object, which keeps various data of the user session. More...
typedef struct s_mysql_mysql_authentication_registration	mysql_service_mysql_authentication_registration_t
	A service to do registration of fido device. More...
typedef struct s_mysql_mysql_text_consumer_factory_v1	mysql_service_mysql_text_consumer_factory_v1_t
	An implementation of these services will be called as the data resulting from calling mysql_query() service are produced by the server. More...
typedef struct s_mysql_mysql_text_consumer_metadata_v1	mysql_service_mysql_text_consumer_metadata_v1_t
	A service that provides the apis for start_result_metadata, field_metadata, and end_result_metadata. More...
typedef struct s_mysql_mysql_text_consumer_row_factory_v1	mysql_service_mysql_text_consumer_row_factory_v1_t
	A service that provides the apis for start_row, abort_row and end_row. More...
typedef struct s_mysql_mysql_text_consumer_error_v1	mysql_service_mysql_text_consumer_error_v1_t
	A service that provides the apis for handle_ok, handle_error and error. More...
typedef struct s_mysql_mysql_text_consumer_get_null_v1	mysql_service_mysql_text_consumer_get_null_v1_t
	A service that provides the apis for get_null. More...
typedef struct s_mysql_mysql_text_consumer_get_integer_v1	mysql_service_mysql_text_consumer_get_integer_v1_t
	A service that provides the apis for get_integer. More...
typedef struct s_mysql_mysql_text_consumer_get_longlong_v1	mysql_service_mysql_text_consumer_get_longlong_v1_t
	A service that provides the apis for get_longlong. More...
typedef struct s_mysql_mysql_text_consumer_get_decimal_v1	mysql_service_mysql_text_consumer_get_decimal_v1_t
	A service that provides the apis for get_decimal. More...
typedef struct s_mysql_mysql_text_consumer_get_double_v1	mysql_service_mysql_text_consumer_get_double_v1_t
	A service that provides the apis for get_double. More...
typedef struct s_mysql_mysql_text_consumer_get_date_time_v1	mysql_service_mysql_text_consumer_get_date_time_v1_t
	A service that provides the apis for get_date, get_time and get_datatime. More...
typedef struct s_mysql_mysql_text_consumer_get_string_v1	mysql_service_mysql_text_consumer_get_string_v1_t
	A service that provides the apis for get_string. More...
typedef struct s_mysql_mysql_text_consumer_client_capabilities_v1	mysql_service_mysql_text_consumer_client_capabilities_v1_t
	A service that provides the apis for client_capabilities. More...
typedef struct s_mysql_mysql_command_factory	mysql_service_mysql_command_factory_t
	A service that provides the apis for mysql command init, info, connect, reset, close, commit, auto_commit and rollback. More...
typedef struct s_mysql_mysql_command_thread	mysql_service_mysql_command_thread_t
	A service that provides the apis for mysql command session thread init and thread end. More...
typedef struct s_mysql_mysql_command_options	mysql_service_mysql_command_options_t
	A service that provides the apis for mysql command get_option and set_option. More...
typedef struct s_mysql_mysql_command_query	mysql_service_mysql_command_query_t
	A service that provides the apis for mysql command query and affected_rows. More...
typedef struct s_mysql_mysql_command_query_result	mysql_service_mysql_command_query_result_t
	A service that provides the apis for mysql command, store_result, free_result, more_results, next_result, result_metadata and fetch_row. More...
typedef struct s_mysql_mysql_command_field_info	mysql_service_mysql_command_field_info_t
	A service that provides the apis for mysql command field info, fetch_field, num_fields, fetch_fields and field_count. More...
typedef struct s_mysql_mysql_command_field_metadata	mysql_service_mysql_command_field_metadata_t
	Fetch the metadata of a service. More...
typedef struct s_mysql_mysql_command_error_info	mysql_service_mysql_command_error_info_t
	A service that provides the apis for mysql command error info, mysql_errno, error, sqlstate. More...
typedef const char *	my_h_connection_attributes_iterator
	A service to read the connection attributes from the current session It provides a read-only iterator over the attributes. More...
typedef struct s_mysql_mysql_current_thread_reader	mysql_service_mysql_current_thread_reader_t
	A service to fetch the current thread id. More...
typedef struct s_mysql_mysql_keyring_native_key_id	mysql_service_mysql_keyring_native_key_id_t
	A service to read native keybackend id. More...
typedef struct s_mysql_mysql_query_attributes_iterator	mysql_service_mysql_query_attributes_iterator_t
	A service to fetch the query attributes for the current thread. More...
typedef struct s_mysql_mysql_query_attribute_string	mysql_service_mysql_query_attribute_string_t
	A service to fetch the query attribute value as a string. More...
typedef struct s_mysql_mysql_query_attribute_isnull	mysql_service_mysql_query_attribute_isnull_t
	A service to fetch the query attribute null flag. More...
typedef struct s_mysql_mysql_scheduler	mysql_service_mysql_scheduler_t
	The Scheduler queueing interface. More...
typedef struct s_mysql_mysql_scheduler_notify	mysql_service_mysql_scheduler_notify_t
	Notification service for the scheduler customers. More...
typedef struct s_mysql_mysql_status_variable_string	mysql_service_mysql_status_variable_string_t
	Service to read the value of a status variable as a string. More...
typedef struct s_mysql_mysql_system_variable_update_string	mysql_service_mysql_system_variable_update_string_t
	Service to set the value of system variables. More...
typedef struct s_mysql_mysql_system_variable_update_integer	mysql_service_mysql_system_variable_update_integer_t
	Service to set the value of integer system variables. More...
typedef struct s_mysql_mysql_system_variable_update_default	mysql_service_mysql_system_variable_update_default_t
	Service to set the default value of system variables. More...
typedef struct s_mysql_mysql_thd_attributes	mysql_service_mysql_thd_attributes_t
	THD Attributes service allows to obtain data associated with the THD object, which keeps various attributes of the user session. More...
typedef struct s_mysql_psi_tls_channel_v1	mysql_service_psi_tls_channel_v1_t
	Service for instrumentation of TLS channel in performance schema. More...
typedef struct s_mysql_reference_caching_channel	mysql_service_reference_caching_channel_t
	A reference caching channel service. More...
typedef struct s_mysql_validate_password	mysql_service_validate_password_t
	Interfaces to enforce a password policy. More...
typedef struct s_mysql_validate_password_changed_characters	mysql_service_validate_password_changed_characters_t
	Service to enforce that new password contains N different characters compared to existing password. More...

Detailed Description

This is a group of all component service APIs.

See A Service and a Service Implementation for explanation of what a component service is

Typedef Documentation

my_h_connection_attributes_iterator

typedef const char* my_h_connection_attributes_iterator

A service to read the connection attributes from the current session It provides a read-only iterator over the attributes.

This is some example code to use the iterator:

// at init time. try to reuse the service handles as much as possible
 
my_service<SERVICE_TYPE(mysql_current_thread_reader)> thd_reader(
   "mysql_current_thread_reader", m_reg_srv);
 my_service<SERVICE_TYPE(mysql_connection_attributes_iterator)> service(
    "mysql_connection_attributes_iterator", m_reg_srv);
 
if (!service.is_valid() || !thd_reader.is_valid) {
  return; //error
}
 
    ...
 
// at parse time
 
MYSQL_THD thd;
if (thd_reader->get(&thd))
  return; //error
 
my_h_connection_attributes_iterator iterator;
 
MYSQL_LEX_CSTRING name;
MYSQL_LEX_CSTRING value;
const char *charset_string;
const CHARSET_INFO *charset = nullptr;
 
my_h_connection_attributes_iterator iterator;
if (service->init(thd, &iterator)) return;  // error
 
while (!service->get(thd, &iterator, &name.str, &name.length, &value.str,
                      &value.length, &charset_string)) {
  // Do something with name and value
}
 
service->deinit(iterator);

mysql_service_component_sys_variable_register_t

typedef struct s_mysql_component_sys_variable_register mysql_service_component_sys_variable_register_t

Service to register variable and get variable value.

See also

mysql_component_sys_variable_imp

mysql_service_component_sys_variable_unregister_t

typedef struct s_mysql_component_sys_variable_unregister mysql_service_component_sys_variable_unregister_t

Service to unregister variable.

Make sure to call this for each variable registered.

See also

mysql_service_component_sys_variable_unregister_t

mysql_service_group_replication_message_service_send_t

typedef struct s_mysql_group_replication_message_service_send mysql_service_group_replication_message_service_send_t

A service that sends content agnostic messages from a member to the group.

This only works if the component is on a server with group replication running and the member state is ONLINE. If server isn't ONLINE message won't be deliver.

After message sent to all members of the group, all components that have registered group_replication_message_service_recv service will be notified.

SERVICE_TYPE(registry) *plugin_registry = mysql_plugin_registry_acquire();
my_service<SERVICE_TYPE(group_replication_message_service_send)> svc(
    "group_replication_message_service_send", plugin_registry);
 
if (svc.is_valid()) {
  bool error = svc->send("tag", "payload", sizeof("payload"));
}

mysql_service_group_replication_status_service_v1_t

typedef struct s_mysql_group_replication_status_service_v1 mysql_service_group_replication_status_service_v1_t

A service to get the status of a member of Group Replication.

This is only available if the component is on a server with Group Replication plugin installed.

SERVICE_TYPE(registry) *plugin_registry = mysql_plugin_registry_acquire();
my_service<SERVICE_TYPE(group_replication_status_service_v1)> svc(
    "group_replication_status_service_v1", plugin_registry);
 
if (svc.is_valid()) {
  bool error = svc->...
}

mysql_service_host_application_signal_t

typedef struct s_mysql_host_application_signal mysql_service_host_application_signal_t

A service to deliver a signal to host application.

Typically there'll be just one implementation of this by the main application.

Other parties interested in listening to shutdown may override the default implementation with a broadcast one and have multiple implementations receiving the shutdown signal. Or do message queueing to a set of background threads etc.

See also

mysql_component_host_application_signal_imp

mysql_service_mysql_admin_session_t

typedef struct s_mysql_mysql_admin_session mysql_service_mysql_admin_session_t

A service to create an "admin" session that's not a subject to max connection count limits.

This service is an extension to the sessions plugin service suite. The MYSQL_SESSION references are compatible with the plugin service.

See also

mysql_component_mysql_admin_session_imp

mysql_service_mysql_audit_api_connection_t

typedef struct s_mysql_mysql_audit_api_connection mysql_service_mysql_audit_api_connection_t

A service to generate Audit API events of the connection class (MYSQL_AUDIT_CONNECTION_CLASS).

The emit method generates the event in the synchronous way, causing all subscribers to receive it.

See also

mysql_audit_api_connection_imp

mysql_service_mysql_audit_api_connection_with_error_t

typedef struct s_mysql_mysql_audit_api_connection_with_error mysql_service_mysql_audit_api_connection_with_error_t

A service to generate Audit API events of the connection class (MYSQL_AUDIT_CONNECTION_CLASS) with the explicitly specified error code value.

This service should ONLY be used if we cannot set the THD's Statement Diagnostic Area result code, which is passed along the audit notification chain. The preferred way of generating the event is to rely on THD's internal data as much as possible (mysql_audit_api_connection service)

The emit method generates the event in the synchronous way, causing all subscribers to receive it.

See also

mysql_audit_api_connection_imp

mysql_service_mysql_audit_print_service_double_data_source_t

typedef struct s_mysql_mysql_audit_print_service_double_data_source mysql_service_mysql_audit_print_service_double_data_source_t

Audit print service allows to obtain data of the double type associated with the THD object, which keeps various data of the user session.

It also allows to obtain data not necessarily bound with the user session.

Currently, following data is supported:

• Query time ("query_time") Query execution time [seconds].
• Rows sent ("rows_sent") Row count sent to the client as a result.
• Rows examined ("rows_examined") Row count accessed during the query.
• Bytes received ("bytes_received") Byte count received from the client.
• Bytes sent ("bytes_sent") Byte count sent to the client.

Initialization

The service can be instantiated using the registry service with the "mysql_audit_print_service_double_data_source" name.

SERVICE_TYPE(registry) *registry = mysql_plugin_registry_acquire();
my_service<SERVICE_TYPE(mysql_audit_print_service_double_data_source)>
svc("mysql_audit_print_service_double_data_source", registry);
if (svc.is_valid()) {
  // The service is ready to be used
}

Query Time

Query Time represents query execution time in seconds.

double value;
 
svc->get(m_thd, "query_time", &value);

mysql_service_mysql_audit_print_service_longlong_data_source_t

typedef struct s_mysql_mysql_audit_print_service_longlong_data_source mysql_service_mysql_audit_print_service_longlong_data_source_t

Audit print service allows to obtain data of the long long type associated with the THD object, which keeps various data of the user session.

It also allows to obtain data not necessarily bound with the user session.

Currently, following data is supported:

• Query time ("query_time") Query execution time [microseconds].
• Rows sent ("rows_sent") Row count sent to the client as a result.
• Rows examined ("rows_examined") Row count accessed during the query.
• Bytes received ("bytes_received") Byte count received from the client.
• Bytes sent ("bytes_sent") Byte count sent to the client.

Initialization

The service can be instantiated using the registry service with the "mysql_audit_print_service_double_data_source" name.

SERVICE_TYPE(registry) *registry = mysql_plugin_registry_acquire();
my_service<SERVICE_TYPE(mysql_audit_print_service_long_long_data_source)>
svc("mysql_audit_print_service_long_long_data_source", registry);
if (svc.is_valid()) {
  // The service is ready to be used
}

Query Time

Query Time represents query execution time in microseconds.

long long value;
 
svc->get(m_thd, "query_time", &value);

mysql_service_mysql_authentication_registration_t

typedef struct s_mysql_mysql_authentication_registration mysql_service_mysql_authentication_registration_t

A service to do registration of fido device.

mysql_service_mysql_command_error_info_t

typedef struct s_mysql_mysql_command_error_info mysql_service_mysql_command_error_info_t

A service that provides the apis for mysql command error info, mysql_errno, error, sqlstate.

mysql_service_mysql_command_factory_t

typedef struct s_mysql_mysql_command_factory mysql_service_mysql_command_factory_t

A service that provides the apis for mysql command init, info, connect, reset, close, commit, auto_commit and rollback.

mysql_service_mysql_command_field_info_t

typedef struct s_mysql_mysql_command_field_info mysql_service_mysql_command_field_info_t

A service that provides the apis for mysql command field info, fetch_field, num_fields, fetch_fields and field_count.

mysql_service_mysql_command_field_metadata_t

typedef struct s_mysql_mysql_command_field_metadata mysql_service_mysql_command_field_metadata_t

Fetch the metadata of a service.

Usually used as follows:

mysql_service_mysql_command_options_t

typedef struct s_mysql_mysql_command_options mysql_service_mysql_command_options_t

A service that provides the apis for mysql command get_option and set_option.

mysql_service_mysql_command_query_result_t

typedef struct s_mysql_mysql_command_query_result mysql_service_mysql_command_query_result_t

A service that provides the apis for mysql command, store_result, free_result, more_results, next_result, result_metadata and fetch_row.

mysql_service_mysql_command_query_t

typedef struct s_mysql_mysql_command_query mysql_service_mysql_command_query_t

A service that provides the apis for mysql command query and affected_rows.

mysql_service_mysql_command_thread_t

typedef struct s_mysql_mysql_command_thread mysql_service_mysql_command_thread_t

A service that provides the apis for mysql command session thread init and thread end.

mysql_service_mysql_current_thread_reader_t

typedef struct s_mysql_mysql_current_thread_reader mysql_service_mysql_current_thread_reader_t

A service to fetch the current thread id.

Use in conjunction with all the related services that operate on thread ids

See also

mysql_component_mysql_current_thread_reader_imp

mysql_service_mysql_keyring_iterator_t

typedef struct s_mysql_mysql_keyring_iterator mysql_service_mysql_keyring_iterator_t

Keyring iterator component service definition, which enables to iterate over items stored within currently used keyring.

 my_service<SERVICE_TYPE(mysql_keyring_iterator)> service(
    "mysql_keyring_iterator.mysql_server", m_reg_srv);
 
if (!service.is_valid()) {
  return;
}
 
my_h_keyring_iterator iterator = nullptr;
 
if (service->init(&iterator)) {
  return;
}
 
char key_id[64];
char user_id[64];
 
while (iterator != nullptr && service->get(iterator, key_id, sizeof(key_id)
user_id, sizeof(user_id))
== 0) {
  // Do something with key and user_id values.
}
 
service->deinit(iterator);

mysql_service_mysql_keyring_native_key_id_t

typedef struct s_mysql_mysql_keyring_native_key_id mysql_service_mysql_keyring_native_key_id_t

A service to read native keybackend id.

Typically there'll be just one implementation of this by the main application.

mysql_service_mysql_query_attribute_isnull_t

typedef struct s_mysql_mysql_query_attribute_isnull mysql_service_mysql_query_attribute_isnull_t

A service to fetch the query attribute null flag.

Use in conjunction with mysql_query_atrributes_iterator service

See also

mysql_component_mysql_query_attributes_imp

mysql_service_mysql_query_attribute_string_t

typedef struct s_mysql_mysql_query_attribute_string mysql_service_mysql_query_attribute_string_t

A service to fetch the query attribute value as a string.

Use in conjunction with mysql_query_atrributes_iterator service

See also

mysql_component_mysql_query_attributes_imp

mysql_service_mysql_query_attributes_iterator_t

typedef struct s_mysql_mysql_query_attributes_iterator mysql_service_mysql_query_attributes_iterator_t

A service to fetch the query attributes for the current thread.

Use in conjunction with all the related services that operate on thread ids

See also

mysql_component_mysql_query_attributes_imp

mysql_service_mysql_scheduler_notify_t

typedef struct s_mysql_mysql_scheduler_notify mysql_service_mysql_scheduler_notify_t

Notification service for the scheduler customers.

The scheduler will broadcast this at important events of its operation that may be of interest to customers. Currently only supports STARTED event: When the scheduler starts some of its "customers" may be already loaded and have allowed delayed initialization. To avoid polling for scheduler implementations, the scheduler will broadcast to all implementations of this service at its startup so they can register their scheduled tasks. This is useful for e.g. customers loading prior to the scheduler and willing to register their tasks when the scheduler is present.

mysql_service_mysql_scheduler_t

typedef struct s_mysql_mysql_scheduler mysql_service_mysql_scheduler_t

The Scheduler queueing interface.

This is a service that will allow registering a callback to be called every X seconds.

Each callback has a name. And a comment for the DBA to check.

A caller registers a callback together with its argument and gets a handle back. The callback will be put in rotation immediately and will be called after the defined interval. And it will keep being called until it's unregisterered using the handle.

Passing an argument is useful if you are to reuse the callback function to operate on many different states through registering it in multiple scheduled events. Having the argument passed down from the registering code to the callback saves the need of the callback to consult a global structure in a multi- thread safe fashion.

Warning

Keep the runnable function SHORT! Or design a way for it to be graciously shut down through a flag inside the argument.

To use it one would do something like this:

bool sheduled_callback(mysql_scheduler_runnable_handle handle, void *arg) {
   int *ctr = reinterpret_cast<std::atomic<int> *>(arg);
   *ctr++;
}
 
REQUIRES_SERVICE(mysql_scheduler);
 
int caller() {
   std::atomic<int> data= 0;
   mysql_scheduler_runnable_handle handle = nullptr;
   mysql_service_mysql_scheduler->create(
     &handle, sheduled_callback,
     (void *)&data,
     "gizmo", "This is a sheduled task to call gizmo",
     10);
 
   ....
 
   mysql_service_mysql_scheduler->destroy(handle);
   handle = nullptr;
}

See also

mysql_scheduler_runnable_handle, mysql_scheduler_runnable_function

mysql_service_mysql_status_variable_string_t

typedef struct s_mysql_mysql_status_variable_string mysql_service_mysql_status_variable_string_t

Service to read the value of a status variable as a string.

Used approximately as follows:

my_h_string value = nullptr;
bool get_global = true; // or false
MYSQL_THD thd = nullptr; // use a temp thd
const char *name = "gizmo";
char buffer[1024];
const char *charset= "utf8mb4";
 
// try to get the current thd if there is one
if (!get_global && mysql_service_mysql_current_thread_reader->get(&thd)) {
  // failed to get the current THD
  *is_null = 1;
  *error = 1;
  return nullptr;
}
if (!mysql_service_mysql_status_variable_string->get(thd, name, get_global,
&str) && str && !mysql_service_mysql_string_converter->convert_to_buffer( str,
buffer, sizeof(buffer) - 1, charset)) {
  mysql_service_mysql_string_factory->destroy(str);
  // the value is in buffer
}
 
// wasn't able to get the value. do cleanup
if (str) mysql_service_mysql_string_factory->destroy(str);

See also

mysql_status_variable_reader_imp

mysql_service_mysql_system_variable_update_default_t

typedef struct s_mysql_mysql_system_variable_update_default mysql_service_mysql_system_variable_update_default_t

Service to set the default value of system variables.

This is an example of using the service:

MYSQL_THD thd = nullptr;
 
if (!make_new_thread &&
    mysql_service_mysql_current_thread_reader->get(&thd)) {
  *error = 1;
  return 0;
}
 
const char *cs = "latin1";
const char *base_input = "my_component"; //nullptr if not a component variable
const char *name_input = "my_variable";
const char *type = "PERSIST";
 
my_h_string base = nullptr, name = nullptr;
if ((base != nullptr &&
     mysql_service_mysql_string_converter->convert_from_buffer(
        &base, base_input, strlen(base_input), cs)) ||
    mysql_service_mysql_string_converter->convert_from_buffer(
        &name, name_input, strlen(name_input), cs)) {
  if (base) mysql_service_mysql_string_factory->destroy(base);
  if (name) mysql_service_mysql_string_factory->destroy(name);
  *error = 1;
  return 0;
}
 
if (mysql_service_mysql_system_variable_update_default->set(
       thd, type, base, name))
  *error = 1;
 
if (base) mysql_service_mysql_string_factory->destroy(base);
if (name) mysql_service_mysql_string_factory->destroy(name);

See also

mysql_system_variable_update_imp

mysql_service_mysql_system_variable_update_integer_t

typedef struct s_mysql_mysql_system_variable_update_integer mysql_service_mysql_system_variable_update_integer_t

Service to set the value of integer system variables.

Passing non-NULL THD input to setter methods means that the operation will be executed within the scope of existing transaction, thus any operation side effects impacting transaction itself (for example it may generate an SQL error that it stores into the current THD). If using existing THD, security context of the thread is checked to make sure that required privileges exist. Passing NULL makes a temporary THD created as a execution context (and destroyed afterwards), i.e. no impacts on existing transactions. It doesn't make sense to change SESSION variable on a temporary THD, so this operation will generate error.

This is an example of using the service:

MYSQL_THD thd = nullptr;
 
if (!make_new_thread &&
    mysql_service_mysql_current_thread_reader->get(&thd)) {
  *error = 1;
  return 0;
}
 
const char *cs = "latin1";
const char *base_input = "my_component"; //nullptr if not a component variable
const char *name_input = "my_variable";
const char *type = "SESSION";
long long value_signed = 100000;
unsigned long long value_unsigned = 500000;
 
my_h_string base = nullptr, name = nullptr;
if ((base != nullptr &&
    mysql_service_mysql_string_converter->convert_from_buffer(
        &base, base_input, strlen(base_input), cs)) ||
    mysql_service_mysql_string_converter->convert_from_buffer(
        &name, name_input, strlen(name_input), cs)) {
  if (base) mysql_service_mysql_string_factory->destroy(base);
  if (name) mysql_service_mysql_string_factory->destroy(name);
  *error = 1;
  return 0;
}
 
// example call for signed integer system variable type
if (mysql_service_mysql_system_variable_update_integer->set_signed(
       thd, type, base, name, value_signed))
  *error = 1;
 
// alternative call for unsigned integer type
if (mysql_service_mysql_system_variable_update_integer->set_unsigned(
       thd, type, base, name, value_unsigned))
  *error = 1;
 
if (base) mysql_service_mysql_string_factory->destroy(base);
if (name) mysql_service_mysql_string_factory->destroy(name);

See also

mysql_system_variable_update_imp

mysql_service_mysql_system_variable_update_string_t

typedef struct s_mysql_mysql_system_variable_update_string mysql_service_mysql_system_variable_update_string_t

Service to set the value of system variables.

This is an example of using the service:

MYSQL_THD thd = nullptr;
 
if (!make_new_thread &&
    mysql_service_mysql_current_thread_reader->get(&thd)) {
  *error = 1;
  return 0;
}
 
const char *cs = "latin1";
const char *base_input = "my_component"; //nullptr if not a component variable
const char *name_input = "my_variable";
const char *value_input = "value";
const char *type = "GLOBAL";
 
my_h_string base = nullptr, name = nullptr, value = nullptr;
if ((base != nullptr &&
     mysql_service_mysql_string_converter->convert_from_buffer(
        &base, base_input, strlen(base_input), cs)) ||
    mysql_service_mysql_string_converter->convert_from_buffer(
        &name, name_input, strlen(name_input), cs) ||
    mysql_service_mysql_string_converter->convert_from_buffer(
        &value, value_input, strlen(value_input), cs) {
  if (base) mysql_service_mysql_string_factory->destroy(base);
  if (name) mysql_service_mysql_string_factory->destroy(name);
  if (value) mysql_service_mysql_string_factory->destroy(value);
  *error = 1;
  return 0;
}
 
if (mysql_service_mysql_system_variable_update_string->set(thd, type,
    base, name, value)) *error = 1;
 
if (base) mysql_service_mysql_string_factory->destroy(base);
if (name) mysql_service_mysql_string_factory->destroy(name);
if (value) mysql_service_mysql_string_factory->destroy(value);

See also

mysql_system_variable_update_imp

mysql_service_mysql_text_consumer_client_capabilities_v1_t

typedef struct s_mysql_mysql_text_consumer_client_capabilities_v1 mysql_service_mysql_text_consumer_client_capabilities_v1_t

A service that provides the apis for client_capabilities.

mysql_service_mysql_text_consumer_error_v1_t

typedef struct s_mysql_mysql_text_consumer_error_v1 mysql_service_mysql_text_consumer_error_v1_t

A service that provides the apis for handle_ok, handle_error and error.

mysql_service_mysql_text_consumer_factory_v1_t

typedef struct s_mysql_mysql_text_consumer_factory_v1 mysql_service_mysql_text_consumer_factory_v1_t

An implementation of these services will be called as the data resulting from calling mysql_query() service are produced by the server.

Most often the default implementation of this service that will cache the data into a memory structure into the MYSQL handle will be used. But this will only work if the resultset expected is relatively small.

Note

The default implementation will allow accessing the data after the query execution. This will not be possible with a custom method.

If one wants to avoid the memory caching and process the data SAX style as they are returned by the SQL execution define, they should provide their own implementation of this service that will process the data differently at the time of their production.

A service that provides the apis for start and end.

mysql_service_mysql_text_consumer_get_date_time_v1_t

typedef struct s_mysql_mysql_text_consumer_get_date_time_v1 mysql_service_mysql_text_consumer_get_date_time_v1_t

A service that provides the apis for get_date, get_time and get_datatime.

mysql_service_mysql_text_consumer_get_decimal_v1_t

typedef struct s_mysql_mysql_text_consumer_get_decimal_v1 mysql_service_mysql_text_consumer_get_decimal_v1_t

A service that provides the apis for get_decimal.

mysql_service_mysql_text_consumer_get_double_v1_t

typedef struct s_mysql_mysql_text_consumer_get_double_v1 mysql_service_mysql_text_consumer_get_double_v1_t

A service that provides the apis for get_double.

and error.

mysql_service_mysql_text_consumer_get_integer_v1_t

typedef struct s_mysql_mysql_text_consumer_get_integer_v1 mysql_service_mysql_text_consumer_get_integer_v1_t

A service that provides the apis for get_integer.

mysql_service_mysql_text_consumer_get_longlong_v1_t

typedef struct s_mysql_mysql_text_consumer_get_longlong_v1 mysql_service_mysql_text_consumer_get_longlong_v1_t

A service that provides the apis for get_longlong.

mysql_service_mysql_text_consumer_get_null_v1_t

typedef struct s_mysql_mysql_text_consumer_get_null_v1 mysql_service_mysql_text_consumer_get_null_v1_t

A service that provides the apis for get_null.

mysql_service_mysql_text_consumer_get_string_v1_t

typedef struct s_mysql_mysql_text_consumer_get_string_v1 mysql_service_mysql_text_consumer_get_string_v1_t

A service that provides the apis for get_string.

mysql_service_mysql_text_consumer_metadata_v1_t

typedef struct s_mysql_mysql_text_consumer_metadata_v1 mysql_service_mysql_text_consumer_metadata_v1_t

A service that provides the apis for start_result_metadata, field_metadata, and end_result_metadata.

mysql_service_mysql_text_consumer_row_factory_v1_t

typedef struct s_mysql_mysql_text_consumer_row_factory_v1 mysql_service_mysql_text_consumer_row_factory_v1_t

A service that provides the apis for start_row, abort_row and end_row.

mysql_service_mysql_thd_attributes_t

typedef struct s_mysql_mysql_thd_attributes mysql_service_mysql_thd_attributes_t

THD Attributes service allows to obtain data associated with the THD object, which keeps various attributes of the user session.

Currently, following attributes are supported:

• Query Digest Text
• Query Text
• Host or IP
• Schema

Initialization

The service can be instantiated using the registry service with the "mysql_thd_attributes" name.

SERVICE_TYPE(registry) *registry = mysql_plugin_registry_acquire();
my_service<SERVICE_TYPE(mysql_thd_attributes)>
                                       svc("mysql_thd_attributes", registry);
if (svc.is_valid()) {
  // The service is ready to be used
}

Query Digest Text

Query Digest represents converted SQL statement to normalized form. The code below demonstrates how query digest can be obtained from the service.

my_h_string str;
 
mysql_thd_attributes->get(m_thd, "query_digest",
                                 reinterpret_cast<void *>(&str));

The buffer can be fetched using the code below:

char buf[1024]; // buffer must be big enough to store the digest
 
mysql_string_converter->convert_to_buffer(str, buf, sizeof(buf), "utf8mb3");

After the string content has been copied into another buffer, it must be destroyed:

mysql_string_factory->destroy(str);

Query Text

Query text represents complete SQL text currently being executed within a given session. The example code is identical to the one for Query Digest, the only difference is that attribute name "sql_text" should be used in this case.

Host or IP

Host or IP text contains host or IP (if host unavailable) belonging to a client associated with a given session. The example code is identical to the one for Query Digest, the only difference is that attribute name "host_or_ip" should be used in this case.

Schema

Schema text contains a name of database currently in use by a client associated with a given session. The example code is identical to the one for Query Digest, the only difference is that attribute name "schema" should be used in this case.

mysql_service_psi_tls_channel_v1_t

typedef struct s_mysql_psi_tls_channel_v1 mysql_service_psi_tls_channel_v1_t

Service for instrumentation of TLS channel in performance schema.

mysql_service_reference_caching_channel_t

typedef struct s_mysql_reference_caching_channel mysql_service_reference_caching_channel_t

A reference caching channel service.

The goal of this service is to ensure that event producers spend a MINIMAL amount of time in the emitting code when there are no consumers of the produced events.

Terminology

An event consumer is an implementation of a component service. An event producer is a piece of code that wants to inform all currently registered event consumers about an event. A channel is a device that serves as a singleton of all reference caches for all threads that are to produce events. A reference cache is something each thread producing events must maintain for its lifetime and use it to find the references to event consumers it needs to call.

Typical lifetime of the event consumers

At init time the event consumer will register implementations of any of the services it's interested in receiving notifications for.

Then optionally it might force a channel invalidation to make sure all existing event producers will start sending notifications to it immediately. Or it can just sit and wait for the natural producer's reference cache refresh cycles to kick in.

Now it is receiving notifications from all event producers as they come.

When it wishes to no longer receive notifications it needs to mark itself as invisible for reference cache fill-ins. In this way all reference cache flushes will not pick this implementation up even if it's still registered in the registry.

Eventually all active references will be removed by the natural producers flush cycles. The consumer may choose to expedite this by triggering a channel invalidation.

As with all service implementations, when all references to the services are released it can unload.

Typical lifetime of the event producers

An event producer will usually start at init time by creating channel(s).

Then, for each thread wishing to produce events, a reference cache must be created and maintained until the thread will no longer be producing events.

Now the thread can produce events using the reference cache. This is done by calling the get method and then iterating over the resulting set of references and calling each one in turn as one would normally do for registry service references. It is assumed that the references are owned by the cache and thus they should not be released.

With some cyclical (e.g. at the end of each statement or something) the event producing thread needs to flush the cache. This is to ensure that references to event consumers are not held for very long and that new event consumers are picked up. However flushing the cache is a relatively expensive operation and thus a balance between the number of events produced and the cache being flushed must be achieved.

General remarks

Channels are something each event producer must have to produce events. Channels are to be created by a single thread before the first event is ever produced. And, once created they are to be kept until after the last event is produced.

Channels serve as singletons for caches and you only need one channel instance per event producer component. There usually will be multiple caches (one per event producing thread) per channel.

Creating and destroying a channel is a relatively "expensive" operation that might involve some synchronization and should not be done frequently.

Channels exist to allow a non-related thread to trigger invalidation of all currently active caches on that channel. This is necessary when for example event consumers are registered and are about to be removed.

Invalidating a channel is a thread-safe operation that can be invoked without synchronization at any time.

Each channel is associated with a specific set of service names.

Note

It is a set of service names, not implementation names !

The names are stored and used in event caches to handle all implementations of that particular service.

mysql_service_validate_password_changed_characters_t

typedef struct s_mysql_validate_password_changed_characters mysql_service_validate_password_changed_characters_t

Service to enforce that new password contains N different characters compared to existing password.

REQUIRES_SERVICE(validate_password_changed_characters)
bool compare_passwords(const char *current_password,
                       unsigned int current_password_length,
                       const char * new_oassword,
                       unsigned int new_password_length) {
  String current_password_string, new_password_string;
  current_password_string.assign(current_password, current_password_length,
                                 &my_charset_utf8mb3_bin);
  new_password_string.assign(new_password, new_password_length,
                             &my_charset_utf8mb3_bin);
  unsigned int min_required = 0, changed = 0;
  if (mysql_service_validate_password_changed_characters->validate(
        current_password_string, new_password_string,
        &min_required, &changed)) {
    // Raise error that min_required characters should be changed
    return true;
  }
  return false;
}

mysql_service_validate_password_t

typedef struct s_mysql_validate_password mysql_service_validate_password_t

Interfaces to enforce a password policy.

The policy is enfoced through two methods 1) validate() that answers the question of whether this password is good enough or not.

2) get_strength() that can be used by password changing UIs to display a password strength meter in the range of [0-100] as the user enters a password.

REQUIRES_SERVICE(validate_password);
bool validate_password(THD *thd, const char *password,
                       unsigned int password_length) {
  String password_string;
  password_string.set(password, password_length, &my_charset_utf8mb3_bin);
  if (mysql_service_validate_password->validate(thd, password_string)) {
    // Emit error that password does not adhere to policy criteria
    return true;
  }
  return false;
}
 
unsigned int get_password_strength(THD *thd, const char *password,
                                   unsigned int password_length) {
  String password_string;
  password_string.set(password, password_length, &my_charset_utf8mb3_bin);
  unsigned int strength = 0;
  if (mysql_service_validate_password->get_strength(thd, password_string,
                                                &strength)) {
    return 0;
  }
  return strength;
}