Collaboration diagram for Statement Instrumentation (ABI):

Classes
struct	PSI_statement_info_v1
	Statement instrument information. More...

struct	PSI_statement_locker_state_v5
	State data storage for `get_thread_statement_locker_v5_t`. More...

struct	PSI_sp_locker_state_v1

struct	PSI_statement_bootstrap
	Entry point for the performance schema interface. More...

struct	PSI_statement_service_v1
	Performance Schema Statement Interface, version 1. More...

struct	PSI_statement_service_v2
	Performance Schema Statement Interface, version 2. More...

struct	PSI_statement_service_v3
	Performance Schema Statement Interface, version 3. More...

struct	PSI_statement_service_v4
	Performance Schema Statement Interface, version 4. More...

struct	PSI_statement_service_v5
	Performance Schema Statement Interface, version 5. More...

Macros
#define	PSI_STATEMENT_VERSION_1 1
	Performance Schema Statement Interface number for version 1. More...

#define	PSI_STATEMENT_VERSION_2 2
	Performance Schema Statement Interface number for version 2. More...

#define	PSI_STATEMENT_VERSION_3 3
	Performance Schema Statement Interface number for version 3. More...

#define	PSI_STATEMENT_VERSION_4 4
	Performance Schema Statement Interface number for version 4. More...

#define	PSI_STATEMENT_VERSION_5 5
	Performance Schema Statement Interface number for version 5. More...

#define	PSI_CURRENT_STATEMENT_VERSION 5
	Performance Schema Statement Interface number for the most recent version. More...

#define	PSI_SCHEMA_NAME_LEN (64 * 3)

Typedefs
typedef unsigned int	PSI_statement_key
	Instrumented statement key. More...

typedef struct PSI_statement_locker	PSI_statement_locker

typedef struct PSI_prepared_stmt	PSI_prepared_stmt

typedef struct PSI_digest_locker	PSI_digest_locker

typedef struct PSI_sp_share	PSI_sp_share

typedef struct PSI_sp_locker	PSI_sp_locker

typedef struct PSI_statement_info_v1	PSI_statement_info_v1

typedef struct PSI_statement_locker_state_v5	PSI_statement_locker_state_v5

typedef struct PSI_sp_locker_state_v1	PSI_sp_locker_state_v1

typedef void(*	register_statement_v1_t) (const char category, struct PSI_statement_info_v1 info, int count)
	Statement registration API. More...

typedef struct PSI_statement_locker (	get_thread_statement_locker_v5_t) (struct PSI_statement_locker_state_v5 state, PSI_statement_key key, const void charset, PSI_sp_share *sp_share)
	Get a statement instrumentation locker. More...

typedef struct PSI_statement_locker (	refine_statement_v1_t) (struct PSI_statement_locker *locker, PSI_statement_key key)
	Refine a statement locker to a more specific key. More...

typedef void(*	start_statement_v1_t) (struct PSI_statement_locker locker, const char db, unsigned int db_length, const char *src_file, unsigned int src_line)
	Start a new statement event. More...

typedef void(*	set_statement_text_v1_t) (struct PSI_statement_locker locker, const char text, unsigned int text_len)
	Set the statement text for a statement event. More...

typedef void(*	set_statement_query_id_t) (struct PSI_statement_locker *locker, unsigned long long query_id)
	Set a statement query id. More...

typedef void(*	set_statement_lock_time_t) (struct PSI_statement_locker *locker, unsigned long long lock_time)
	Set a statement event lock time. More...

typedef void(*	set_statement_rows_sent_t) (struct PSI_statement_locker *locker, unsigned long long count)
	Set a statement event rows sent metric. More...

typedef void(*	set_statement_rows_examined_t) (struct PSI_statement_locker *locker, unsigned long long count)
	Set a statement event rows examined metric. More...

typedef void(*	inc_statement_created_tmp_disk_tables_t) (struct PSI_statement_locker *locker, unsigned long count)
	Increment a statement event "created tmp disk tables" metric. More...

typedef void(*	inc_statement_created_tmp_tables_t) (struct PSI_statement_locker *locker, unsigned long count)
	Increment a statement event "created tmp tables" metric. More...

typedef void(*	inc_statement_select_full_join_t) (struct PSI_statement_locker *locker, unsigned long count)
	Increment a statement event "select full join" metric. More...

typedef void(*	inc_statement_select_full_range_join_t) (struct PSI_statement_locker *locker, unsigned long count)
	Increment a statement event "select full range join" metric. More...

typedef void(*	inc_statement_select_range_t) (struct PSI_statement_locker *locker, unsigned long count)
	Increment a statement event "select range join" metric. More...

typedef void(*	inc_statement_select_range_check_t) (struct PSI_statement_locker *locker, unsigned long count)
	Increment a statement event "select range check" metric. More...

typedef void(*	inc_statement_select_scan_t) (struct PSI_statement_locker *locker, unsigned long count)
	Increment a statement event "select scan" metric. More...

typedef void(*	inc_statement_sort_merge_passes_t) (struct PSI_statement_locker *locker, unsigned long count)
	Increment a statement event "sort merge passes" metric. More...

typedef void(*	inc_statement_sort_range_t) (struct PSI_statement_locker *locker, unsigned long count)
	Increment a statement event "sort range" metric. More...

typedef void(*	inc_statement_sort_rows_t) (struct PSI_statement_locker *locker, unsigned long count)
	Increment a statement event "sort rows" metric. More...

typedef void(*	inc_statement_sort_scan_t) (struct PSI_statement_locker *locker, unsigned long count)
	Increment a statement event "sort scan" metric. More...

typedef void(*	set_statement_no_index_used_t) (struct PSI_statement_locker *locker)
	Set a statement event "no index used" metric. More...

typedef void(*	set_statement_no_good_index_used_t) (struct PSI_statement_locker *locker)
	Set a statement event "no good index used" metric. More...

typedef void(*	set_statement_secondary_engine_v3_t) (struct PSI_statement_locker *locker, bool secondary)
	Set a statement EXECUTION_ENGINE attribute. More...

typedef void(*	end_statement_v1_t) (struct PSI_statement_locker locker, void stmt_da)
	End a statement event. More...

typedef PSI_prepared_stmt (	create_prepared_stmt_v1_t) (void identity, unsigned int stmt_id, PSI_statement_locker locker, const char stmt_name, size_t stmt_name_length, const char sql_text, size_t sql_text_length)
	Get a prepare statement. More...

typedef void(*	destroy_prepared_stmt_v1_t) (PSI_prepared_stmt *prepared_stmt)
	destroy a prepare statement. More...

typedef void(*	reprepare_prepared_stmt_v1_t) (PSI_prepared_stmt *prepared_stmt)
	reprepare a prepare statement. More...

typedef void(*	execute_prepared_stmt_v1_t) (PSI_statement_locker locker, PSI_prepared_stmt prepared_stmt)
	Record a prepare statement instrumentation execute event. More...

typedef void(*	set_prepared_stmt_text_v1_t) (PSI_prepared_stmt prepared_stmt, const char text, unsigned int text_len)
	Set the statement text for a prepared statement event. More...

typedef void(*	set_prepared_stmt_secondary_engine_v3_t) (PSI_prepared_stmt *prepared_stmt, bool secondary)
	Set a prepared statement EXECUTION_ENGINE attribute. More...

typedef struct PSI_digest_locker (	digest_start_v1_t) (struct PSI_statement_locker *locker)
	Get a digest locker for the current statement. More...

typedef void(*	digest_end_v1_t) (struct PSI_digest_locker locker, const struct sql_digest_storage digest)
	Add a computed digest to the current digest instrumentation. More...

typedef struct PSI_sp_share (	get_sp_share_v1_t) (unsigned int object_type, const char schema_name, unsigned int schema_name_length, const char object_name, unsigned int object_name_length)
	Acquire a sp share instrumentation. More...

typedef void(*	release_sp_share_v1_t) (struct PSI_sp_share *share)
	Release a stored program share. More...

typedef PSI_sp_locker (	start_sp_v1_t) (struct PSI_sp_locker_state_v1 state, struct PSI_sp_share sp_share)

typedef void(*	end_sp_v1_t) (struct PSI_sp_locker *locker)

typedef void(*	drop_sp_v1_t) (unsigned int object_type, const char schema_name, unsigned int schema_name_length, const char object_name, unsigned int object_name_length)

typedef struct PSI_statement_info_v1	PSI_statement_info

typedef struct PSI_statement_locker_state_v5	PSI_statement_locker_state

typedef struct PSI_sp_locker_state_v1	PSI_sp_locker_state

typedef void(*	notify_statement_query_attributes_v5_t) (struct PSI_statement_locker *locker, bool with_query_attributes)

typedef void(*	statement_abort_telemetry_v5_t) (PSI_statement_locker *locker)

typedef struct PSI_statement_bootstrap	PSI_statement_bootstrap

typedef struct PSI_statement_service_v5	PSI_statement_service_t

Variables
MYSQL_PLUGIN_IMPORT PSI_statement_service_t *	psi_statement_service

Detailed Description

Macro Definition Documentation

◆ PSI_CURRENT_STATEMENT_VERSION

#define PSI_CURRENT_STATEMENT_VERSION 5

Performance Schema Statement Interface number for the most recent version.

The most current version is PSI_STATEMENT_VERSION_5

◆ PSI_SCHEMA_NAME_LEN

#define PSI_SCHEMA_NAME_LEN (64 * 3)

◆ PSI_STATEMENT_VERSION_1

#define PSI_STATEMENT_VERSION_1 1

Performance Schema Statement Interface number for version 1.

This version is obsolete.

◆ PSI_STATEMENT_VERSION_2

#define PSI_STATEMENT_VERSION_2 2

Performance Schema Statement Interface number for version 2.

This version is obsolete.

◆ PSI_STATEMENT_VERSION_3

#define PSI_STATEMENT_VERSION_3 3

Performance Schema Statement Interface number for version 3.

This version is obsolete.

◆ PSI_STATEMENT_VERSION_4

#define PSI_STATEMENT_VERSION_4 4

Performance Schema Statement Interface number for version 4.

This version is obsolete.

◆ PSI_STATEMENT_VERSION_5

#define PSI_STATEMENT_VERSION_5 5

Performance Schema Statement Interface number for version 5.

This version is supported.

Typedef Documentation

◆ create_prepared_stmt_v1_t

typedef PSI_prepared_stmt *(* create_prepared_stmt_v1_t) (void *identity, unsigned int stmt_id, PSI_statement_locker *locker, const char *stmt_name, size_t stmt_name_length, const char *sql_text, size_t sql_text_length)

Get a prepare statement.

Parameters

identity	Prepared statement identity, typically a memory address.
stmt_id	Prepared statement identifier.
locker	A statement locker for the running thread.
stmt_name	Prepared statement name.
stmt_name_length	Prepared statement name length.
sql_text	Query text.
sql_text_length	Query text length.

◆ destroy_prepared_stmt_v1_t

typedef void(* destroy_prepared_stmt_v1_t) (PSI_prepared_stmt *prepared_stmt)

destroy a prepare statement.

Parameters

prepared_stmt prepared statement.

◆ digest_end_v1_t

typedef void(* digest_end_v1_t) (struct PSI_digest_locker *locker, const struct sql_digest_storage *digest)

Add a computed digest to the current digest instrumentation.

Parameters

locker	a digest locker for the current statement
digest	the computed digest

◆ digest_start_v1_t

typedef struct PSI_digest_locker *(* digest_start_v1_t) (struct PSI_statement_locker *locker)

Get a digest locker for the current statement.

Parameters

locker a statement locker for the running thread

◆ drop_sp_v1_t

typedef void(* drop_sp_v1_t) (unsigned int object_type, const char *schema_name, unsigned int schema_name_length, const char *object_name, unsigned int object_name_length)

◆ end_sp_v1_t

typedef void(* end_sp_v1_t) (struct PSI_sp_locker *locker)

◆ end_statement_v1_t

typedef void(* end_statement_v1_t) (struct PSI_statement_locker *locker, void *stmt_da)

End a statement event.

Parameters

locker	the statement locker
stmt_da	the statement diagnostics area.

See also: Diagnostics_area

◆ execute_prepared_stmt_v1_t

typedef void(* execute_prepared_stmt_v1_t) (PSI_statement_locker *locker, PSI_prepared_stmt *prepared_stmt)

Record a prepare statement instrumentation execute event.

Parameters

locker	a statement locker for the running thread.
prepared_stmt	prepared statement.

◆ get_sp_share_v1_t

typedef struct PSI_sp_share *(* get_sp_share_v1_t) (unsigned int object_type, const char *schema_name, unsigned int schema_name_length, const char *object_name, unsigned int object_name_length)

Acquire a sp share instrumentation.

Parameters

object_type	type of stored program
schema_name	schema name of stored program
schema_name_length	length of schema_name
object_name	object name of stored program
object_name_length	length of object_name

Returns: a stored program share instrumentation, or NULL

◆ get_thread_statement_locker_v5_t

typedef struct PSI_statement_locker *(* get_thread_statement_locker_v5_t) (struct PSI_statement_locker_state_v5 *state, PSI_statement_key key, const void *charset, PSI_sp_share *sp_share)

Get a statement instrumentation locker.

Parameters

state	data storage for the locker
key	the statement instrumentation key
charset	client character set
sp_share	Parent stored procedure share, if any.

Returns: a statement locker, or NULL

◆ inc_statement_created_tmp_disk_tables_t

typedef void(* inc_statement_created_tmp_disk_tables_t) (struct PSI_statement_locker *locker, unsigned long count)

Increment a statement event "created tmp disk tables" metric.

Parameters

locker	the statement locker
count	the metric increment value

◆ inc_statement_created_tmp_tables_t

typedef void(* inc_statement_created_tmp_tables_t) (struct PSI_statement_locker *locker, unsigned long count)

Increment a statement event "created tmp tables" metric.

Parameters

locker	the statement locker
count	the metric increment value

◆ inc_statement_select_full_join_t

typedef void(* inc_statement_select_full_join_t) (struct PSI_statement_locker *locker, unsigned long count)

Increment a statement event "select full join" metric.

Parameters

locker	the statement locker
count	the metric increment value

◆ inc_statement_select_full_range_join_t

typedef void(* inc_statement_select_full_range_join_t) (struct PSI_statement_locker *locker, unsigned long count)

Increment a statement event "select full range join" metric.

Parameters

locker	the statement locker
count	the metric increment value

◆ inc_statement_select_range_check_t

typedef void(* inc_statement_select_range_check_t) (struct PSI_statement_locker *locker, unsigned long count)

Increment a statement event "select range check" metric.

Parameters

locker	the statement locker
count	the metric increment value

◆ inc_statement_select_range_t

typedef void(* inc_statement_select_range_t) (struct PSI_statement_locker *locker, unsigned long count)

Increment a statement event "select range join" metric.

Parameters

locker	the statement locker
count	the metric increment value

◆ inc_statement_select_scan_t

typedef void(* inc_statement_select_scan_t) (struct PSI_statement_locker *locker, unsigned long count)

Increment a statement event "select scan" metric.

Parameters

locker	the statement locker
count	the metric increment value

◆ inc_statement_sort_merge_passes_t

typedef void(* inc_statement_sort_merge_passes_t) (struct PSI_statement_locker *locker, unsigned long count)

Increment a statement event "sort merge passes" metric.

Parameters

locker	the statement locker
count	the metric increment value

◆ inc_statement_sort_range_t

typedef void(* inc_statement_sort_range_t) (struct PSI_statement_locker *locker, unsigned long count)

Increment a statement event "sort range" metric.

Parameters

locker	the statement locker
count	the metric increment value

◆ inc_statement_sort_rows_t

typedef void(* inc_statement_sort_rows_t) (struct PSI_statement_locker *locker, unsigned long count)

Increment a statement event "sort rows" metric.

Parameters

locker	the statement locker
count	the metric increment value

◆ inc_statement_sort_scan_t

typedef void(* inc_statement_sort_scan_t) (struct PSI_statement_locker *locker, unsigned long count)

Increment a statement event "sort scan" metric.

Parameters

locker	the statement locker
count	the metric increment value

◆ notify_statement_query_attributes_v5_t

typedef void(* notify_statement_query_attributes_v5_t) (struct PSI_statement_locker *locker, bool with_query_attributes)

◆ PSI_digest_locker

typedef struct PSI_digest_locker PSI_digest_locker

◆ PSI_prepared_stmt

typedef struct PSI_prepared_stmt PSI_prepared_stmt

◆ PSI_sp_locker

typedef struct PSI_sp_locker PSI_sp_locker

◆ PSI_sp_locker_state

typedef struct PSI_sp_locker_state_v1 PSI_sp_locker_state

◆ PSI_sp_locker_state_v1

typedef struct PSI_sp_locker_state_v1 PSI_sp_locker_state_v1

◆ PSI_sp_share

typedef struct PSI_sp_share PSI_sp_share

◆ PSI_statement_bootstrap

typedef struct PSI_statement_bootstrap PSI_statement_bootstrap

◆ PSI_statement_info

typedef struct PSI_statement_info_v1 PSI_statement_info

◆ PSI_statement_info_v1

typedef struct PSI_statement_info_v1 PSI_statement_info_v1

◆ PSI_statement_key

typedef unsigned int PSI_statement_key

Instrumented statement key.

To instrument a statement, a statement key must be obtained using register_statement. Using a zero key always disable the instrumentation.

◆ PSI_statement_locker

typedef struct PSI_statement_locker PSI_statement_locker

◆ PSI_statement_locker_state

typedef struct PSI_statement_locker_state_v5 PSI_statement_locker_state

◆ PSI_statement_locker_state_v5

typedef struct PSI_statement_locker_state_v5 PSI_statement_locker_state_v5

◆ PSI_statement_service_t

typedef struct PSI_statement_service_v5 PSI_statement_service_t

◆ refine_statement_v1_t

typedef struct PSI_statement_locker *(* refine_statement_v1_t) (struct PSI_statement_locker *locker, PSI_statement_key key)

Refine a statement locker to a more specific key.

Note that only events declared mutable can be refined.

Parameters

locker	the statement locker for the current event
key	the new key for the event

See also: PSI_FLAG_MUTABLE

◆ register_statement_v1_t

typedef void(* register_statement_v1_t) (const char *category, struct PSI_statement_info_v1 *info, int count)

Statement registration API.

Parameters

category	a category name
info	an array of statement info to register
count	the size of the info array

◆ release_sp_share_v1_t

typedef void(* release_sp_share_v1_t) (struct PSI_sp_share *share)

Release a stored program share.

Parameters

share the stored program share to release

◆ reprepare_prepared_stmt_v1_t

typedef void(* reprepare_prepared_stmt_v1_t) (PSI_prepared_stmt *prepared_stmt)

reprepare a prepare statement.

Parameters

prepared_stmt prepared statement.

◆ set_prepared_stmt_secondary_engine_v3_t

typedef void(* set_prepared_stmt_secondary_engine_v3_t) (PSI_prepared_stmt *prepared_stmt, bool secondary)

Set a prepared statement EXECUTION_ENGINE attribute.

Parameters

prepared_stmt	prepared statement.
secondary	True for SECONDARY, false for PRIMARY.

◆ set_prepared_stmt_text_v1_t

typedef void(* set_prepared_stmt_text_v1_t) (PSI_prepared_stmt *prepared_stmt, const char *text, unsigned int text_len)

Set the statement text for a prepared statement event.

Parameters

prepared_stmt	prepared statement.
text	the prepared statement text
text_len	the prepared statement text length

◆ set_statement_lock_time_t

typedef void(* set_statement_lock_time_t) (struct PSI_statement_locker *locker, unsigned long long lock_time)

Set a statement event lock time.

Parameters

locker	the statement locker
lock_time	the locked time, in microseconds

◆ set_statement_no_good_index_used_t

typedef void(* set_statement_no_good_index_used_t) (struct PSI_statement_locker *locker)

Set a statement event "no good index used" metric.

Parameters

locker the statement locker

◆ set_statement_no_index_used_t

typedef void(* set_statement_no_index_used_t) (struct PSI_statement_locker *locker)

Set a statement event "no index used" metric.

Parameters

locker the statement locker

◆ set_statement_query_id_t

typedef void(* set_statement_query_id_t) (struct PSI_statement_locker *locker, unsigned long long query_id)

Set a statement query id.

Introduced in MySQL 8.0.14

Parameters

locker	the statement locker
query_id	the query id

◆ set_statement_rows_examined_t

typedef void(* set_statement_rows_examined_t) (struct PSI_statement_locker *locker, unsigned long long count)

Set a statement event rows examined metric.

Parameters

locker	the statement locker
count	the number of rows examined

◆ set_statement_rows_sent_t

typedef void(* set_statement_rows_sent_t) (struct PSI_statement_locker *locker, unsigned long long count)

Set a statement event rows sent metric.

Parameters

locker	the statement locker
count	the number of rows sent

◆ set_statement_secondary_engine_v3_t

typedef void(* set_statement_secondary_engine_v3_t) (struct PSI_statement_locker *locker, bool secondary)

Set a statement EXECUTION_ENGINE attribute.

Parameters

locker	the statement locker
secondary	True for SECONDARY, false for PRIMARY.

◆ set_statement_text_v1_t

typedef void(* set_statement_text_v1_t) (struct PSI_statement_locker *locker, const char *text, unsigned int text_len)

Set the statement text for a statement event.

Note that the statement text pointer must remain valid until end statement is called.

Parameters

locker	the current statement locker
text	the statement text
text_len	the statement text length

◆ start_sp_v1_t

typedef PSI_sp_locker *(* start_sp_v1_t) (struct PSI_sp_locker_state_v1 *state, struct PSI_sp_share *sp_share)

◆ start_statement_v1_t

typedef void(* start_statement_v1_t) (struct PSI_statement_locker *locker, const char *db, unsigned int db_length, const char *src_file, unsigned int src_line)

Start a new statement event.

Parameters

locker	the statement locker for this event
db	the active database name for this statement
db_length	the active database name length for this statement
src_file	source file name
src_line	source line number

◆ statement_abort_telemetry_v5_t

typedef void(* statement_abort_telemetry_v5_t) (PSI_statement_locker *locker)

Variable Documentation

◆ psi_statement_service

MYSQL_PLUGIN_IMPORT PSI_statement_service_t* psi_statement_service

extern

Classes

Macros

Typedefs

Variables

Detailed Description

Macro Definition Documentation

◆ PSI_CURRENT_STATEMENT_VERSION

◆ PSI_SCHEMA_NAME_LEN

◆ PSI_STATEMENT_VERSION_1

◆ PSI_STATEMENT_VERSION_2

◆ PSI_STATEMENT_VERSION_3

◆ PSI_STATEMENT_VERSION_4

◆ PSI_STATEMENT_VERSION_5

Typedef Documentation

◆ create_prepared_stmt_v1_t

◆ destroy_prepared_stmt_v1_t

◆ digest_end_v1_t

◆ digest_start_v1_t

◆ drop_sp_v1_t

◆ end_sp_v1_t

◆ end_statement_v1_t

◆ execute_prepared_stmt_v1_t

◆ get_sp_share_v1_t

◆ get_thread_statement_locker_v5_t

◆ inc_statement_created_tmp_disk_tables_t

◆ inc_statement_created_tmp_tables_t

◆ inc_statement_select_full_join_t

◆ inc_statement_select_full_range_join_t

◆ inc_statement_select_range_check_t

◆ inc_statement_select_range_t

◆ inc_statement_select_scan_t

◆ inc_statement_sort_merge_passes_t

◆ inc_statement_sort_range_t

◆ inc_statement_sort_rows_t

◆ inc_statement_sort_scan_t

◆ notify_statement_query_attributes_v5_t

◆ PSI_digest_locker

◆ PSI_prepared_stmt

◆ PSI_sp_locker

◆ PSI_sp_locker_state

◆ PSI_sp_locker_state_v1

◆ PSI_sp_share

◆ PSI_statement_bootstrap

◆ PSI_statement_info

◆ PSI_statement_info_v1

◆ PSI_statement_key

◆ PSI_statement_locker

◆ PSI_statement_locker_state

◆ PSI_statement_locker_state_v5

◆ PSI_statement_service_t

◆ refine_statement_v1_t

◆ register_statement_v1_t

◆ release_sp_share_v1_t

◆ reprepare_prepared_stmt_v1_t

◆ set_prepared_stmt_secondary_engine_v3_t

◆ set_prepared_stmt_text_v1_t

◆ set_statement_lock_time_t

◆ set_statement_no_good_index_used_t

◆ set_statement_no_index_used_t

◆ set_statement_query_id_t

◆ set_statement_rows_examined_t

◆ set_statement_rows_sent_t

◆ set_statement_secondary_engine_v3_t

◆ set_statement_text_v1_t

◆ start_sp_v1_t

◆ start_statement_v1_t

◆ statement_abort_telemetry_v5_t

Variable Documentation

◆ psi_statement_service