Class ConfigurationVariables

User-defined service variables.

Inheritance
object
ConfigurationVariables
Inherited Members
Namespace: Oci.MysqlService.Models
Assembly: OCI.DotNetSDK.Mysql.dll
Syntax
public class ConfigurationVariables

Properties

AutoIncrementIncrement

Declaration
[JsonProperty(PropertyName = "autoIncrementIncrement")]
public int? AutoIncrementIncrement { get; set; }
Property Value
Type Description
int?

auto_increment_increment and auto_increment_offset are intended for use with circular (source-to-source) replication, and can be used to control the operation of AUTO_INCREMENT columns. Both variables have global and session values, and each can assume an integer value between 1 and 65,535 inclusive.
autoIncrementIncrement corresponds to the MySQL Replication Source Options variable [auto_increment_increment] (https://dev.mysql.com/doc/refman/8.0/en/replication-options-source.html#sysvar_auto_increment_increment).

AutoIncrementOffset

Declaration
[JsonProperty(PropertyName = "autoIncrementOffset")]
public int? AutoIncrementOffset { get; set; }
Property Value
Type Description
int?

This variable has a default value of 1. If it is left with its default value, and Group Replication is started on the server in multi-primary mode, it is changed to the server ID.
autoIncrementOffset corresponds to the MySQL Replication Source Options variable [auto_increment_offset] (https://dev.mysql.com/doc/refman/8.0/en/replication-options-source.html#sysvar_auto_increment_offset).

Autocommit

Declaration
[JsonProperty(PropertyName = "autocommit")]
public bool? Autocommit { get; set; }
Property Value
Type Description
bool?

("autocommit")

BigTables

Declaration
[JsonProperty(PropertyName = "bigTables")]
public bool? BigTables { get; set; }
Property Value
Type Description
bool?

If enabled, the server stores all temporary tables on disk rather than in memory.
bigTables corresponds to the MySQL server variable big_tables.

BinlogExpireLogsSeconds

Declaration
[JsonProperty(PropertyName = "binlogExpireLogsSeconds")]
public int? BinlogExpireLogsSeconds { get; set; }
Property Value
Type Description
int?

Sets the binary log expiration period in seconds. binlogExpireLogsSeconds corresponds to the MySQL binary logging system variable binlog_expire_logs_seconds.

BinlogGroupCommitSyncDelay

Declaration
[JsonProperty(PropertyName = "binlogGroupCommitSyncDelay")]
public int? BinlogGroupCommitSyncDelay { get; set; }
Property Value
Type Description
int?

Controls how many microseconds the binary log commit waits before synchronizing the binary log file to disk. There is no delay by default. Setting this variable to a microsecond delay enables more transactions to be synchronized together to disk at once, reducing the overall time to commit a group of transactions because the larger groups required fewer time units per group.
binlogGroupCommitSyncDelay corresponds to the MySQL Replication system variable binlog_group_commit_sync_delay

BinlogGroupCommitSyncNoDelayCount

Declaration
[JsonProperty(PropertyName = "binlogGroupCommitSyncNoDelayCount")]
public int? BinlogGroupCommitSyncNoDelayCount { get; set; }
Property Value
Type Description
int?

The maximum number of transactions to wait for before aborting the current delay as specified by binlog_group_commit_sync_delay. If binlog_group_commit_sync_delay is set to 0, then this option has no effect.
binlogGroupCommitSyncNoDelayCount corresponds to the MySQL Replication system variable binlog_group_commit_sync_no_delay_count

BinlogRowMetadata

Declaration
[JsonProperty(PropertyName = "binlogRowMetadata")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ConfigurationVariables.BinlogRowMetadataEnum? BinlogRowMetadata { get; set; }
Property Value
Type Description
ConfigurationVariables.BinlogRowMetadataEnum?

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.

BinlogRowValueOptions

Declaration
[JsonProperty(PropertyName = "binlogRowValueOptions")]
public string BinlogRowValueOptions { get; set; }
Property Value
Type Description
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.

BinlogTransactionCompression

Declaration
[JsonProperty(PropertyName = "binlogTransactionCompression")]
public bool? BinlogTransactionCompression { get; set; }
Property Value
Type Description
bool?

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.

BlockEncryptionMode

Declaration
[JsonProperty(PropertyName = "blockEncryptionMode")]
public string BlockEncryptionMode { get; set; }
Property Value
Type Description
string

This variable controls the block encryption mode for block-based algorithms such as AES. It affects encryption for AES_ENCRYPT() and AES_DECRYPT().

block_encryption_mode takes a value in aes-keylen-mode format, where keylen is the key length in bits and mode is the encryption mode. The value is not case-sensitive. Permitted keylen values are 128, 192, and 256. Permitted mode values are ECB, CBC, CFB1, CFB8, CFB128, and OFB.
block_encryption_mode corresponds to the MySQL Server Administration system variable block_encryption_mode

CharacterSetServer

Declaration
[JsonProperty(PropertyName = "characterSetServer")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ConfigurationVariables.CharacterSetServerEnum? CharacterSetServer { get; set; }
Property Value
Type Description
ConfigurationVariables.CharacterSetServerEnum?

The server's default character set. If you set this variable, you should also set collation_server to specify the collation for the character set.
characterSetServer corresponds to the MySQL server variable character_set_server.

CollationServer

Declaration
[JsonProperty(PropertyName = "collationServer")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ConfigurationVariables.CollationServerEnum? CollationServer { get; set; }
Property Value
Type Description
ConfigurationVariables.CollationServerEnum?

The server's default collation.
collationServer corresponds to the MySQL server variable collation_server.

CompletionType

Declaration
[JsonProperty(PropertyName = "completionType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ConfigurationVariables.CompletionTypeEnum? CompletionType { get; set; }
Property Value
Type Description
ConfigurationVariables.CompletionTypeEnum?

("completion_type")

ConnectTimeout

Declaration
[JsonProperty(PropertyName = "connectTimeout")]
public int? ConnectTimeout { get; set; }
Property Value
Type Description
int?

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".

ConnectionMemoryChunkSize

Declaration
[JsonProperty(PropertyName = "connectionMemoryChunkSize")]
public int? ConnectionMemoryChunkSize { get; set; }
Property Value
Type Description
int?

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.

ConnectionMemoryLimit

Declaration
[JsonProperty(PropertyName = "connectionMemoryLimit")]
public long? ConnectionMemoryLimit { get; set; }
Property Value
Type Description
long?

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.

CteMaxRecursionDepth

Declaration
[JsonProperty(PropertyName = "cteMaxRecursionDepth")]
public long? CteMaxRecursionDepth { get; set; }
Property Value
Type Description
long?

("cte_max_recursion_depth")

DefaultAuthenticationPlugin

Declaration
[JsonProperty(PropertyName = "defaultAuthenticationPlugin")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ConfigurationVariables.DefaultAuthenticationPluginEnum? DefaultAuthenticationPlugin { get; set; }
Property Value
Type Description
ConfigurationVariables.DefaultAuthenticationPluginEnum?

The default authentication plugin. This must be a plugin that uses internal credentials storage, so these values are permitted: mysql_native_password, sha256_password, caching_sha2_password.
As of MySQL 8.0.27, which introduces multifactor authentication, default_authentication_plugin is still used, but in conjunction with and at a lower precedence than the authentication_policy system variable. For details, see The Default Authentication Plugin. Because of this diminished role, default_authentication_plugin is deprecated as of MySQL 8.0.27 and subject to removal in a future MySQL version.
defaultAuthenticationPlugin corresponds to the MySQL system variable default_authentication_plugin.

ExplainFormat

Declaration
[JsonProperty(PropertyName = "explainFormat")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ConfigurationVariables.ExplainFormatEnum? ExplainFormat { get; set; }
Property Value
Type Description
ConfigurationVariables.ExplainFormatEnum?

This variable determines the default output format used by EXPLAIN in the absence of a FORMAT option when displaying a query execution plan.
explainFormat corresponds to the MySQL system variable explain_format.

ExplicitDefaultsForTimestamp

Declaration
[JsonProperty(PropertyName = "explicitDefaultsForTimestamp")]
public bool? ExplicitDefaultsForTimestamp { get; set; }
Property Value
Type Description
bool?

This system variable determines whether the server enables certain nonstandard behaviors for default values and NULL-value handling in TIMESTAMP columns. By default, explicit_defaults_for_timestamp is enabled, which disables the nonstandard behaviors. Disabling explicit_defaults_for_timestamp results in a warning.
explicit_defaults_for_timestamp corresponds to the MySQL Server Administration system variable explicit_defaults_for_timestamp

ForeignKeyChecks

Declaration
[JsonProperty(PropertyName = "foreignKeyChecks")]
public bool? ForeignKeyChecks { get; set; }
Property Value
Type Description
bool?

("foreign_key_checks")

GeneratedRandomPasswordLength

Declaration
[JsonProperty(PropertyName = "generatedRandomPasswordLength")]
public int? GeneratedRandomPasswordLength { get; set; }
Property Value
Type Description
int?

("generated_random_password_length") DEPRECATED -- variable should not be settable and will be ignored

GlobalConnectionMemoryLimit

Declaration
[JsonProperty(PropertyName = "globalConnectionMemoryLimit")]
public long? GlobalConnectionMemoryLimit { get; set; }
Property Value
Type Description
long?

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.

GlobalConnectionMemoryTracking

Declaration
[JsonProperty(PropertyName = "globalConnectionMemoryTracking")]
public bool? GlobalConnectionMemoryTracking { get; set; }
Property Value
Type Description
bool?

Determines whether the MySQL server calculates Global_connection_memory.
globalConnectionMemoryTracking corresponds to the MySQL system variable global_connection_memory_tracking.

GroupConcatMaxLen

Declaration
[JsonProperty(PropertyName = "groupConcatMaxLen")]
public long? GroupConcatMaxLen { get; set; }
Property Value
Type Description
long?

Specifies the maximum permitted result length in bytes for the GROUP_CONCAT() function.
This is the MySQL variable "group_concat_max_len". For more information, please see the MySQL documentation

GroupReplicationConsistency

Declaration
[JsonProperty(PropertyName = "groupReplicationConsistency")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ConfigurationVariables.GroupReplicationConsistencyEnum? GroupReplicationConsistency { get; set; }
Property Value
Type Description
ConfigurationVariables.GroupReplicationConsistencyEnum?
  • 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.

InformationSchemaStatsExpiry

Declaration
[JsonProperty(PropertyName = "informationSchemaStatsExpiry")]
public int? InformationSchemaStatsExpiry { get; set; }
Property Value
Type Description
int?

("information_schema_stats_expiry")

InnodbAdaptiveHashIndex

Declaration
[JsonProperty(PropertyName = "innodbAdaptiveHashIndex")]
public bool? InnodbAdaptiveHashIndex { get; set; }
Property Value
Type Description
bool?

Whether the InnoDB adaptive hash index is enabled or disabled. It may be desirable, depending on your workload, to dynamically enable or disable adaptive hash indexing to improve query performance. Because the adaptive hash index may not be useful for all workloads, conduct benchmarks with it both enabled and disabled, using realistic workloads.
innodbAdaptiveHashIndex corresponds to the MySQL InnoDB Startup Options and System Variables [innodb_adaptive_hash_index] (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_adaptive_hash_index).

InnodbAutoincLockMode

Declaration
[JsonProperty(PropertyName = "innodbAutoincLockMode")]
public int? InnodbAutoincLockMode { get; set; }
Property Value
Type Description
int?

The lock mode to use for generating auto-increment values. Permissible values are 0, 1, or 2, for traditional, consecutive, or interleaved, respectively.
innodbAutoincLockMode corresponds to the MySQL InnoDB Startup Options and System Variables [innodb_autoinc_lock_mode] (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_autoinc_lock_mode).

InnodbBufferPoolDumpPct

Declaration
[JsonProperty(PropertyName = "innodbBufferPoolDumpPct")]
public int? InnodbBufferPoolDumpPct { get; set; }
Property Value
Type Description
int?

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.

InnodbBufferPoolInstances

Declaration
[JsonProperty(PropertyName = "innodbBufferPoolInstances")]
public int? InnodbBufferPoolInstances { get; set; }
Property Value
Type Description
int?

("innodb_buffer_pool_instances")

InnodbBufferPoolSize

Declaration
[JsonProperty(PropertyName = "innodbBufferPoolSize")]
public long? InnodbBufferPoolSize { get; set; }
Property Value
Type Description
long?

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.

InnodbChangeBuffering

Declaration
[JsonProperty(PropertyName = "innodbChangeBuffering")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ConfigurationVariables.InnodbChangeBufferingEnum? InnodbChangeBuffering { get; set; }
Property Value
Type Description
ConfigurationVariables.InnodbChangeBufferingEnum?

Whether InnoDB performs change buffering, an optimization that delays write operations to secondary indexes so that the I/O operations can be performed sequentially. Permitted values are described in the following table. Values may also be specified numerically.
innodbChangeBuffering corresponds to the MySQL InnoDB Startup Options and System Variables [innodb_change_buffering] (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_change_buffering).

InnodbDdlBufferSize

Declaration
[JsonProperty(PropertyName = "innodbDdlBufferSize")]
public long? InnodbDdlBufferSize { get; set; }
Property Value
Type Description
long?

innodbDdlBufferSize corresponds to the MySQL system variable [innodb_ddl_buffer_size] (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_ddl_buffer_size)

InnodbDdlThreads

Declaration
[JsonProperty(PropertyName = "innodbDdlThreads")]
public int? InnodbDdlThreads { get; set; }
Property Value
Type Description
int?

innodbDdlThreads corresponds to the MySQL system variable [innodb_ddl_threads] (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_ddl_threads)

InnodbFtEnableStopword

Declaration
[JsonProperty(PropertyName = "innodbFtEnableStopword")]
public bool? InnodbFtEnableStopword { get; set; }
Property Value
Type Description
bool?

("innodb_ft_enable_stopword")

InnodbFtMaxTokenSize

Declaration
[JsonProperty(PropertyName = "innodbFtMaxTokenSize")]
public int? InnodbFtMaxTokenSize { get; set; }
Property Value
Type Description
int?

("innodb_ft_max_token_size")

InnodbFtMinTokenSize

Declaration
[JsonProperty(PropertyName = "innodbFtMinTokenSize")]
public int? InnodbFtMinTokenSize { get; set; }
Property Value
Type Description
int?

("innodb_ft_min_token_size")

InnodbFtNumWordOptimize

Declaration
[JsonProperty(PropertyName = "innodbFtNumWordOptimize")]
public int? InnodbFtNumWordOptimize { get; set; }
Property Value
Type Description
int?

("innodb_ft_num_word_optimize")

InnodbFtResultCacheLimit

Declaration
[JsonProperty(PropertyName = "innodbFtResultCacheLimit")]
public long? InnodbFtResultCacheLimit { get; set; }
Property Value
Type Description
long?

("innodb_ft_result_cache_limit")

InnodbFtServerStopwordTable

Declaration
[JsonProperty(PropertyName = "innodbFtServerStopwordTable")]
public string InnodbFtServerStopwordTable { get; set; }
Property Value
Type Description
string

("innodb_ft_server_stopword_table")

InnodbLockWaitTimeout

Declaration
[JsonProperty(PropertyName = "innodbLockWaitTimeout")]
public int? InnodbLockWaitTimeout { get; set; }
Property Value
Type Description
int?

("innodb_lock_wait_timeout")

InnodbLogWriterThreads

Declaration
[JsonProperty(PropertyName = "innodbLogWriterThreads")]
public bool? InnodbLogWriterThreads { get; set; }
Property Value
Type Description
bool?

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

InnodbMaxPurgeLag

Declaration
[JsonProperty(PropertyName = "innodbMaxPurgeLag")]
public long? InnodbMaxPurgeLag { get; set; }
Property Value
Type Description
long?

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.

InnodbMaxPurgeLagDelay

Declaration
[JsonProperty(PropertyName = "innodbMaxPurgeLagDelay")]
public int? InnodbMaxPurgeLagDelay { get; set; }
Property Value
Type Description
int?

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.

InnodbNumaInterleave

Declaration
[JsonProperty(PropertyName = "innodbNumaInterleave")]
public bool? InnodbNumaInterleave { get; set; }
Property Value
Type Description
bool?

Enables the NUMA interleave memory policy for allocation of the InnoDB buffer pool. When innodb_numa_interleave is enabled, the NUMA memory policy is set to MPOL_INTERLEAVE for the mysqld process. After the InnoDB buffer pool is allocated, the NUMA memory policy is set back to MPOL_DEFAULT. For the innodb_numa_interleave option to be available, MySQL must be compiled on a NUMA-enabled Linux system.
innodbNumaInterleave corresponds to the MySQL InnoDB Startup Options and System Variables [innodb_numa_interleave] (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_numa_interleave).

InnodbOnlineAlterLogMaxSize

Declaration
[JsonProperty(PropertyName = "innodbOnlineAlterLogMaxSize")]
public long? InnodbOnlineAlterLogMaxSize { get; set; }
Property Value
Type Description
long?

Specifies an upper limit in bytes on the size of the temporary log files used during online DDL operations for InnoDB tables. There is one such log file for each index being created or table being altered. This log file stores data inserted, updated, or deleted in the table during the DDL operation.
innodbOnlineAlterLogMaxSize corresponds to the MySQL InnoDB Startup Options and System Variables [innodb_online_alter_log_max_size] (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_online_alter_log_max_size).

InnodbRedoLogCapacity

Declaration
[JsonProperty(PropertyName = "innodbRedoLogCapacity")]
public long? InnodbRedoLogCapacity { get; set; }
Property Value
Type Description
long?

Defines the amount of disk space occupied by redo log files. innodb_redo_log_capacity supercedes the innodb_log_files_in_group and innodb_log_file_size variables, which are both ignored if innodb_redo_log_capacity is defined. If innodb_redo_log_capacity is not defined, and if neither innodb_log_file_size or innodb_log_files_in_group are defined, then the default innodb_redo_log_capacity value is used.
innodbRedoLogCapacity corresponds to the InnoDB Startup Options and System Variables innodb_redo_log_capacity

InnodbRollbackOnTimeout

Declaration
[JsonProperty(PropertyName = "innodbRollbackOnTimeout")]
public bool? InnodbRollbackOnTimeout { get; set; }
Property Value
Type Description
bool?

InnoDB rolls back only the last statement on a transaction timeout by default. If --innodb-rollback-on-timeout is specified, a transaction timeout causes InnoDB to abort and roll back the entire transaction.
innodbRollbackOnTimeout corresponds to the MySQL InnoDB Startup Options and System Variables [innodb_rollback_on_timeout] (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_rollback_on_timeout).

InnodbSortBufferSize

Declaration
[JsonProperty(PropertyName = "innodbSortBufferSize")]
public int? InnodbSortBufferSize { get; set; }
Property Value
Type Description
int?

This variable defines:

  • The sort buffer size for online DDL operations that create or rebuild secondary indexes. However, as of MySQL 8.0.27, this responsibility is subsumed by the innodb_ddl_buffer_size variable.
  • The amount by which the temporary log file is extended when recording concurrent DML during an online DDL operation, and the size of the temporary log file read buffer and write buffer.
    innodbSortBufferSize corresponds to the MySQL InnoDB Startup Options and System Variables [innodb_sort_buffer_size] (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_sort_buffer_size).

InnodbStatsPersistentSamplePages

Declaration
[JsonProperty(PropertyName = "innodbStatsPersistentSamplePages")]
public long? InnodbStatsPersistentSamplePages { get; set; }
Property Value
Type Description
long?

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.

InnodbStatsTransientSamplePages

Declaration
[JsonProperty(PropertyName = "innodbStatsTransientSamplePages")]
public long? InnodbStatsTransientSamplePages { get; set; }
Property Value
Type Description
long?

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.

InnodbStrictMode

Declaration
[JsonProperty(PropertyName = "innodbStrictMode")]
public bool? InnodbStrictMode { get; set; }
Property Value
Type Description
bool?

When you enable innodbStrictMode, the InnoDB storage engine returns errors instead of warnings for invalid or incompatible table options.
innodbStrictMode corresponds to the MySQL InnoDB system variable innodb_strict_mode

InnodbUndoLogTruncate

Declaration
[JsonProperty(PropertyName = "innodbUndoLogTruncate")]
public bool? InnodbUndoLogTruncate { get; set; }
Property Value
Type Description
bool?

When enabled, undo tablespaces that exceed the threshold value defined by innodb_max_undo_log_size are marked for truncation. Only undo tablespaces can be truncated. Truncating undo logs that reside in the system tablespace is not supported. For truncation to occur, there must be at least two undo tablespaces.
innodbUndoLogTruncate corresponds to the MySQL InnoDB Startup Options and System Variables [innodb_undo_log_truncate] (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_undo_log_truncate).

InteractiveTimeout

Declaration
[JsonProperty(PropertyName = "interactiveTimeout")]
public int? InteractiveTimeout { get; set; }
Property Value
Type Description
int?

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

JoinBufferSize

Declaration
[JsonProperty(PropertyName = "joinBufferSize")]
public long? JoinBufferSize { get; set; }
Property Value
Type Description
long?

The minimum size of the buffer that is used for plain index scans, range index scans, and joins that do not use indexes and thus perform full table scans. In MySQL 8.0.18 and later, this variable also controls the amount of memory used for hash joins. Normally, the best way to get fast joins is to add indexes. Increase the value of join_buffer_size to get a faster full join when adding indexes is not possible. One join buffer is allocated for each full join between two tables. For a complex join between several tables for which indexes are not used, multiple join buffers might be necessary.
joinBufferSize corresponds to the MySQL Server System variable [join_buffer_size] (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_join_buffer_size).

LocalInfile

Declaration
[JsonProperty(PropertyName = "localInfile")]
public bool? LocalInfile { get; set; }
Property Value
Type Description
bool?

This variable controls server-side LOCAL capability for LOAD DATA statements. Depending on the local_infile setting, the server refuses or permits local data loading by clients that have LOCAL enabled on the client side.
local_infile corresponds to the MySQL Server system variable local_infile

LongQueryTime

Declaration
[JsonProperty(PropertyName = "longQueryTime")]
public int? LongQueryTime { get; set; }
Property Value
Type Description
int?

If a query takes longer than this many seconds, the server increments the Slow_queries status variable. If the slow query log is enabled, the query is logged to the slow query log file. This value is measured in real time, not CPU time, so a query that is under the threshold on a lightly loaded system might be above the threshold on a heavily loaded one.
longQueryTime corresponds to the MySQL Server System variable [long_query_time] (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_long_query_time).

MandatoryRoles

Declaration
[JsonProperty(PropertyName = "mandatoryRoles")]
public string MandatoryRoles { get; set; }
Property Value
Type Description
string

("mandatory_roles")

MaxAllowedPacket

Declaration
[JsonProperty(PropertyName = "maxAllowedPacket")]
public int? MaxAllowedPacket { get; set; }
Property Value
Type Description
int?

The maximum size of one packet or any generated/intermediate string.
This is the mysql variable "max_allowed_packet".

MaxBinlogCacheSize

Declaration
[JsonProperty(PropertyName = "maxBinlogCacheSize")]
public long? MaxBinlogCacheSize { get; set; }
Property Value
Type Description
long?

Sets the size of the transaction cache.
maxBinlogCacheSize corresponds to the MySQL server system variable max_binlog_cache_size.

MaxConnectErrors

Declaration
[JsonProperty(PropertyName = "maxConnectErrors")]
public long? MaxConnectErrors { get; set; }
Property Value
Type Description
long?

("max_connect_errors")

MaxConnections

Declaration
[JsonProperty(PropertyName = "maxConnections")]
public int? MaxConnections { get; set; }
Property Value
Type Description
int?

("max_connections")

MaxExecutionTime

Declaration
[JsonProperty(PropertyName = "maxExecutionTime")]
public long? MaxExecutionTime { get; set; }
Property Value
Type Description
long?

("max_execution_time")

MaxHeapTableSize

Declaration
[JsonProperty(PropertyName = "maxHeapTableSize")]
public long? MaxHeapTableSize { get; set; }
Property Value
Type Description
long?

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

MaxPreparedStmtCount

Declaration
[JsonProperty(PropertyName = "maxPreparedStmtCount")]
public int? MaxPreparedStmtCount { get; set; }
Property Value
Type Description
int?

("max_prepared_stmt_count")

MaxSeeksForKey

Declaration
[JsonProperty(PropertyName = "maxSeeksForKey")]
public long? MaxSeeksForKey { get; set; }
Property Value
Type Description
long?

Limit the assumed maximum number of seeks when looking up rows based on a key. The MySQL optimizer assumes that no more than this number of key seeks are required when searching for matching rows in a table by scanning an index, regardless of the actual cardinality of the index (see Section 15.7.7.22, \u201CSHOW INDEX Statement\u201D). By setting this to a low value (say, 100), you can force MySQL to prefer indexes instead of table scans.
maxSeeksForKey corresponds to the MySQL Server System variable [max_seeks_for_key] (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_max_seeks_for_key).

MaxUserConnections

Declaration
[JsonProperty(PropertyName = "maxUserConnections")]
public long? MaxUserConnections { get; set; }
Property Value
Type Description
long?

The maximum number of simultaneous connections permitted to any given MySQL user account. A value of 0 (the default) means \u201Cno limit.\u201D This variable has a global value that can be set at server startup or runtime. It also has a read-only session value that indicates the effective simultaneous-connection limit that applies to the account associated with the current session.
maxUserConnections corresponds to the MySQL Server System variable [max_user_connections] (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_max_user_connections).

MysqlFirewallMode

Declaration
[JsonProperty(PropertyName = "mysqlFirewallMode")]
public bool? MysqlFirewallMode { get; set; }
Property Value
Type Description
bool?

("mysql_firewall_mode")

MysqlZstdDefaultCompressionLevel

Declaration
[JsonProperty(PropertyName = "mysqlZstdDefaultCompressionLevel")]
public int? MysqlZstdDefaultCompressionLevel { get; set; }
Property Value
Type Description
int?

DEPRECATED -- typo of mysqlx_zstd_default_compression_level. variable will be ignored.

MysqlxConnectTimeout

Declaration
[JsonProperty(PropertyName = "mysqlxConnectTimeout")]
public int? MysqlxConnectTimeout { get; set; }
Property Value
Type Description
int?

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

MysqlxDeflateDefaultCompressionLevel

Declaration
[JsonProperty(PropertyName = "mysqlxDeflateDefaultCompressionLevel")]
public int? MysqlxDeflateDefaultCompressionLevel { get; set; }
Property Value
Type Description
int?

Set the default compression level for the deflate algorithm. ("mysqlx_deflate_default_compression_level")

MysqlxDeflateMaxClientCompressionLevel

Declaration
[JsonProperty(PropertyName = "mysqlxDeflateMaxClientCompressionLevel")]
public int? MysqlxDeflateMaxClientCompressionLevel { get; set; }
Property Value
Type Description
int?

Limit the upper bound of accepted compression levels for the deflate algorithm. ("mysqlx_deflate_max_client_compression_level")

MysqlxDocumentIdUniquePrefix

Declaration
[JsonProperty(PropertyName = "mysqlxDocumentIdUniquePrefix")]
public int? MysqlxDocumentIdUniquePrefix { get; set; }
Property Value
Type Description
int?

("mysqlx_document_id_unique_prefix") DEPRECATED -- variable should not be settable and will be ignored

MysqlxEnableHelloNotice

Declaration
[JsonProperty(PropertyName = "mysqlxEnableHelloNotice")]
public bool? MysqlxEnableHelloNotice { get; set; }
Property Value
Type Description
bool?

("mysqlx_enable_hello_notice") DEPRECATED -- variable should not be settable and will be ignored

MysqlxIdleWorkerThreadTimeout

Declaration
[JsonProperty(PropertyName = "mysqlxIdleWorkerThreadTimeout")]
public int? MysqlxIdleWorkerThreadTimeout { get; set; }
Property Value
Type Description
int?

("mysqlx_idle_worker_thread_timeout") DEPRECATED -- variable should not be settable and will be ignored

MysqlxInteractiveTimeout

Declaration
[JsonProperty(PropertyName = "mysqlxInteractiveTimeout")]
public int? MysqlxInteractiveTimeout { get; set; }
Property Value
Type Description
int?

The number of seconds to wait for interactive clients to timeout.
mysqlxInteractiveTimeout corresponds to the MySQL X Plugin system variable. mysqlx_interactive_timeout

MysqlxLz4DefaultCompressionLevel

Declaration
[JsonProperty(PropertyName = "mysqlxLz4DefaultCompressionLevel")]
public int? MysqlxLz4DefaultCompressionLevel { get; set; }
Property Value
Type Description
int?

Set the default compression level for the lz4 algorithm. ("mysqlx_lz4_default_compression_level")

MysqlxLz4MaxClientCompressionLevel

Declaration
[JsonProperty(PropertyName = "mysqlxLz4MaxClientCompressionLevel")]
public int? MysqlxLz4MaxClientCompressionLevel { get; set; }
Property Value
Type Description
int?

Limit the upper bound of accepted compression levels for the lz4 algorithm. ("mysqlx_lz4_max_client_compression_level")

MysqlxMaxAllowedPacket

Declaration
[JsonProperty(PropertyName = "mysqlxMaxAllowedPacket")]
public int? MysqlxMaxAllowedPacket { get; set; }
Property Value
Type Description
int?

The maximum size of network packets that can be received by X Plugin.
This is the mysql variable "mysqlx_max_allowed_packet".

MysqlxMinWorkerThreads

Declaration
[JsonProperty(PropertyName = "mysqlxMinWorkerThreads")]
public int? MysqlxMinWorkerThreads { get; set; }
Property Value
Type Description
int?

("mysqlx_min_worker_threads") DEPRECATED -- variable should not be settable and will be ignored

MysqlxReadTimeout

Declaration
[JsonProperty(PropertyName = "mysqlxReadTimeout")]
public int? MysqlxReadTimeout { get; set; }
Property Value
Type Description
int?

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

MysqlxWaitTimeout

Declaration
[JsonProperty(PropertyName = "mysqlxWaitTimeout")]
public int? MysqlxWaitTimeout { get; set; }
Property Value
Type Description
int?

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

MysqlxWriteTimeout

Declaration
[JsonProperty(PropertyName = "mysqlxWriteTimeout")]
public int? MysqlxWriteTimeout { get; set; }
Property Value
Type Description
int?

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

MysqlxZstdDefaultCompressionLevel

Declaration
[JsonProperty(PropertyName = "mysqlxZstdDefaultCompressionLevel")]
public int? MysqlxZstdDefaultCompressionLevel { get; set; }
Property Value
Type Description
int?

Set the default compression level for the zstd algorithm. ("mysqlx_zstd_default_compression_level")

MysqlxZstdMaxClientCompressionLevel

Declaration
[JsonProperty(PropertyName = "mysqlxZstdMaxClientCompressionLevel")]
public int? MysqlxZstdMaxClientCompressionLevel { get; set; }
Property Value
Type Description
int?

Limit the upper bound of accepted compression levels for the zstd algorithm. ("mysqlx_zstd_max_client_compression_level")

NetReadTimeout

Declaration
[JsonProperty(PropertyName = "netReadTimeout")]
public int? NetReadTimeout { get; set; }
Property Value
Type Description
int?

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

NetWriteTimeout

Declaration
[JsonProperty(PropertyName = "netWriteTimeout")]
public int? NetWriteTimeout { get; set; }
Property Value
Type Description
int?

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

OptimizerSwitch

Declaration
[JsonProperty(PropertyName = "optimizerSwitch")]
public string OptimizerSwitch { get; set; }
Property Value
Type Description
string

The optimizer_switch system variable enables control over optimizer behavior. The value of this variable is a set of flags, each of which has a value of on or off to indicate whether the corresponding optimizer behavior is enabled or disabled. This variable has global and session values and can be changed at runtime. The global default can be set at server startup.
Setting hypergraph_optimizer=on for cloud builds below 9.0.0 will fail.
optimizerSwitch corresponds to the MySQL Server System variable [optimizer_switch] (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_optimizer_switch).

ParserMaxMemSize

Declaration
[JsonProperty(PropertyName = "parserMaxMemSize")]
public long? ParserMaxMemSize { get; set; }
Property Value
Type Description
long?

("parser_max_mem_size")

QueryAllocBlockSize

Declaration
[JsonProperty(PropertyName = "queryAllocBlockSize")]
public long? QueryAllocBlockSize { get; set; }
Property Value
Type Description
long?

("query_alloc_block_size") DEPRECATED -- variable should not be settable and will be ignored

QueryPreallocSize

Declaration
[JsonProperty(PropertyName = "queryPreallocSize")]
public long? QueryPreallocSize { get; set; }
Property Value
Type Description
long?

("query_prealloc_size") DEPRECATED -- variable should not be settable and will be ignored

RangeOptimizerMaxMemSize

Declaration
[JsonProperty(PropertyName = "rangeOptimizerMaxMemSize")]
public long? RangeOptimizerMaxMemSize { get; set; }
Property Value
Type Description
long?

The limit on memory consumption for the range optimizer. A value of 0 means \u201Cno limit.\u201D If an execution plan considered by the optimizer uses the range access method but the optimizer estimates that the amount of memory needed for this method would exceed the limit, it abandons the plan and considers other plans.
rangeOptimizerMaxMemSize corresponds to the MySQL Server System variable [range_optimizer_max_mem_size] (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_range_optimizer_max_mem_size).

RegexpTimeLimit

Declaration
[JsonProperty(PropertyName = "regexpTimeLimit")]
public int? RegexpTimeLimit { get; set; }
Property Value
Type Description
int?

regexpTimeLimit corresponds to the MySQL system variable [regexp_time_limit] (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_regexp_time_limit)

RelayLogSpaceLimit

Declaration
[JsonProperty(PropertyName = "relayLogSpaceLimit")]
public long? RelayLogSpaceLimit { get; set; }
Property Value
Type Description
long?

The maximum amount of space to use for all relay logs.
relayLogSpaceLimit corresponds to the MySQL Replica Server Options variable [relay_log_space_limit] (https://dev.mysql.com/doc/refman/8.0/en/replication-options-replica.html#sysvar_relay_log_space_limit).

ReplicaNetTimeout

Declaration
[JsonProperty(PropertyName = "replicaNetTimeout")]
public int? ReplicaNetTimeout { get; set; }
Property Value
Type Description
int?

Specifies the number of seconds to wait for more data or a heartbeat signal from the source before the replica considers the connection broken, aborts the read, and tries to reconnect. Setting this variable has no immediate effect. The state of the variable applies on all subsequent START REPLICA commands.
replicaNetTimeout corresponds to the MySQL Replica server system variable replica_net_timeout

ReplicaParallelWorkers

Declaration
[JsonProperty(PropertyName = "replicaParallelWorkers")]
public int? ReplicaParallelWorkers { get; set; }
Property Value
Type Description
int?

Beginning with MySQL 8.0.26, slave_parallel_workers is deprecated, and you should use replica_parallel_workers instead. (Prior to MySQL 8.0.26, you must use slave_parallel_workers to set the number of applier threads.)
replicaParallelWorkers corresponds to the MySQL Replica Server Options variable [replica_parallel_workers] (https://dev.mysql.com/doc/refman/8.0/en/replication-options-replica.html#sysvar_replica_parallel_workers).

ReplicaTypeConversions

Declaration
[JsonProperty(PropertyName = "replicaTypeConversions")]
public string ReplicaTypeConversions { get; set; }
Property Value
Type Description
string

From MySQL 8.0.26, use replica_type_conversions in place of slave_type_conversions, which is deprecated from that release. In releases before MySQL 8.0.26, use slave_type_conversions.
replica_type_conversions controls the type conversion mode in effect on the replica when using row-based replication. Its value is a comma-delimited set of zero or more elements from the list: ALL_LOSSY, ALL_NON_LOSSY, ALL_SIGNED, ALL_UNSIGNED. Set this variable to an empty string to disallow type conversions between the source and the replica. Setting this variable takes effect for all replication channels immediately, including running channels.
replica_type_conversions corresponds to the MySQL Replica Server Options variable [replica_type_conversions] (https://dev.mysql.com/doc/refman/8.0/en/replication-options-replica.html#sysvar_replica_type_conversions).

RequireSecureTransport

Declaration
[JsonProperty(PropertyName = "requireSecureTransport")]
public bool? RequireSecureTransport { get; set; }
Property Value
Type Description
bool?

Whether client connections to the server are required to use some form of secure transport. When this variable is enabled, the server permits only TCP/IP connections encrypted using TLS/SSL, or connections that use a socket file or shared memory. The server rejects nonsecure connection attempts, which fail with an ER_SECURE_TRANSPORT_REQUIRED error.
require_secure_transport corresponds to the MySQL Server Administration system variable require_secure_transport

SkipNameResolve

Declaration
[JsonProperty(PropertyName = "skipNameResolve")]
public bool? SkipNameResolve { get; set; }
Property Value
Type Description
bool?

Whether to resolve host names when checking client connections. If this variable is OFF, mysqld resolves host names when checking client connections. If it is ON, mysqld uses only IP numbers; in this case, all Host column values in the grant tables must be IP addresses. See Section 7.1.12.3, \u201CDNS Lookups and the Host Cache\u201D.
skipNameResolve corresponds to the MySQL Server System variable [skip_name_resolve] (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_skip_name_resolve).

SortBufferSize

Declaration
[JsonProperty(PropertyName = "sortBufferSize")]
public long? SortBufferSize { get; set; }
Property Value
Type Description
long?

Each session that must perform a sort allocates a buffer of this size.
sortBufferSize corresponds to the MySQL system variable sort_buffer_size

SqlGenerateInvisiblePrimaryKey

Declaration
[JsonProperty(PropertyName = "sqlGenerateInvisiblePrimaryKey")]
public bool? SqlGenerateInvisiblePrimaryKey { get; set; }
Property Value
Type Description
bool?

Whether GIPK mode is in effect, in which case a MySQL replication source server adds a generated invisible primary key to any InnoDB table that is created without one.
sqlGenerateInvisiblePrimaryKey corresponds to the MySQL system variable [sql_generate_invisible_primary_key] (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_sql_generate_invisible_primary_key).

SqlMode

Declaration
[JsonProperty(PropertyName = "sqlMode")]
public string SqlMode { get; set; }
Property Value
Type Description
string

("sql_mode")

SqlRequirePrimaryKey

Declaration
[JsonProperty(PropertyName = "sqlRequirePrimaryKey")]
public bool? SqlRequirePrimaryKey { get; set; }
Property Value
Type Description
bool?

("sql_require_primary_key")

SqlWarnings

Declaration
[JsonProperty(PropertyName = "sqlWarnings")]
public bool? SqlWarnings { get; set; }
Property Value
Type Description
bool?

("sql_warnings")

TableDefinitionCache

Declaration
[JsonProperty(PropertyName = "tableDefinitionCache")]
public int? TableDefinitionCache { get; set; }
Property Value
Type Description
int?

The number of table definitions that can be stored in the table definition cache. If you use a large number of tables, you can create a large table definition cache to speed up opening of tables. The table definition cache takes less space and does not use file descriptors, unlike the normal table cache.
table_definition_cache corresponds to the MySQL Server Administration system variable table_definition_cache

TableOpenCache

Declaration
[JsonProperty(PropertyName = "tableOpenCache")]
public int? TableOpenCache { get; set; }
Property Value
Type Description
int?

The number of open tables for all threads. Increasing this value increases the number of file descriptors that mysqld requires.
table_open_cache corresponds to the MySQL Server Administration system variable table_open_cache

TemptableMaxRam

Declaration
[JsonProperty(PropertyName = "temptableMaxRam")]
public long? TemptableMaxRam { get; set; }
Property Value
Type Description
long?

Defines the maximum amount of memory that can be occupied by the TempTable storage engine before it starts storing data on disk. The default value is 1073741824 bytes (1GiB). For more information, see Section 10.4.4, \u201CInternal Temporary Table Use in MySQL\u201D.
temptableMaxRam corresponds to the MySQL system variable [temptable_max_ram] (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_temptable_max_ram).

ThreadPoolDedicatedListeners

Declaration
[JsonProperty(PropertyName = "threadPoolDedicatedListeners")]
public bool? ThreadPoolDedicatedListeners { get; set; }
Property Value
Type Description
bool?

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.

ThreadPoolMaxTransactionsLimit

Declaration
[JsonProperty(PropertyName = "threadPoolMaxTransactionsLimit")]
public int? ThreadPoolMaxTransactionsLimit { get; set; }
Property Value
Type Description
int?

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.

ThreadPoolQueryThreadsPerGroup

Declaration
[JsonProperty(PropertyName = "threadPoolQueryThreadsPerGroup")]
public int? ThreadPoolQueryThreadsPerGroup { get; set; }
Property Value
Type Description
int?

The maximum number of query threads permitted in a thread group. The maximum value is 4096, but if thread_pool_max_transactions_limit is set, thread_pool_query_threads_per_group must not exceed that value. The default value of 1 means there is one active query thread in each thread group, which works well for many loads. When you are using the high concurrency thread pool algorithm (thread_pool_algorithm = 1), consider increasing the value if you experience slower response times due to long-running transactions.
threadPoolQueryThreadsPerGroup corresponds to the MySQL Server system variable thread_pool_query_threads_per_group

ThreadPoolSize

Declaration
[JsonProperty(PropertyName = "threadPoolSize")]
public int? ThreadPoolSize { get; set; }
Property Value
Type Description
int?

The number of thread groups in the thread pool. This is the most important parameter controlling thread pool performance. It affects how many statements can execute simultaneously. If a value outside the range of permissible values is specified, the thread pool plugin does not load and the server writes a message to the error log.
threadPoolSize corresponds to the MySQL Server System variable [thread_pool_size] (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_thread_pool_size).

ThreadPoolTransactionDelay

Declaration
[JsonProperty(PropertyName = "threadPoolTransactionDelay")]
public int? ThreadPoolTransactionDelay { get; set; }
Property Value
Type Description
int?

The delay period before executing a new transaction, in milliseconds. The maximum value is 300000 (5 minutes). A transaction delay can be used in cases where parallel transactions affect the performance of other operations due to resource contention. For example, if parallel transactions affect index creation or an online buffer pool resizing operation, you can configure a transaction delay to reduce resource contention while those operations are running.
threadPoolTransactionDelay corresponds to the MySQL Server system variable thread_pool_transaction_delay

TimeZone

Declaration
[JsonProperty(PropertyName = "timeZone")]
public string TimeZone { get; set; }
Property Value
Type Description
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'.

TmpTableSize

Declaration
[JsonProperty(PropertyName = "tmpTableSize")]
public long? TmpTableSize { get; set; }
Property Value
Type Description
long?

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

TransactionIsolation

Declaration
[JsonProperty(PropertyName = "transactionIsolation")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ConfigurationVariables.TransactionIsolationEnum? TransactionIsolation { get; set; }
Property Value
Type Description
ConfigurationVariables.TransactionIsolationEnum?

("transaction_isolation")

WaitTimeout

Declaration
[JsonProperty(PropertyName = "waitTimeout")]
public int? WaitTimeout { get; set; }
Property Value
Type Description
int?

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