oracle.oci.oci_mysql_configuration – Manage a Configuration resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.3.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install oracle.oci.
To use it in a playbook, specify: oracle.oci.oci_mysql_configuration.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete a Configuration resource in Oracle Cloud Infrastructure
For state=present, creates a new Configuration.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
Parameters¶
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
|
api_user
string
|
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See
config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm. |
||
|
api_user_fingerprint
string
|
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See
config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm. |
||
|
api_user_key_file
string
|
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See
config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided. |
||
|
api_user_key_pass_phrase
string
|
Passphrase used by the key referenced in
api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location). |
||
|
auth_purpose
string
|
|
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
|
|
|
auth_type
string
|
|
The type of authentication to use for making API requests. By default
auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance. |
|
|
cert_bundle
string
|
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
|
||
|
compartment_id
string
|
The OCID of the compartment.
Required for create using state=present.
Required for update when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.Required for delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set. |
||
|
config_file_location
string
|
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
|
||
|
config_profile_name
string
|
The profile to load from the config file referenced by
config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location. |
||
|
configuration_id
string
|
The OCID of the Configuration.
Required for update using state=present when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.Required for delete using state=absent when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: id |
||
|
defined_tags
dictionary
|
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
|
||
|
description
string
|
User-provided data about the Configuration.
This parameter is updatable.
|
||
|
display_name
string
|
The display name of the Configuration.
Required for create, update, delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.This parameter is updatable when
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: name |
||
|
force_create
boolean
|
|
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
|
|
|
freeform_tags
dictionary
|
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
This parameter is updatable.
|
||
|
init_variables
dictionary
|
|||
|
lower_case_table_names
string
|
|
Represents the MySQL server system variable lower_case_table_names (https://dev.mysql.com/doc/refman/8.0/en/server-system- variables.html#sysvar_lower_case_table_names).
lowerCaseTableNames controls case-sensitivity of tables and schema names and how they are stored in the DB System.
Valid values are: - CASE_SENSITIVE - (default) Table and schema name comparisons are case-sensitive and stored as specified. (lower_case_table_names=0) - CASE_INSENSITIVE_LOWERCASE - Table and schema name comparisons are not case-sensitive and stored in lowercase. (lower_case_table_names=1)
|
|
|
key_by
list
/ elements=string
|
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
|
||
|
parent_configuration_id
string
|
The OCID of the Configuration from which the new Configuration is derived. The values in CreateConfigurationDetails.variables supersede the variables of the parent Configuration.
|
||
|
realm_specific_endpoint_template_enabled
boolean
|
|
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
|
|
|
region
string
|
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See
config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions. |
||
|
shape_name
string
|
The name of the associated Shape.
Required for create using state=present.
|
||
|
state
string
|
|
The state of the Configuration.
Use state=present to create or update a Configuration.
Use state=absent to delete a Configuration.
|
|
|
tenancy
string
|
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See
config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm |
||
|
variables
dictionary
|
|||
|
autocommit
boolean
|
|
("autocommit")
|
|
|
big_tables
boolean
|
|
If enabled, the server stores all temporary tables on disk rather than in memory.
bigTables corresponds to the MySQL server variable big_tables.
|
|
|
binlog_expire_logs_seconds
integer
|
Sets the binary log expiration period in seconds. binlogExpireLogsSeconds corresponds to the MySQL binary logging system variable binlog_expire_logs_seconds.
|
||
|
binlog_row_metadata
string
|
|
Configures the amount of table metadata added to the binary log when using row-based logging. binlogRowMetadata corresponds to the MySQL binary logging system variable binlog_row_metadata.
|
|
|
binlog_row_value_options
string
|
When set to PARTIAL_JSON, this enables use of a space-efficient binary log format for updates that modify only a small portion of a JSON document. binlogRowValueOptions corresponds to the MySQL binary logging system variable binlog_row_value_options.
|
||
|
binlog_transaction_compression
boolean
|
|
Enables compression for transactions that are written to binary log files on this server. binlogTransactionCompression corresponds to the MySQL binary logging system variable binlog_transaction_compression.
|
|
|
completion_type
string
|
|
("completion_type")
|
|
|
connect_timeout
integer
|
The number of seconds that the mysqld server waits for a connect packet before responding with Bad handshake.
connectTimeout corresponds to the MySQL system variable connect_timeout
Increasing the connect_timeout value might help if clients frequently encounter errors of the form "Lost connection to MySQL server at 'XXX', system error: errno".
|
||
|
connection_memory_chunk_size
integer
|
Set the chunking size for updates to the global memory usage counter Global_connection_memory.
connectionMemoryChunkSize corresponds to the MySQL system variable connection_memory_chunk_size.
|
||
|
connection_memory_limit
integer
|
Set the maximum amount of memory that can be used by a single user connection.
connectionMemoryLimit corresponds to the MySQL system variable connection_memory_limit.
|
||
|
cte_max_recursion_depth
integer
|
("cte_max_recursion_depth")
|
||
|
default_authentication_plugin
string
|
|
("default_authentication_plugin")
|
|
|
foreign_key_checks
boolean
|
|
("foreign_key_checks")
|
|
|
generated_random_password_length
integer
|
("generated_random_password_length") DEPRECATED -- variable should not be settable and will be ignored
|
||
|
global_connection_memory_limit
integer
|
Set the total amount of memory that can be used by all user connections.
globalConnectionMemoryLimit corresponds to the MySQL system variable global_connection_memory_limit.
|
||
|
global_connection_memory_tracking
boolean
|
|
Determines whether the MySQL server calculates Global_connection_memory.
globalConnectionMemoryTracking corresponds to the MySQL system variable global_connection_memory_tracking.
|
|
|
group_replication_consistency
string
|
|
- EVENTUAL: Both RO and RW transactions do not wait for preceding transactions to be applied before executing. A RW transaction does not wait for other members to apply a transaction. This means that a transaction could be externalized on one member before the others. This also means that in the event of a primary failover, the new primary can accept new RO and RW transactions before the previous primary transactions are all applied. RO transactions could result in outdated values, RW transactions could result in a rollback due to conflicts. - BEFORE_ON_PRIMARY_FAILOVER: New RO or RW transactions with a newly elected primary that is applying backlog from the old primary are held (not applied) until any backlog has been applied. This ensures that when a primary failover happens, intentionally or not, clients always see the latest value on the primary. This guarantees consistency, but means that clients must be able to handle the delay in the event that a backlog is being applied. Usually this delay should be minimal, but does depend on the size of the backlog. - BEFORE: A RW transaction waits for all preceding transactions to complete before being applied. A RO transaction waits for all preceding transactions to complete before being executed. This ensures that this transaction reads the latest value by only affecting the latency of the transaction. This reduces the overhead of synchronization on every RW transaction, by ensuring synchronization is used only on RO transactions. This consistency level also includes the consistency guarantees provided by BEFORE_ON_PRIMARY_FAILOVER. - AFTER: A RW transaction waits until its changes have been applied to all of the other members. This value has no effect on RO transactions. This mode ensures that when a transaction is committed on the local member, any subsequent transaction reads the written value or a more recent value on any group member. Use this mode with a group that is used for predominantly RO operations to ensure that applied RW transactions are applied everywhere once they commit. This could be used by your application to ensure that subsequent reads fetch the latest data which includes the latest writes. This reduces the overhead of synchronization on every RO transaction, by ensuring synchronization is used only on RW transactions. This consistency level also includes the consistency guarantees provided by BEFORE_ON_PRIMARY_FAILOVER. - BEFORE_AND_AFTER: A RW transaction waits for 1) all preceding transactions to complete before being applied and 2) until its changes have been applied on other members. A RO transaction waits for all preceding transactions to complete before execution takes place. This consistency level also includes the consistency guarantees provided by BEFORE_ON_PRIMARY_FAILOVER.
|
|
|
information_schema_stats_expiry
integer
|
("information_schema_stats_expiry")
|
||
|
innodb_buffer_pool_dump_pct
integer
|
Specifies the percentage of the most recently used pages for each buffer pool to read out and dump.
innodbBufferPoolDumpPct corresponds to the MySQL InnoDB system variable innodb_buffer_pool_dump_pct.
The range is 1 to 100. The default value is 25.
For example, if there are 4 buffer pools with 100 pages each, and innodb_buffer_pool_dump_pct is set to 25, the 25 most recently used pages from each buffer pool are dumped.
|
||
|
innodb_buffer_pool_instances
integer
|
("innodb_buffer_pool_instances")
|
||
|
innodb_buffer_pool_size
integer
|
The size (in bytes) of the buffer pool, that is, the memory area where InnoDB caches table and index data.
innodbBufferPoolSize corresponds to the MySQL server system variable innodb_buffer_pool_size.
The default and maximum values depend on the amount of RAM provisioned by the shape. See Default User Variables.
|
||
|
innodb_ddl_buffer_size
integer
|
innodbDdlBufferSize corresponds to the MySQL system variable innodb_ddl_buffer_size]
|
||
|
innodb_ddl_threads
integer
|
innodbDdlThreads corresponds to the MySQL system variable innodb_ddl_threads]
|
||
|
innodb_ft_enable_stopword
boolean
|
|
("innodb_ft_enable_stopword")
|
|
|
innodb_ft_max_token_size
integer
|
("innodb_ft_max_token_size")
|
||
|
innodb_ft_min_token_size
integer
|
("innodb_ft_min_token_size")
|
||
|
innodb_ft_num_word_optimize
integer
|
("innodb_ft_num_word_optimize")
|
||
|
innodb_ft_result_cache_limit
integer
|
("innodb_ft_result_cache_limit")
|
||
|
innodb_ft_server_stopword_table
string
|
("innodb_ft_server_stopword_table")
|
||
|
innodb_lock_wait_timeout
integer
|
("innodb_lock_wait_timeout")
|
||
|
innodb_log_writer_threads
boolean
|
|
Enables dedicated log writer threads for writing redo log records from the log buffer to the system buffers and flushing the system buffers to the redo log files.
This is the MySQL variable "innodb_log_writer_threads". For more information, please see the MySQL documentation
|
|
|
innodb_max_purge_lag
integer
|
The desired maximum purge lag in terms of transactions.
InnoDB maintains a list of transactions that have index records delete-marked by UPDATE or DELETE operations. The length of the list is the purge lag.
If this value is exceeded, a delay is imposed on INSERT, UPDATE, and DELETE operations to allow time for purge to catch up.
The default value is 0, which means there is no maximum purge lag and no delay.
innodbMaxPurgeLag corresponds to the MySQL server system variable innodb_max_purge_lag.
|
||
|
innodb_max_purge_lag_delay
integer
|
The maximum delay in microseconds for the delay imposed when the innodb_max_purge_lag threshold is exceeded.
The specified innodb_max_purge_lag_delay value is an upper limit on the delay period.
innodbMaxPurgeLagDelay corresponds to the MySQL server system variable innodb_max_purge_lag_delay.
|
||
|
innodb_stats_persistent_sample_pages
integer
|
The number of index pages to sample when estimating cardinality and other statistics for an indexed column, such as those calculated by ANALYZE TABLE.
innodbStatsPersistentSamplePages corresponds to the MySQL InnoDB system variable innodb_stats_persistent_sample_pages
innodb_stats_persistent_sample_pages only applies when innodb_stats_persistent is enabled for a table; when innodb_stats_persistent is disabled, innodb_stats_transient_sample_pages applies instead.
|
||
|
innodb_stats_transient_sample_pages
integer
|
The number of index pages to sample when estimating cardinality and other statistics for an indexed column, such as those calculated by ANALYZE TABLE.
innodbStatsTransientSamplePages corresponds to the MySQL InnoDB system variable innodb_stats_transient_sample_pages
innodb_stats_transient_sample_pages only applies when innodb_stats_persistent is disabled for a table; when innodb_stats_persistent is enabled, innodb_stats_persistent_sample_pages applies instead.
innodb_stats_persistent is ON by default and cannot be changed. It is possible to override it using the STATS_PERSISTENT clause of the CREATE TABLE and ALTER TABLE statements.
|
||
|
interactive_timeout
integer
|
The number of seconds the server waits for activity on an interactive connection before closing it.
interactiveTimeout corresponds to the MySQL system variable. interactive_timeout
|
||
|
local_infile
boolean
|
|
("local_infile")
|
|
|
mandatory_roles
string
|
("mandatory_roles")
|
||
|
max_allowed_packet
integer
|
The maximum size of one packet or any generated/intermediate string.
This is the mysql variable "max_allowed_packet".
|
||
|
max_binlog_cache_size
integer
|
Sets the size of the transaction cache.
maxBinlogCacheSize corresponds to the MySQL server system variable max_binlog_cache_size.
|
||
|
max_connect_errors
integer
|
("max_connect_errors")
|
||
|
max_connections
integer
|
("max_connections")
|
||
|
max_execution_time
integer
|
("max_execution_time")
|
||
|
max_heap_table_size
integer
|
This variable sets the maximum size to which user-created MEMORY tables are permitted to grow.
maxHeapTableSize corresponds to the MySQL system variable max_heap_table_size
|
||
|
max_prepared_stmt_count
integer
|
("max_prepared_stmt_count")
|
||
|
mysql_firewall_mode
boolean
|
|
("mysql_firewall_mode")
|
|
|
mysql_zstd_default_compression_level
integer
|
DEPRECATED -- typo of mysqlx_zstd_default_compression_level. variable will be ignored.
|
||
|
mysqlx_connect_timeout
integer
|
The number of seconds X Plugin waits for the first packet to be received from newly connected clients.
mysqlxConnectTimeout corresponds to the MySQL X Plugin system variable mysqlx_connect_timeout
|
||
|
mysqlx_deflate_default_compression_level
integer
|
Set the default compression level for the deflate algorithm. ("mysqlx_deflate_default_compression_level")
|
||
|
mysqlx_deflate_max_client_compression_level
integer
|
Limit the upper bound of accepted compression levels for the deflate algorithm. ("mysqlx_deflate_max_client_compression_level")
|
||
|
mysqlx_document_id_unique_prefix
integer
|
("mysqlx_document_id_unique_prefix") DEPRECATED -- variable should not be settable and will be ignored
|
||
|
mysqlx_enable_hello_notice
boolean
|
|
("mysqlx_enable_hello_notice") DEPRECATED -- variable should not be settable and will be ignored
|
|
|
mysqlx_idle_worker_thread_timeout
integer
|
("mysqlx_idle_worker_thread_timeout") DEPRECATED -- variable should not be settable and will be ignored
|
||
|
mysqlx_interactive_timeout
integer
|
The number of seconds to wait for interactive clients to timeout.
mysqlxInteractiveTimeout corresponds to the MySQL X Plugin system variable. mysqlx_interactive_timeout
|
||
|
mysqlx_lz4_default_compression_level
integer
|
Set the default compression level for the lz4 algorithm. ("mysqlx_lz4_default_compression_level")
|
||
|
mysqlx_lz4_max_client_compression_level
integer
|
Limit the upper bound of accepted compression levels for the lz4 algorithm. ("mysqlx_lz4_max_client_compression_level")
|
||
|
mysqlx_max_allowed_packet
integer
|
The maximum size of network packets that can be received by X Plugin.
This is the mysql variable "mysqlx_max_allowed_packet".
|
||
|
mysqlx_min_worker_threads
integer
|
("mysqlx_min_worker_threads") DEPRECATED -- variable should not be settable and will be ignored
|
||
|
mysqlx_read_timeout
integer
|
The number of seconds that X Plugin waits for blocking read operations to complete. After this time, if the read operation is not successful, X Plugin closes the connection and returns a warning notice with the error code ER_IO_READ_ERROR to the client application.
mysqlxReadTimeout corresponds to the MySQL X Plugin system variable mysqlx_read_timeout
|
||
|
mysqlx_wait_timeout
integer
|
The number of seconds that X Plugin waits for activity on a connection.
mysqlxWaitTimeout corresponds to the MySQL X Plugin system variable. mysqlx_wait_timeout
|
||
|
mysqlx_write_timeout
integer
|
The number of seconds that X Plugin waits for blocking write operations to complete. After this time, if the write operation is not successful, X Plugin closes the connection.
mysqlxReadmysqlxWriteTimeoutTimeout corresponds to the MySQL X Plugin system variable mysqlx_write_timeout
|
||
|
mysqlx_zstd_default_compression_level
integer
|
Set the default compression level for the zstd algorithm. ("mysqlx_zstd_default_compression_level")
|
||
|
mysqlx_zstd_max_client_compression_level
integer
|
Limit the upper bound of accepted compression levels for the zstd algorithm. ("mysqlx_zstd_max_client_compression_level")
|
||
|
net_read_timeout
integer
|
The number of seconds to wait for more data from a connection before aborting the read.
netReadTimeout corresponds to the MySQL system variable net_read_timeout
|
||
|
net_write_timeout
integer
|
The number of seconds to wait for a block to be written to a connection before aborting the write.
netWriteTimeout corresponds to the MySQL system variable net_write_timeout
|
||
|
parser_max_mem_size
integer
|
("parser_max_mem_size")
|
||
|
query_alloc_block_size
integer
|
("query_alloc_block_size") DEPRECATED -- variable should not be settable and will be ignored
|
||
|
query_prealloc_size
integer
|
("query_prealloc_size") DEPRECATED -- variable should not be settable and will be ignored
|
||
|
regexp_time_limit
integer
|
regexpTimeLimit corresponds to the MySQL system variable regexp_time_limit]
|
||
|
sort_buffer_size
integer
|
Each session that must perform a sort allocates a buffer of this size.
sortBufferSize corresponds to the MySQL system variable sort_buffer_size
|
||
|
sql_mode
string
|
("sql_mode")
|
||
|
sql_require_primary_key
boolean
|
|
("sql_require_primary_key")
|
|
|
sql_warnings
boolean
|
|
("sql_warnings")
|
|
|
thread_pool_dedicated_listeners
boolean
|
|
Controls whether the thread pool uses dedicated listener threads. If enabled, a listener thread in each thread group is dedicated to the task of listening for network events from clients, ensuring that the maximum number of query worker threads is no more than the value specified by threadPoolMaxTransactionsLimit. threadPoolDedicatedListeners corresponds to the MySQL Database Service-specific system variable thread_pool_dedicated_listeners.
|
|
|
thread_pool_max_transactions_limit
integer
|
Limits the maximum number of open transactions to the defined value. The default value is 0, which enforces no limit. threadPoolMaxTransactionsLimit corresponds to the MySQL Database Service-specific system variable thread_pool_max_transactions_limit.
|
||
|
time_zone
string
|
Initializes the time zone for each client that connects.
This corresponds to the MySQL System Variable "time_zone".
The values can be given in one of the following formats, none of which are case-sensitive:
- As a string indicating an offset from UTC of the form [H]H:MM, prefixed with a + or -, such as '+10:00', '-6:00', or '+05:30'. The permitted range is '-13:59' to '+14:00', inclusive. - As a named time zone, as defined by the "IANA Time Zone database", such as 'Europe/Helsinki', 'US/Eastern', 'MET', or 'UTC'.
|
||
|
tmp_table_size
integer
|
The maximum size of internal in-memory temporary tables. This variable does not apply to user-created MEMORY tables.
tmp_table_size corresponds to the MySQL system variable tmp_table_size
|
||
|
transaction_isolation
string
|
|
("transaction_isolation")
|
|
|
wait_timeout
integer
|
The number of seconds the server waits for activity on a noninteractive connection before closing it.
waitTimeout corresponds to the MySQL system variable. wait_timeout
|
||
|
wait
boolean
|
|
Whether to wait for create or delete operation to complete.
|
|
|
wait_timeout
integer
|
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.
|
||
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Create configuration
oci_mysql_configuration:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
shape_name: shape_name_example
# optional
init_variables:
# optional
lower_case_table_names: CASE_SENSITIVE
variables:
# optional
completion_type: NO_CHAIN
big_tables: true
connection_memory_chunk_size: 56
connection_memory_limit: 56
default_authentication_plugin: mysql_native_password
global_connection_memory_limit: 56
global_connection_memory_tracking: true
transaction_isolation: READ-UNCOMMITTED
innodb_ft_server_stopword_table: innodb_ft_server_stopword_table_example
mandatory_roles: mandatory_roles_example
autocommit: true
foreign_key_checks: true
group_replication_consistency: EVENTUAL
innodb_ft_enable_stopword: true
innodb_log_writer_threads: true
local_infile: true
mysql_firewall_mode: true
mysqlx_enable_hello_notice: true
sql_require_primary_key: true
sql_warnings: true
binlog_expire_logs_seconds: 56
binlog_row_metadata: FULL
binlog_row_value_options: binlog_row_value_options_example
binlog_transaction_compression: true
innodb_buffer_pool_size: 56
innodb_ft_result_cache_limit: 56
max_binlog_cache_size: 56
max_connect_errors: 56
max_heap_table_size: 56
max_connections: 56
max_prepared_stmt_count: 56
connect_timeout: 56
cte_max_recursion_depth: 56
generated_random_password_length: 56
information_schema_stats_expiry: 56
innodb_buffer_pool_dump_pct: 56
innodb_buffer_pool_instances: 56
innodb_ddl_buffer_size: 56
innodb_ddl_threads: 56
innodb_ft_max_token_size: 56
innodb_ft_min_token_size: 56
innodb_ft_num_word_optimize: 56
innodb_lock_wait_timeout: 56
innodb_max_purge_lag: 56
innodb_max_purge_lag_delay: 56
interactive_timeout: 56
innodb_stats_persistent_sample_pages: 56
innodb_stats_transient_sample_pages: 56
max_allowed_packet: 56
max_execution_time: 56
mysqlx_connect_timeout: 56
mysqlx_document_id_unique_prefix: 56
mysqlx_idle_worker_thread_timeout: 56
mysqlx_interactive_timeout: 56
mysqlx_max_allowed_packet: 56
mysqlx_min_worker_threads: 56
mysqlx_read_timeout: 56
mysqlx_wait_timeout: 56
mysqlx_write_timeout: 56
net_read_timeout: 56
net_write_timeout: 56
parser_max_mem_size: 56
query_alloc_block_size: 56
query_prealloc_size: 56
regexp_time_limit: 56
sql_mode: sql_mode_example
tmp_table_size: 56
mysqlx_deflate_default_compression_level: 56
mysqlx_deflate_max_client_compression_level: 56
mysqlx_lz4_max_client_compression_level: 56
mysqlx_lz4_default_compression_level: 56
mysqlx_zstd_max_client_compression_level: 56
mysqlx_zstd_default_compression_level: 56
mysql_zstd_default_compression_level: 56
sort_buffer_size: 56
wait_timeout: 56
thread_pool_dedicated_listeners: true
thread_pool_max_transactions_limit: 56
time_zone: time_zone_example
parent_configuration_id: "ocid1.parentconfiguration.oc1..xxxxxxEXAMPLExxxxxx"
description: description_example
display_name: display_name_example
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update configuration
oci_mysql_configuration:
# required
configuration_id: "ocid1.configuration.oc1..xxxxxxEXAMPLExxxxxx"
# optional
description: description_example
display_name: display_name_example
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update configuration using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_mysql_configuration:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
# optional
description: description_example
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Delete configuration
oci_mysql_configuration:
# required
configuration_id: "ocid1.configuration.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete configuration using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_mysql_configuration:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | ||
|---|---|---|---|---|
|
configuration
complex
|
on success |
Details of the Configuration resource acted upon by the current operation
Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'init_variables': {'lower_case_table_names': 'CASE_SENSITIVE'}, 'lifecycle_state': 'ACTIVE', 'parent_configuration_id': 'ocid1.parentconfiguration.oc1..xxxxxxEXAMPLExxxxxx', 'shape_name': 'shape_name_example', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'type': 'DEFAULT', 'variables': {'autocommit': True, 'big_tables': True, 'binlog_expire_logs_seconds': 56, 'binlog_row_metadata': 'FULL', 'binlog_row_value_options': 'binlog_row_value_options_example', 'binlog_transaction_compression': True, 'completion_type': 'NO_CHAIN', 'connect_timeout': 56, 'connection_memory_chunk_size': 56, 'connection_memory_limit': 56, 'cte_max_recursion_depth': 56, 'default_authentication_plugin': 'mysql_native_password', 'foreign_key_checks': True, 'generated_random_password_length': 56, 'global_connection_memory_limit': 56, 'global_connection_memory_tracking': True, 'group_replication_consistency': 'EVENTUAL', 'information_schema_stats_expiry': 56, 'innodb_buffer_pool_dump_pct': 56, 'innodb_buffer_pool_instances': 56, 'innodb_buffer_pool_size': 56, 'innodb_ddl_buffer_size': 56, 'innodb_ddl_threads': 56, 'innodb_ft_enable_stopword': True, 'innodb_ft_max_token_size': 56, 'innodb_ft_min_token_size': 56, 'innodb_ft_num_word_optimize': 56, 'innodb_ft_result_cache_limit': 56, 'innodb_ft_server_stopword_table': 'innodb_ft_server_stopword_table_example', 'innodb_lock_wait_timeout': 56, 'innodb_log_writer_threads': True, 'innodb_max_purge_lag': 56, 'innodb_max_purge_lag_delay': 56, 'innodb_stats_persistent_sample_pages': 56, 'innodb_stats_transient_sample_pages': 56, 'interactive_timeout': 56, 'local_infile': True, 'mandatory_roles': 'mandatory_roles_example', 'max_allowed_packet': 56, 'max_binlog_cache_size': 56, 'max_connect_errors': 56, 'max_connections': 56, 'max_execution_time': 56, 'max_heap_table_size': 56, 'max_prepared_stmt_count': 56, 'mysql_firewall_mode': True, 'mysql_zstd_default_compression_level': 56, 'mysqlx_connect_timeout': 56, 'mysqlx_deflate_default_compression_level': 56, 'mysqlx_deflate_max_client_compression_level': 56, 'mysqlx_document_id_unique_prefix': 56, 'mysqlx_enable_hello_notice': True, 'mysqlx_idle_worker_thread_timeout': 56, 'mysqlx_interactive_timeout': 56, 'mysqlx_lz4_default_compression_level': 56, 'mysqlx_lz4_max_client_compression_level': 56, 'mysqlx_max_allowed_packet': 56, 'mysqlx_min_worker_threads': 56, 'mysqlx_read_timeout': 56, 'mysqlx_wait_timeout': 56, 'mysqlx_write_timeout': 56, 'mysqlx_zstd_default_compression_level': 56, 'mysqlx_zstd_max_client_compression_level': 56, 'net_read_timeout': 56, 'net_write_timeout': 56, 'parser_max_mem_size': 56, 'query_alloc_block_size': 56, 'query_prealloc_size': 56, 'regexp_time_limit': 56, 'sort_buffer_size': 56, 'sql_mode': 'sql_mode_example', 'sql_require_primary_key': True, 'sql_warnings': True, 'thread_pool_dedicated_listeners': True, 'thread_pool_max_transactions_limit': 56, 'time_zone': 'time_zone_example', 'tmp_table_size': 56, 'transaction_isolation': 'READ-UNCOMMITTED', 'wait_timeout': 56}}
|
||
|
compartment_id
string
|
on success |
OCID of the Compartment the Configuration exists in.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||
|
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
||
|
description
string
|
on success |
User-provided data about the Configuration.
Sample:
description_example
|
||
|
display_name
string
|
on success |
The display name of the Configuration.
Sample:
display_name_example
|
||
|
freeform_tags
dictionary
|
on success |
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
Sample:
{'Department': 'Finance'}
|
||
|
id
string
|
on success |
The OCID of the Configuration.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
|
init_variables
complex
|
on success |
|
||
|
lower_case_table_names
string
|
on success |
Represents the MySQL server system variable lower_case_table_names (https://dev.mysql.com/doc/refman/8.0/en/server-system- variables.html#sysvar_lower_case_table_names).
lowerCaseTableNames controls case-sensitivity of tables and schema names and how they are stored in the DB System.
Valid values are: - CASE_SENSITIVE - (default) Table and schema name comparisons are case-sensitive and stored as specified. (lower_case_table_names=0) - CASE_INSENSITIVE_LOWERCASE - Table and schema name comparisons are not case-sensitive and stored in lowercase. (lower_case_table_names=1)
Sample:
CASE_SENSITIVE
|
||
|
lifecycle_state
string
|
on success |
The current state of the Configuration.
Sample:
ACTIVE
|
||
|
parent_configuration_id
string
|
on success |
The OCID of the Configuration from which this Configuration is "derived". This is entirely a metadata relationship. There is no relation between the values in this Configuration and its parent.
Sample:
ocid1.parentconfiguration.oc1..xxxxxxEXAMPLExxxxxx
|
||
|
shape_name
string
|
on success |
The name of the associated Shape.
Sample:
shape_name_example
|
||
|
time_created
string
|
on success |
The date and time the Configuration was created, as described by RFC 3339.
Sample:
2013-10-20T19:20:30+01:00
|
||
|
time_updated
string
|
on success |
The date and time the Configuration was last updated, as described by RFC 3339.
Sample:
2013-10-20T19:20:30+01:00
|
||
|
type
string
|
on success |
The Configuration type, DEFAULT or CUSTOM.
Sample:
DEFAULT
|
||
|
variables
complex
|
on success |
|
||
|
autocommit
boolean
|
on success |
("autocommit")
Sample:
True
|
||
|
big_tables
boolean
|
on success |
If enabled, the server stores all temporary tables on disk rather than in memory.
bigTables corresponds to the MySQL server variable big_tables.
Sample:
True
|
||
|
binlog_expire_logs_seconds
integer
|
on success |
Sets the binary log expiration period in seconds. binlogExpireLogsSeconds corresponds to the MySQL binary logging system variable binlog_expire_logs_seconds.
Sample:
56
|
||
|
binlog_row_metadata
string
|
on success |
Configures the amount of table metadata added to the binary log when using row-based logging. binlogRowMetadata corresponds to the MySQL binary logging system variable binlog_row_metadata.
Sample:
FULL
|
||
|
binlog_row_value_options
string
|
on success |
When set to PARTIAL_JSON, this enables use of a space-efficient binary log format for updates that modify only a small portion of a JSON document. binlogRowValueOptions corresponds to the MySQL binary logging system variable binlog_row_value_options.
Sample:
binlog_row_value_options_example
|
||
|
binlog_transaction_compression
boolean
|
on success |
Enables compression for transactions that are written to binary log files on this server. binlogTransactionCompression corresponds to the MySQL binary logging system variable binlog_transaction_compression.
Sample:
True
|
||
|
completion_type
string
|
on success |
("completion_type")
Sample:
NO_CHAIN
|
||
|
connect_timeout
integer
|
on success |
The number of seconds that the mysqld server waits for a connect packet before responding with Bad handshake.
connectTimeout corresponds to the MySQL system variable connect_timeout
Increasing the connect_timeout value might help if clients frequently encounter errors of the form "Lost connection to MySQL server at 'XXX', system error: errno".
Sample:
56
|
||
|
connection_memory_chunk_size
integer
|
on success |
Set the chunking size for updates to the global memory usage counter Global_connection_memory.
connectionMemoryChunkSize corresponds to the MySQL system variable connection_memory_chunk_size.
Sample:
56
|
||
|
connection_memory_limit
integer
|
on success |
Set the maximum amount of memory that can be used by a single user connection.
connectionMemoryLimit corresponds to the MySQL system variable connection_memory_limit.
Sample:
56
|
||
|
cte_max_recursion_depth
integer
|
on success |
("cte_max_recursion_depth")
Sample:
56
|
||
|
default_authentication_plugin
string
|
on success |
("default_authentication_plugin")
Sample:
mysql_native_password
|
||
|
foreign_key_checks
boolean
|
on success |
("foreign_key_checks")
Sample:
True
|
||
|
generated_random_password_length
integer
|
on success |
("generated_random_password_length") DEPRECATED -- variable should not be settable and will be ignored
Sample:
56
|
||
|
global_connection_memory_limit
integer
|
on success |
Set the total amount of memory that can be used by all user connections.
globalConnectionMemoryLimit corresponds to the MySQL system variable global_connection_memory_limit.
Sample:
56
|
||
|
global_connection_memory_tracking
boolean
|
on success |
Determines whether the MySQL server calculates Global_connection_memory.
globalConnectionMemoryTracking corresponds to the MySQL system variable global_connection_memory_tracking.
Sample:
True
|
||
|
group_replication_consistency
string
|
on success |
- EVENTUAL: Both RO and RW transactions do not wait for preceding transactions to be applied before executing. A RW transaction does not wait for other members to apply a transaction. This means that a transaction could be externalized on one member before the others. This also means that in the event of a primary failover, the new primary can accept new RO and RW transactions before the previous primary transactions are all applied. RO transactions could result in outdated values, RW transactions could result in a rollback due to conflicts. - BEFORE_ON_PRIMARY_FAILOVER: New RO or RW transactions with a newly elected primary that is applying backlog from the old primary are held (not applied) until any backlog has been applied. This ensures that when a primary failover happens, intentionally or not, clients always see the latest value on the primary. This guarantees consistency, but means that clients must be able to handle the delay in the event that a backlog is being applied. Usually this delay should be minimal, but does depend on the size of the backlog. - BEFORE: A RW transaction waits for all preceding transactions to complete before being applied. A RO transaction waits for all preceding transactions to complete before being executed. This ensures that this transaction reads the latest value by only affecting the latency of the transaction. This reduces the overhead of synchronization on every RW transaction, by ensuring synchronization is used only on RO transactions. This consistency level also includes the consistency guarantees provided by BEFORE_ON_PRIMARY_FAILOVER. - AFTER: A RW transaction waits until its changes have been applied to all of the other members. This value has no effect on RO transactions. This mode ensures that when a transaction is committed on the local member, any subsequent transaction reads the written value or a more recent value on any group member. Use this mode with a group that is used for predominantly RO operations to ensure that applied RW transactions are applied everywhere once they commit. This could be used by your application to ensure that subsequent reads fetch the latest data which includes the latest writes. This reduces the overhead of synchronization on every RO transaction, by ensuring synchronization is used only on RW transactions. This consistency level also includes the consistency guarantees provided by BEFORE_ON_PRIMARY_FAILOVER. - BEFORE_AND_AFTER: A RW transaction waits for 1) all preceding transactions to complete before being applied and 2) until its changes have been applied on other members. A RO transaction waits for all preceding transactions to complete before execution takes place. This consistency level also includes the consistency guarantees provided by BEFORE_ON_PRIMARY_FAILOVER.
Sample:
EVENTUAL
|
||
|
information_schema_stats_expiry
integer
|
on success |
("information_schema_stats_expiry")
Sample:
56
|
||
|
innodb_buffer_pool_dump_pct
integer
|
on success |
Specifies the percentage of the most recently used pages for each buffer pool to read out and dump.
innodbBufferPoolDumpPct corresponds to the MySQL InnoDB system variable innodb_buffer_pool_dump_pct.
The range is 1 to 100. The default value is 25.
For example, if there are 4 buffer pools with 100 pages each, and innodb_buffer_pool_dump_pct is set to 25, the 25 most recently used pages from each buffer pool are dumped.
Sample:
56
|
||
|
innodb_buffer_pool_instances
integer
|
on success |
("innodb_buffer_pool_instances")
Sample:
56
|
||
|
innodb_buffer_pool_size
integer
|
on success |
The size (in bytes) of the buffer pool, that is, the memory area where InnoDB caches table and index data.
innodbBufferPoolSize corresponds to the MySQL server system variable innodb_buffer_pool_size.
The default and maximum values depend on the amount of RAM provisioned by the shape. See Default User Variables.
Sample:
56
|
||
|
innodb_ddl_buffer_size
integer
|
on success |
innodbDdlBufferSize corresponds to the MySQL system variable innodb_ddl_buffer_size]
Sample:
56
|
||
|
innodb_ddl_threads
integer
|
on success |
innodbDdlThreads corresponds to the MySQL system variable innodb_ddl_threads]
Sample:
56
|
||
|
innodb_ft_enable_stopword
boolean
|
on success |
("innodb_ft_enable_stopword")
Sample:
True
|
||
|
innodb_ft_max_token_size
integer
|
on success |
("innodb_ft_max_token_size")
Sample:
56
|
||
|
innodb_ft_min_token_size
integer
|
on success |
("innodb_ft_min_token_size")
Sample:
56
|
||
|
innodb_ft_num_word_optimize
integer
|
on success |
("innodb_ft_num_word_optimize")
Sample:
56
|
||
|
innodb_ft_result_cache_limit
integer
|
on success |
("innodb_ft_result_cache_limit")
Sample:
56
|
||
|
innodb_ft_server_stopword_table
string
|
on success |
("innodb_ft_server_stopword_table")
Sample:
innodb_ft_server_stopword_table_example
|
||
|
innodb_lock_wait_timeout
integer
|
on success |
("innodb_lock_wait_timeout")
Sample:
56
|
||
|
innodb_log_writer_threads
boolean
|
on success |
Enables dedicated log writer threads for writing redo log records from the log buffer to the system buffers and flushing the system buffers to the redo log files.
This is the MySQL variable "innodb_log_writer_threads". For more information, please see the MySQL documentation
Sample:
True
|
||
|
innodb_max_purge_lag
integer
|
on success |
The desired maximum purge lag in terms of transactions.
InnoDB maintains a list of transactions that have index records delete-marked by UPDATE or DELETE operations. The length of the list is the purge lag.
If this value is exceeded, a delay is imposed on INSERT, UPDATE, and DELETE operations to allow time for purge to catch up.
The default value is 0, which means there is no maximum purge lag and no delay.
innodbMaxPurgeLag corresponds to the MySQL server system variable innodb_max_purge_lag.
Sample:
56
|
||
|
innodb_max_purge_lag_delay
integer
|
on success |
The maximum delay in microseconds for the delay imposed when the innodb_max_purge_lag threshold is exceeded.
The specified innodb_max_purge_lag_delay value is an upper limit on the delay period.
innodbMaxPurgeLagDelay corresponds to the MySQL server system variable innodb_max_purge_lag_delay.
Sample:
56
|
||
|
innodb_stats_persistent_sample_pages
integer
|
on success |
The number of index pages to sample when estimating cardinality and other statistics for an indexed column, such as those calculated by ANALYZE TABLE.
innodbStatsPersistentSamplePages corresponds to the MySQL InnoDB system variable innodb_stats_persistent_sample_pages
innodb_stats_persistent_sample_pages only applies when innodb_stats_persistent is enabled for a table; when innodb_stats_persistent is disabled, innodb_stats_transient_sample_pages applies instead.
Sample:
56
|
||
|
innodb_stats_transient_sample_pages
integer
|
on success |
The number of index pages to sample when estimating cardinality and other statistics for an indexed column, such as those calculated by ANALYZE TABLE.
innodbStatsTransientSamplePages corresponds to the MySQL InnoDB system variable innodb_stats_transient_sample_pages
innodb_stats_transient_sample_pages only applies when innodb_stats_persistent is disabled for a table; when innodb_stats_persistent is enabled, innodb_stats_persistent_sample_pages applies instead.
innodb_stats_persistent is ON by default and cannot be changed. It is possible to override it using the STATS_PERSISTENT clause of the CREATE TABLE and ALTER TABLE statements.
Sample:
56
|
||
|
interactive_timeout
integer
|
on success |
The number of seconds the server waits for activity on an interactive connection before closing it.
interactiveTimeout corresponds to the MySQL system variable. interactive_timeout
Sample:
56
|
||
|
local_infile
boolean
|
on success |
("local_infile")
Sample:
True
|
||
|
mandatory_roles
string
|
on success |
("mandatory_roles")
Sample:
mandatory_roles_example
|
||
|
max_allowed_packet
integer
|
on success |
The maximum size of one packet or any generated/intermediate string.
This is the mysql variable "max_allowed_packet".
Sample:
56
|
||
|
max_binlog_cache_size
integer
|
on success |
Sets the size of the transaction cache.
maxBinlogCacheSize corresponds to the MySQL server system variable max_binlog_cache_size.
Sample:
56
|
||
|
max_connect_errors
integer
|
on success |
("max_connect_errors")
Sample:
56
|
||
|
max_connections
integer
|
on success |
("max_connections")
Sample:
56
|
||
|
max_execution_time
integer
|
on success |
("max_execution_time")
Sample:
56
|
||
|
max_heap_table_size
integer
|
on success |
This variable sets the maximum size to which user-created MEMORY tables are permitted to grow.
maxHeapTableSize corresponds to the MySQL system variable max_heap_table_size
Sample:
56
|
||
|
max_prepared_stmt_count
integer
|
on success |
("max_prepared_stmt_count")
Sample:
56
|
||
|
mysql_firewall_mode
boolean
|
on success |
("mysql_firewall_mode")
Sample:
True
|
||
|
mysql_zstd_default_compression_level
integer
|
on success |
DEPRECATED -- typo of mysqlx_zstd_default_compression_level. variable will be ignored.
Sample:
56
|
||
|
mysqlx_connect_timeout
integer
|
on success |
The number of seconds X Plugin waits for the first packet to be received from newly connected clients.
mysqlxConnectTimeout corresponds to the MySQL X Plugin system variable mysqlx_connect_timeout
Sample:
56
|
||
|
mysqlx_deflate_default_compression_level
integer
|
on success |
Set the default compression level for the deflate algorithm. ("mysqlx_deflate_default_compression_level")
Sample:
56
|
||
|
mysqlx_deflate_max_client_compression_level
integer
|
on success |
Limit the upper bound of accepted compression levels for the deflate algorithm. ("mysqlx_deflate_max_client_compression_level")
Sample:
56
|
||
|
mysqlx_document_id_unique_prefix
integer
|
on success |
("mysqlx_document_id_unique_prefix") DEPRECATED -- variable should not be settable and will be ignored
Sample:
56
|
||
|
mysqlx_enable_hello_notice
boolean
|
on success |
("mysqlx_enable_hello_notice") DEPRECATED -- variable should not be settable and will be ignored
Sample:
True
|
||
|
mysqlx_idle_worker_thread_timeout
integer
|
on success |
("mysqlx_idle_worker_thread_timeout") DEPRECATED -- variable should not be settable and will be ignored
Sample:
56
|
||
|
mysqlx_interactive_timeout
integer
|
on success |
The number of seconds to wait for interactive clients to timeout.
mysqlxInteractiveTimeout corresponds to the MySQL X Plugin system variable. mysqlx_interactive_timeout
Sample:
56
|
||
|
mysqlx_lz4_default_compression_level
integer
|
on success |
Set the default compression level for the lz4 algorithm. ("mysqlx_lz4_default_compression_level")
Sample:
56
|
||
|
mysqlx_lz4_max_client_compression_level
integer
|
on success |
Limit the upper bound of accepted compression levels for the lz4 algorithm. ("mysqlx_lz4_max_client_compression_level")
Sample:
56
|
||
|
mysqlx_max_allowed_packet
integer
|
on success |
The maximum size of network packets that can be received by X Plugin.
This is the mysql variable "mysqlx_max_allowed_packet".
Sample:
56
|
||
|
mysqlx_min_worker_threads
integer
|
on success |
("mysqlx_min_worker_threads") DEPRECATED -- variable should not be settable and will be ignored
Sample:
56
|
||
|
mysqlx_read_timeout
integer
|
on success |
The number of seconds that X Plugin waits for blocking read operations to complete. After this time, if the read operation is not successful, X Plugin closes the connection and returns a warning notice with the error code ER_IO_READ_ERROR to the client application.
mysqlxReadTimeout corresponds to the MySQL X Plugin system variable mysqlx_read_timeout
Sample:
56
|
||
|
mysqlx_wait_timeout
integer
|
on success |
The number of seconds that X Plugin waits for activity on a connection.
mysqlxWaitTimeout corresponds to the MySQL X Plugin system variable. mysqlx_wait_timeout
Sample:
56
|
||
|
mysqlx_write_timeout
integer
|
on success |
The number of seconds that X Plugin waits for blocking write operations to complete. After this time, if the write operation is not successful, X Plugin closes the connection.
mysqlxReadmysqlxWriteTimeoutTimeout corresponds to the MySQL X Plugin system variable mysqlx_write_timeout
Sample:
56
|
||
|
mysqlx_zstd_default_compression_level
integer
|
on success |
Set the default compression level for the zstd algorithm. ("mysqlx_zstd_default_compression_level")
Sample:
56
|
||
|
mysqlx_zstd_max_client_compression_level
integer
|
on success |
Limit the upper bound of accepted compression levels for the zstd algorithm. ("mysqlx_zstd_max_client_compression_level")
Sample:
56
|
||
|
net_read_timeout
integer
|
on success |
The number of seconds to wait for more data from a connection before aborting the read.
netReadTimeout corresponds to the MySQL system variable net_read_timeout
Sample:
56
|
||
|
net_write_timeout
integer
|
on success |
The number of seconds to wait for a block to be written to a connection before aborting the write.
netWriteTimeout corresponds to the MySQL system variable net_write_timeout
Sample:
56
|
||
|
parser_max_mem_size
integer
|
on success |
("parser_max_mem_size")
Sample:
56
|
||
|
query_alloc_block_size
integer
|
on success |
("query_alloc_block_size") DEPRECATED -- variable should not be settable and will be ignored
Sample:
56
|
||
|
query_prealloc_size
integer
|
on success |
("query_prealloc_size") DEPRECATED -- variable should not be settable and will be ignored
Sample:
56
|
||
|
regexp_time_limit
integer
|
on success |
regexpTimeLimit corresponds to the MySQL system variable regexp_time_limit]
Sample:
56
|
||
|
sort_buffer_size
integer
|
on success |
Each session that must perform a sort allocates a buffer of this size.
sortBufferSize corresponds to the MySQL system variable sort_buffer_size
Sample:
56
|
||
|
sql_mode
string
|
on success |
("sql_mode")
Sample:
sql_mode_example
|
||
|
sql_require_primary_key
boolean
|
on success |
("sql_require_primary_key")
Sample:
True
|
||
|
sql_warnings
boolean
|
on success |
("sql_warnings")
Sample:
True
|
||
|
thread_pool_dedicated_listeners
boolean
|
on success |
Controls whether the thread pool uses dedicated listener threads. If enabled, a listener thread in each thread group is dedicated to the task of listening for network events from clients, ensuring that the maximum number of query worker threads is no more than the value specified by threadPoolMaxTransactionsLimit. threadPoolDedicatedListeners corresponds to the MySQL Database Service-specific system variable thread_pool_dedicated_listeners.
Sample:
True
|
||
|
thread_pool_max_transactions_limit
integer
|
on success |
Limits the maximum number of open transactions to the defined value. The default value is 0, which enforces no limit. threadPoolMaxTransactionsLimit corresponds to the MySQL Database Service-specific system variable thread_pool_max_transactions_limit.
Sample:
56
|
||
|
time_zone
string
|
on success |
Initializes the time zone for each client that connects.
This corresponds to the MySQL System Variable "time_zone".
The values can be given in one of the following formats, none of which are case-sensitive:
- As a string indicating an offset from UTC of the form [H]H:MM, prefixed with a + or -, such as '+10:00', '-6:00', or '+05:30'. The permitted range is '-13:59' to '+14:00', inclusive. - As a named time zone, as defined by the "IANA Time Zone database", such as 'Europe/Helsinki', 'US/Eastern', 'MET', or 'UTC'.
Sample:
time_zone_example
|
||
|
tmp_table_size
integer
|
on success |
The maximum size of internal in-memory temporary tables. This variable does not apply to user-created MEMORY tables.
tmp_table_size corresponds to the MySQL system variable tmp_table_size
Sample:
56
|
||
|
transaction_isolation
string
|
on success |
("transaction_isolation")
Sample:
READ-UNCOMMITTED
|
||
|
wait_timeout
integer
|
on success |
The number of seconds the server waits for activity on a noninteractive connection before closing it.
waitTimeout corresponds to the MySQL system variable. wait_timeout
Sample:
56
|
||
Authors¶
Oracle (@oracle)