MySQL 9.0.0
Source Code Documentation
global_variable_attributes_bits.h File Reference

Go to the source code of this file.

Typedefs

typedef struct global_variable_attributes_iterator_imp * global_variable_attributes_iterator
 
typedef bool(* global_variable_attributes_iterator_create_t) (const char *variable_base, const char *variable_name, const char *attribute_name, global_variable_attributes_iterator *iterator)
 Initialize System Variable Attributes iterator object to enumerate key/value attributes attached to system variables, pointing to 1st matching attribute. More...
 
typedef bool(* global_variable_attributes_iterator_destroy_t) (global_variable_attributes_iterator iterator)
 Uninitialize System Variable Attributes iterator. More...
 
typedef bool(* global_variable_attributes_iterator_advance_t) (global_variable_attributes_iterator iterator)
 Advance System Variable Attributes iterator to next element. More...
 
typedef bool(* global_variable_attributes_iterator_get_name_t) (global_variable_attributes_iterator iterator, my_h_string *out_name_handle)
 Return attribute name for the element pointed by System Variable Attributes iterator. More...
 
typedef bool(* global_variable_attributes_iterator_get_value_t) (global_variable_attributes_iterator iterator, my_h_string *out_value_handle)
 Return attribute value for the element pointed by System Variable Attributes iterator. More...
 
typedef bool(* global_variable_attributes_assign_t) (const char *variable_base, const char *variable_name, const char *attribute_name, const char *attribute_value)
 Attach a single key/value attribute to a given global system variable, or delete one or all attributes of a given variable. More...
 
typedef bool(* global_variable_attributes_get_t) (const char *variable_base, const char *variable_name, const char *attribute_name, char *attribute_value_buffer, size_t *inout_attribute_value_length)
 Read a single global system variable attribute value, if exists. More...
 
typedef bool(* global_variable_attributes_get_time_t) (const char *variable_base, const char *variable_name, char *timestamp_value_buffer, size_t *inout_timestamp_value_length)
 Read timestamp indicating when a global system variable was last modified. More...
 
typedef bool(* global_variable_attributes_get_user_t) (const char *variable_base, const char *variable_name, char *user_value_buffer, size_t *inout_user_value_length)
 Read user name that last modified a global system variable. More...
 

Typedef Documentation

◆ global_variable_attributes_assign_t

typedef bool(* global_variable_attributes_assign_t) (const char *variable_base, const char *variable_name, const char *attribute_name, const char *attribute_value)

Attach a single key/value attribute to a given global system variable, or delete one or all attributes of a given variable.

Parameters
variable_baseVariable prefix, NULL if none.
variable_nameVariable name.
attribute_nameAttribute name, if nullptr unset all attributes for the variable.
attribute_valueAttribute value, if nullptr unset the attribute.
Returns
Result of operation
Return values
falseSuccess
trueFailure or no more elements

◆ global_variable_attributes_get_t

typedef bool(* global_variable_attributes_get_t) (const char *variable_base, const char *variable_name, const char *attribute_name, char *attribute_value_buffer, size_t *inout_attribute_value_length)

Read a single global system variable attribute value, if exists.

Parameters
variable_baseVariable prefix, NULL if none.
variable_nameVariable name.
attribute_nameAttribute name.
attribute_value_bufferPointer to buffer to receive the result.
inout_attribute_value_lengthBuffer size, also used to return value string size.
Returns
Result of operation
Return values
falseSuccess
trueFailure or no more elements

◆ global_variable_attributes_get_time_t

typedef bool(* global_variable_attributes_get_time_t) (const char *variable_base, const char *variable_name, char *timestamp_value_buffer, size_t *inout_timestamp_value_length)

Read timestamp indicating when a global system variable was last modified.

Parameters
variable_baseVariable prefix, NULL if none.
variable_nameVariable name.
timestamp_value_bufferPointer to buffer to receive the result.
inout_timestamp_value_lengthBuffer size, also used to return value string size.
Returns
Result of operation
Return values
falseSuccess
trueFailure or no more elements

◆ global_variable_attributes_get_user_t

typedef bool(* global_variable_attributes_get_user_t) (const char *variable_base, const char *variable_name, char *user_value_buffer, size_t *inout_user_value_length)

Read user name that last modified a global system variable.

Parameters
variable_baseVariable prefix, NULL if none.
variable_nameVariable name.
user_value_bufferPointer to buffer to receive the result.
inout_user_value_lengthBuffer size, also used to return value string size.
Returns
Result of operation
Return values
falseSuccess
trueFailure or no more elements

◆ global_variable_attributes_iterator

typedef struct global_variable_attributes_iterator_imp* global_variable_attributes_iterator

◆ global_variable_attributes_iterator_advance_t

typedef bool(* global_variable_attributes_iterator_advance_t) (global_variable_attributes_iterator iterator)

Advance System Variable Attributes iterator to next element.

Parameters
iteratoriterator object
Returns
Result of iterator creation
Return values
falseSuccess
trueFailure or no more elements

◆ global_variable_attributes_iterator_create_t

typedef bool(* global_variable_attributes_iterator_create_t) (const char *variable_base, const char *variable_name, const char *attribute_name, global_variable_attributes_iterator *iterator)

Initialize System Variable Attributes iterator object to enumerate key/value attributes attached to system variables, pointing to 1st matching attribute.

Parameters
variable_baseVariable prefix or NULL if none.
variable_namedefine system variable scope
attribute_nameOptional attribute name scope (NULL to iterate all attributes of a variable)
[out]iteratoriterator object
Returns
Result of iterator creation
Return values
falseSuccess
trueFailure

◆ global_variable_attributes_iterator_destroy_t

typedef bool(* global_variable_attributes_iterator_destroy_t) (global_variable_attributes_iterator iterator)

Uninitialize System Variable Attributes iterator.

Parameters
iteratoriterator object
Returns
Result of iterator creation
Return values
falseSuccess
trueFailure

◆ global_variable_attributes_iterator_get_name_t

typedef bool(* global_variable_attributes_iterator_get_name_t) (global_variable_attributes_iterator iterator, my_h_string *out_name_handle)

Return attribute name for the element pointed by System Variable Attributes iterator.

Parameters
iteratoriterator object
[out]out_name_handlepointer to receive name string content
Returns
Result of operation
Return values
falseSuccess
trueFailure or no more elements

◆ global_variable_attributes_iterator_get_value_t

typedef bool(* global_variable_attributes_iterator_get_value_t) (global_variable_attributes_iterator iterator, my_h_string *out_value_handle)

Return attribute value for the element pointed by System Variable Attributes iterator.

Parameters
iteratoriterator object
[out]out_value_handlepointer to receive value string content
Returns
Result of operation
Return values
falseSuccess
trueFailure or no more elements