1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Mysql
  5. getMysqlConfigurations
Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi

oci.Mysql.getMysqlConfigurations

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi

This data source provides the list of Mysql Configurations in Oracle Cloud Infrastructure MySQL Database service.

Lists the Configurations available when creating a DB System.

This may include DEFAULT configurations per Shape and CUSTOM configurations.

The default sort order is a multi-part sort by:

  • shapeName, ascending
  • DEFAULT-before-CUSTOM
  • displayName ascending

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testMysqlConfigurations = oci.Mysql.getMysqlConfigurations({
    compartmentId: compartmentId,
    configurationId: mysqlConfigurationId,
    displayName: mysqlConfigurationDisplayName,
    shapeName: mysqlShapeName,
    state: mysqlConfigurationState,
    types: mysqlConfigurationType,
});
Copy
import pulumi
import pulumi_oci as oci

test_mysql_configurations = oci.Mysql.get_mysql_configurations(compartment_id=compartment_id,
    configuration_id=mysql_configuration_id,
    display_name=mysql_configuration_display_name,
    shape_name=mysql_shape_name,
    state=mysql_configuration_state,
    types=mysql_configuration_type)
Copy
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/mysql"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mysql.GetMysqlConfigurations(ctx, &mysql.GetMysqlConfigurationsArgs{
			CompartmentId:   compartmentId,
			ConfigurationId: pulumi.StringRef(mysqlConfigurationId),
			DisplayName:     pulumi.StringRef(mysqlConfigurationDisplayName),
			ShapeName:       pulumi.StringRef(mysqlShapeName),
			State:           pulumi.StringRef(mysqlConfigurationState),
			Types:           mysqlConfigurationType,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testMysqlConfigurations = Oci.Mysql.GetMysqlConfigurations.Invoke(new()
    {
        CompartmentId = compartmentId,
        ConfigurationId = mysqlConfigurationId,
        DisplayName = mysqlConfigurationDisplayName,
        ShapeName = mysqlShapeName,
        State = mysqlConfigurationState,
        Types = mysqlConfigurationType,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Mysql.MysqlFunctions;
import com.pulumi.oci.Mysql.inputs.GetMysqlConfigurationsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testMysqlConfigurations = MysqlFunctions.getMysqlConfigurations(GetMysqlConfigurationsArgs.builder()
            .compartmentId(compartmentId)
            .configurationId(mysqlConfigurationId)
            .displayName(mysqlConfigurationDisplayName)
            .shapeName(mysqlShapeName)
            .state(mysqlConfigurationState)
            .types(mysqlConfigurationType)
            .build());

    }
}
Copy
variables:
  testMysqlConfigurations:
    fn::invoke:
      function: oci:Mysql:getMysqlConfigurations
      arguments:
        compartmentId: ${compartmentId}
        configurationId: ${mysqlConfigurationId}
        displayName: ${mysqlConfigurationDisplayName}
        shapeName: ${mysqlShapeName}
        state: ${mysqlConfigurationState}
        types: ${mysqlConfigurationType}
Copy

Using getMysqlConfigurations

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getMysqlConfigurations(args: GetMysqlConfigurationsArgs, opts?: InvokeOptions): Promise<GetMysqlConfigurationsResult>
function getMysqlConfigurationsOutput(args: GetMysqlConfigurationsOutputArgs, opts?: InvokeOptions): Output<GetMysqlConfigurationsResult>
Copy
def get_mysql_configurations(compartment_id: Optional[str] = None,
                             configuration_id: Optional[str] = None,
                             display_name: Optional[str] = None,
                             filters: Optional[Sequence[_mysql.GetMysqlConfigurationsFilter]] = None,
                             shape_name: Optional[str] = None,
                             state: Optional[str] = None,
                             types: Optional[Sequence[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> GetMysqlConfigurationsResult
def get_mysql_configurations_output(compartment_id: Optional[pulumi.Input[str]] = None,
                             configuration_id: Optional[pulumi.Input[str]] = None,
                             display_name: Optional[pulumi.Input[str]] = None,
                             filters: Optional[pulumi.Input[Sequence[pulumi.Input[_mysql.GetMysqlConfigurationsFilterArgs]]]] = None,
                             shape_name: Optional[pulumi.Input[str]] = None,
                             state: Optional[pulumi.Input[str]] = None,
                             types: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetMysqlConfigurationsResult]
Copy
func GetMysqlConfigurations(ctx *Context, args *GetMysqlConfigurationsArgs, opts ...InvokeOption) (*GetMysqlConfigurationsResult, error)
func GetMysqlConfigurationsOutput(ctx *Context, args *GetMysqlConfigurationsOutputArgs, opts ...InvokeOption) GetMysqlConfigurationsResultOutput
Copy

> Note: This function is named GetMysqlConfigurations in the Go SDK.

public static class GetMysqlConfigurations 
{
    public static Task<GetMysqlConfigurationsResult> InvokeAsync(GetMysqlConfigurationsArgs args, InvokeOptions? opts = null)
    public static Output<GetMysqlConfigurationsResult> Invoke(GetMysqlConfigurationsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetMysqlConfigurationsResult> getMysqlConfigurations(GetMysqlConfigurationsArgs args, InvokeOptions options)
public static Output<GetMysqlConfigurationsResult> getMysqlConfigurations(GetMysqlConfigurationsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:Mysql/getMysqlConfigurations:getMysqlConfigurations
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CompartmentId This property is required. string
The compartment OCID.
ConfigurationId string
The requested Configuration instance.
DisplayName string
A filter to return only the resource matching the given display name exactly.
Filters Changes to this property will trigger replacement. List<GetMysqlConfigurationsFilter>
ShapeName string
The requested Shape name.
State string
Configuration Lifecycle State
Types List<string>
The requested Configuration types.
CompartmentId This property is required. string
The compartment OCID.
ConfigurationId string
The requested Configuration instance.
DisplayName string
A filter to return only the resource matching the given display name exactly.
Filters Changes to this property will trigger replacement. []GetMysqlConfigurationsFilter
ShapeName string
The requested Shape name.
State string
Configuration Lifecycle State
Types []string
The requested Configuration types.
compartmentId This property is required. String
The compartment OCID.
configurationId String
The requested Configuration instance.
displayName String
A filter to return only the resource matching the given display name exactly.
filters Changes to this property will trigger replacement. List<GetConfigurationsFilter>
shapeName String
The requested Shape name.
state String
Configuration Lifecycle State
types List<String>
The requested Configuration types.
compartmentId This property is required. string
The compartment OCID.
configurationId string
The requested Configuration instance.
displayName string
A filter to return only the resource matching the given display name exactly.
filters Changes to this property will trigger replacement. GetMysqlConfigurationsFilter[]
shapeName string
The requested Shape name.
state string
Configuration Lifecycle State
types string[]
The requested Configuration types.
compartment_id This property is required. str
The compartment OCID.
configuration_id str
The requested Configuration instance.
display_name str
A filter to return only the resource matching the given display name exactly.
filters Changes to this property will trigger replacement. Sequence[mysql.GetMysqlConfigurationsFilter]
shape_name str
The requested Shape name.
state str
Configuration Lifecycle State
types Sequence[str]
The requested Configuration types.
compartmentId This property is required. String
The compartment OCID.
configurationId String
The requested Configuration instance.
displayName String
A filter to return only the resource matching the given display name exactly.
filters Changes to this property will trigger replacement. List<Property Map>
shapeName String
The requested Shape name.
state String
Configuration Lifecycle State
types List<String>
The requested Configuration types.

getMysqlConfigurations Result

The following output properties are available:

CompartmentId string
OCID of the Compartment the Configuration exists in.
Configurations List<GetMysqlConfigurationsConfiguration>
The list of configurations.
Id string
The provider-assigned unique ID for this managed resource.
ConfigurationId string
DisplayName string
The display name of the Configuration.
Filters List<GetMysqlConfigurationsFilter>
ShapeName string
The name of the associated Shape.
State string
The current state of the Configuration.
Types List<string>
The Configuration type, DEFAULT or CUSTOM.
CompartmentId string
OCID of the Compartment the Configuration exists in.
Configurations []GetMysqlConfigurationsConfiguration
The list of configurations.
Id string
The provider-assigned unique ID for this managed resource.
ConfigurationId string
DisplayName string
The display name of the Configuration.
Filters []GetMysqlConfigurationsFilter
ShapeName string
The name of the associated Shape.
State string
The current state of the Configuration.
Types []string
The Configuration type, DEFAULT or CUSTOM.
compartmentId String
OCID of the Compartment the Configuration exists in.
configurations List<GetConfigurationsConfiguration>
The list of configurations.
id String
The provider-assigned unique ID for this managed resource.
configurationId String
displayName String
The display name of the Configuration.
filters List<GetConfigurationsFilter>
shapeName String
The name of the associated Shape.
state String
The current state of the Configuration.
types List<String>
The Configuration type, DEFAULT or CUSTOM.
compartmentId string
OCID of the Compartment the Configuration exists in.
configurations GetMysqlConfigurationsConfiguration[]
The list of configurations.
id string
The provider-assigned unique ID for this managed resource.
configurationId string
displayName string
The display name of the Configuration.
filters GetMysqlConfigurationsFilter[]
shapeName string
The name of the associated Shape.
state string
The current state of the Configuration.
types string[]
The Configuration type, DEFAULT or CUSTOM.
compartment_id str
OCID of the Compartment the Configuration exists in.
configurations Sequence[mysql.GetMysqlConfigurationsConfiguration]
The list of configurations.
id str
The provider-assigned unique ID for this managed resource.
configuration_id str
display_name str
The display name of the Configuration.
filters Sequence[mysql.GetMysqlConfigurationsFilter]
shape_name str
The name of the associated Shape.
state str
The current state of the Configuration.
types Sequence[str]
The Configuration type, DEFAULT or CUSTOM.
compartmentId String
OCID of the Compartment the Configuration exists in.
configurations List<Property Map>
The list of configurations.
id String
The provider-assigned unique ID for this managed resource.
configurationId String
displayName String
The display name of the Configuration.
filters List<Property Map>
shapeName String
The name of the associated Shape.
state String
The current state of the Configuration.
types List<String>
The Configuration type, DEFAULT or CUSTOM.

Supporting Types

GetMysqlConfigurationsConfiguration

CompartmentId This property is required. string
The compartment OCID.
DefinedTags This property is required. Dictionary<string, string>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description This property is required. string
User-provided data about the Configuration.
DisplayName This property is required. string
A filter to return only the resource matching the given display name exactly.
FreeformTags This property is required. Dictionary<string, string>
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id This property is required. string
The OCID of the Configuration.
InitVariables This property is required. List<GetMysqlConfigurationsConfigurationInitVariable>
User-defined service variables set only at DB system initialization. These variables cannot be changed later at runtime.
ParentConfigurationId This property is required. string
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.
ShapeName This property is required. string
The requested Shape name.
State This property is required. string
Configuration Lifecycle State
SystemTags This property is required. Dictionary<string, string>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated This property is required. string
The date and time the Configuration was created, as described by RFC 3339.
TimeUpdated This property is required. string
The date and time the Configuration was last updated, as described by RFC 3339.
Type This property is required. string
The requested Configuration types.
Variables This property is required. List<GetMysqlConfigurationsConfigurationVariable>
User-defined service variables.
CompartmentId This property is required. string
The compartment OCID.
DefinedTags This property is required. map[string]string
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description This property is required. string
User-provided data about the Configuration.
DisplayName This property is required. string
A filter to return only the resource matching the given display name exactly.
FreeformTags This property is required. map[string]string
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id This property is required. string
The OCID of the Configuration.
InitVariables This property is required. []GetMysqlConfigurationsConfigurationInitVariable
User-defined service variables set only at DB system initialization. These variables cannot be changed later at runtime.
ParentConfigurationId This property is required. string
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.
ShapeName This property is required. string
The requested Shape name.
State This property is required. string
Configuration Lifecycle State
SystemTags This property is required. map[string]string
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated This property is required. string
The date and time the Configuration was created, as described by RFC 3339.
TimeUpdated This property is required. string
The date and time the Configuration was last updated, as described by RFC 3339.
Type This property is required. string
The requested Configuration types.
Variables This property is required. []GetMysqlConfigurationsConfigurationVariable
User-defined service variables.
compartmentId This property is required. String
The compartment OCID.
definedTags This property is required. Map<String,String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description This property is required. String
User-provided data about the Configuration.
displayName This property is required. String
A filter to return only the resource matching the given display name exactly.
freeformTags This property is required. Map<String,String>
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id This property is required. String
The OCID of the Configuration.
initVariables This property is required. List<GetConfigurationsConfigurationInitVariable>
User-defined service variables set only at DB system initialization. These variables cannot be changed later at runtime.
parentConfigurationId This property is required. String
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.
shapeName This property is required. String
The requested Shape name.
state This property is required. String
Configuration Lifecycle State
systemTags This property is required. Map<String,String>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated This property is required. String
The date and time the Configuration was created, as described by RFC 3339.
timeUpdated This property is required. String
The date and time the Configuration was last updated, as described by RFC 3339.
type This property is required. String
The requested Configuration types.
variables This property is required. List<GetConfigurationsConfigurationVariable>
User-defined service variables.
compartmentId This property is required. string
The compartment OCID.
definedTags This property is required. {[key: string]: string}
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description This property is required. string
User-provided data about the Configuration.
displayName This property is required. string
A filter to return only the resource matching the given display name exactly.
freeformTags This property is required. {[key: string]: string}
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id This property is required. string
The OCID of the Configuration.
initVariables This property is required. GetMysqlConfigurationsConfigurationInitVariable[]
User-defined service variables set only at DB system initialization. These variables cannot be changed later at runtime.
parentConfigurationId This property is required. string
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.
shapeName This property is required. string
The requested Shape name.
state This property is required. string
Configuration Lifecycle State
systemTags This property is required. {[key: string]: string}
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated This property is required. string
The date and time the Configuration was created, as described by RFC 3339.
timeUpdated This property is required. string
The date and time the Configuration was last updated, as described by RFC 3339.
type This property is required. string
The requested Configuration types.
variables This property is required. GetMysqlConfigurationsConfigurationVariable[]
User-defined service variables.
compartment_id This property is required. str
The compartment OCID.
defined_tags This property is required. Mapping[str, str]
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description This property is required. str
User-provided data about the Configuration.
display_name This property is required. str
A filter to return only the resource matching the given display name exactly.
freeform_tags This property is required. Mapping[str, str]
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id This property is required. str
The OCID of the Configuration.
init_variables This property is required. Sequence[mysql.GetMysqlConfigurationsConfigurationInitVariable]
User-defined service variables set only at DB system initialization. These variables cannot be changed later at runtime.
parent_configuration_id This property is required. str
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.
shape_name This property is required. str
The requested Shape name.
state This property is required. str
Configuration Lifecycle State
system_tags This property is required. Mapping[str, str]
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created This property is required. str
The date and time the Configuration was created, as described by RFC 3339.
time_updated This property is required. str
The date and time the Configuration was last updated, as described by RFC 3339.
type This property is required. str
The requested Configuration types.
variables This property is required. Sequence[mysql.GetMysqlConfigurationsConfigurationVariable]
User-defined service variables.
compartmentId This property is required. String
The compartment OCID.
definedTags This property is required. Map<String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description This property is required. String
User-provided data about the Configuration.
displayName This property is required. String
A filter to return only the resource matching the given display name exactly.
freeformTags This property is required. Map<String>
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id This property is required. String
The OCID of the Configuration.
initVariables This property is required. List<Property Map>
User-defined service variables set only at DB system initialization. These variables cannot be changed later at runtime.
parentConfigurationId This property is required. String
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.
shapeName This property is required. String
The requested Shape name.
state This property is required. String
Configuration Lifecycle State
systemTags This property is required. Map<String>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated This property is required. String
The date and time the Configuration was created, as described by RFC 3339.
timeUpdated This property is required. String
The date and time the Configuration was last updated, as described by RFC 3339.
type This property is required. String
The requested Configuration types.
variables This property is required. List<Property Map>
User-defined service variables.

GetMysqlConfigurationsConfigurationInitVariable

LowerCaseTableNames This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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).
lower_case_table_names This property is required. str
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 This property is required. 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).

GetMysqlConfigurationsConfigurationVariable

AutoIncrementIncrement This property is required. 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.
AutoIncrementOffset This property is required. 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.
Autocommit This property is required. bool
("autocommit")
BigTables This property is required. bool
If enabled, the server stores all temporary tables on disk rather than in memory.
BinlogExpireLogsSeconds This property is required. int
Sets the binary log expiration period in seconds. binlogExpireLogsSeconds corresponds to the MySQL binary logging system variable binlog_expire_logs_seconds.
BinlogGroupCommitSyncDelay This property is required. 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.
BinlogGroupCommitSyncNoDelayCount This property is required. 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.
BinlogRowMetadata This property is required. 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.
BinlogRowValueOptions This property is required. 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 This property is required. 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 This property is required. 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.
CharacterSetServer This property is required. string
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.
CollationServer This property is required. string
The server's default collation.
CompletionType This property is required. string
("completion_type")
ConnectTimeout This property is required. int
The number of seconds that the mysqld server waits for a connect packet before responding with Bad handshake.
ConnectionMemoryChunkSize This property is required. int
Set the chunking size for updates to the global memory usage counter Global_connection_memory.
ConnectionMemoryLimit This property is required. string
Set the maximum amount of memory that can be used by a single user connection.
CteMaxRecursionDepth This property is required. string
("cte_max_recursion_depth")
DefaultAuthenticationPlugin This property is required. string
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.
ExplainFormat This property is required. string
This variable determines the default output format used by EXPLAIN in the absence of a FORMAT option when displaying a query execution plan.
ExplicitDefaultsForTimestamp This property is required. 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.
ForeignKeyChecks This property is required. bool
("foreign_key_checks")
GeneratedRandomPasswordLength This property is required. int
("generated_random_password_length") DEPRECATED -- variable should not be settable and will be ignored

Deprecated: The 'generated_random_password_length' field has been deprecated and may be removed in a future version. Do not use this field.

GlobalConnectionMemoryLimit This property is required. string
Set the total amount of memory that can be used by all user connections.
GlobalConnectionMemoryTracking This property is required. bool
Determines whether the MySQL server calculates Global_connection_memory.
GroupConcatMaxLen This property is required. string
Specifies the maximum permitted result length in bytes for the GROUP_CONCAT() function.
GroupReplicationConsistency This property is required. 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.
InformationSchemaStatsExpiry This property is required. int
("information_schema_stats_expiry")
InnodbAdaptiveHashIndex This property is required. 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.
InnodbAutoincLockMode This property is required. int
The lock mode to use for generating auto-increment values. Permissible values are 0, 1, or 2, for traditional, consecutive, or interleaved, respectively.
InnodbBufferPoolDumpPct This property is required. int
Specifies the percentage of the most recently used pages for each buffer pool to read out and dump.
InnodbBufferPoolInstances This property is required. int
("innodb_buffer_pool_instances")
InnodbBufferPoolSize This property is required. string
The size (in bytes) of the buffer pool, that is, the memory area where InnoDB caches table and index data.
InnodbChangeBuffering This property is required. string
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.
InnodbDdlBufferSize This property is required. string
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 This property is required. 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 This property is required. bool
("innodb_ft_enable_stopword")
InnodbFtMaxTokenSize This property is required. int
("innodb_ft_max_token_size")
InnodbFtMinTokenSize This property is required. int
("innodb_ft_min_token_size")
InnodbFtNumWordOptimize This property is required. int
("innodb_ft_num_word_optimize")
InnodbFtResultCacheLimit This property is required. string
("innodb_ft_result_cache_limit")
InnodbFtServerStopwordTable This property is required. string
("innodb_ft_server_stopword_table")
InnodbLockWaitTimeout This property is required. int
("innodb_lock_wait_timeout")
InnodbLogWriterThreads This property is required. 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.
InnodbMaxPurgeLag This property is required. string
The desired maximum purge lag in terms of transactions.
InnodbMaxPurgeLagDelay This property is required. int
The maximum delay in microseconds for the delay imposed when the innodb_max_purge_lag threshold is exceeded.
InnodbNumaInterleave This property is required. 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.
InnodbOnlineAlterLogMaxSize This property is required. string
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.
InnodbRedoLogCapacity This property is required. string
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.
InnodbRollbackOnTimeout This property is required. 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.
InnodbSortBufferSize This property is required. 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.
InnodbStatsPersistentSamplePages This property is required. string
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 This property is required. string
The number of index pages to sample when estimating cardinality and other statistics for an indexed column, such as those calculated by ANALYZE TABLE.
InnodbStrictMode This property is required. bool
When you enable innodbStrictMode, the InnoDB storage engine returns errors instead of warnings for invalid or incompatible table options.
InnodbUndoLogTruncate This property is required. 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.
InteractiveTimeout This property is required. int
The number of seconds the server waits for activity on an interactive connection before closing it.
JoinBufferSize This property is required. string
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.
LocalInfile This property is required. 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.
LongQueryTime This property is required. 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.
MandatoryRoles This property is required. string
("mandatory_roles")
MaxAllowedPacket This property is required. int
The maximum size of one packet or any generated/intermediate string.
MaxBinlogCacheSize This property is required. string
Sets the size of the transaction cache.
MaxConnectErrors This property is required. string
("max_connect_errors")
MaxConnections This property is required. int
("max_connections")
MaxExecutionTime This property is required. string
("max_execution_time")
MaxHeapTableSize This property is required. string
This variable sets the maximum size to which user-created MEMORY tables are permitted to grow.
MaxPreparedStmtCount This property is required. int
("max_prepared_stmt_count")
MaxSeeksForKey This property is required. string
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, “SHOW INDEX Statement”). By setting this to a low value (say, 100), you can force MySQL to prefer indexes instead of table scans.
MaxUserConnections This property is required. string
The maximum number of simultaneous connections permitted to any given MySQL user account. A value of 0 (the default) means “no limit.” 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.
MysqlFirewallMode This property is required. bool
("mysql_firewall_mode")
MysqlZstdDefaultCompressionLevel This property is required. int
DEPRECATED -- typo of mysqlx_zstd_default_compression_level. variable will be ignored.

Deprecated: The 'mysql_zstd_default_compression_level' field has been deprecated and may be removed in a future version. Do not use this field.

MysqlxConnectTimeout This property is required. int
The number of seconds X Plugin waits for the first packet to be received from newly connected clients.
MysqlxDeflateDefaultCompressionLevel This property is required. int
Set the default compression level for the deflate algorithm. ("mysqlx_deflate_default_compression_level")
MysqlxDeflateMaxClientCompressionLevel This property is required. int
Limit the upper bound of accepted compression levels for the deflate algorithm. ("mysqlx_deflate_max_client_compression_level")
MysqlxDocumentIdUniquePrefix This property is required. int
("mysqlx_document_id_unique_prefix") DEPRECATED -- variable should not be settable and will be ignored

Deprecated: The 'mysqlx_document_id_unique_prefix' field has been deprecated and may be removed in a future version. Do not use this field.

MysqlxEnableHelloNotice This property is required. bool
("mysqlx_enable_hello_notice") DEPRECATED -- variable should not be settable and will be ignored
MysqlxIdleWorkerThreadTimeout This property is required. int
("mysqlx_idle_worker_thread_timeout") DEPRECATED -- variable should not be settable and will be ignored

Deprecated: The 'mysqlx_idle_worker_thread_timeout' field has been deprecated and may be removed in a future version. Do not use this field.

MysqlxInteractiveTimeout This property is required. int
The number of seconds to wait for interactive clients to timeout.
MysqlxLz4defaultCompressionLevel This property is required. int
Set the default compression level for the lz4 algorithm. ("mysqlx_lz4_default_compression_level")
MysqlxLz4maxClientCompressionLevel This property is required. int
Limit the upper bound of accepted compression levels for the lz4 algorithm. ("mysqlx_lz4_max_client_compression_level")
MysqlxMaxAllowedPacket This property is required. int
The maximum size of network packets that can be received by X Plugin.
MysqlxMinWorkerThreads This property is required. int
("mysqlx_min_worker_threads") DEPRECATED -- variable should not be settable and will be ignored

Deprecated: The 'mysqlx_min_worker_threads' field has been deprecated and may be removed in a future version. Do not use this field.

MysqlxReadTimeout This property is required. 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.
MysqlxWaitTimeout This property is required. int
The number of seconds that X Plugin waits for activity on a connection.
MysqlxWriteTimeout This property is required. 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.
MysqlxZstdDefaultCompressionLevel This property is required. int
Set the default compression level for the zstd algorithm. ("mysqlx_zstd_default_compression_level")
MysqlxZstdMaxClientCompressionLevel This property is required. int
Limit the upper bound of accepted compression levels for the zstd algorithm. ("mysqlx_zstd_max_client_compression_level")
NetReadTimeout This property is required. int
The number of seconds to wait for more data from a connection before aborting the read.
NetWriteTimeout This property is required. int
The number of seconds to wait for a block to be written to a connection before aborting the write.
OptimizerSwitch This property is required. 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.
ParserMaxMemSize This property is required. string
("parser_max_mem_size")
QueryAllocBlockSize This property is required. string
("query_alloc_block_size") DEPRECATED -- variable should not be settable and will be ignored

Deprecated: The 'query_alloc_block_size' field has been deprecated and may be removed in a future version. Do not use this field.

QueryPreallocSize This property is required. string
("query_prealloc_size") DEPRECATED -- variable should not be settable and will be ignored
RangeOptimizerMaxMemSize This property is required. string
The limit on memory consumption for the range optimizer. A value of 0 means “no limit.” 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.

Deprecated: The 'query_prealloc_size' field has been deprecated and may be removed in a future version. Do not use this field.

RegexpTimeLimit This property is required. 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 This property is required. string
The maximum amount of space to use for all relay logs.
ReplicaNetTimeout This property is required. 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.
ReplicaParallelWorkers This property is required. 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.)
ReplicaTypeConversions This property is required. 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.
RequireSecureTransport This property is required. 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.
SkipNameResolve This property is required. 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, “DNS Lookups and the Host Cache”.
SortBufferSize This property is required. string
Each session that must perform a sort allocates a buffer of this size.
SqlGenerateInvisiblePrimaryKey This property is required. 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.
SqlMode This property is required. string
("sql_mode")
SqlRequirePrimaryKey This property is required. bool
("sql_require_primary_key")
SqlWarnings This property is required. bool
("sql_warnings")
TableDefinitionCache This property is required. 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.
TableOpenCache This property is required. int
The number of open tables for all threads. Increasing this value increases the number of file descriptors that mysqld requires.
TemptableMaxRam This property is required. string
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, “Internal Temporary Table Use in MySQL”.
ThreadPoolDedicatedListeners This property is required. 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 This property is required. 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 This property is required. 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.
ThreadPoolSize This property is required. 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.
ThreadPoolTransactionDelay This property is required. 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.
TimeZone This property is required. string
Initializes the time zone for each client that connects.
TmpTableSize This property is required. string
The maximum size of internal in-memory temporary tables. This variable does not apply to user-created MEMORY tables.
TransactionIsolation This property is required. string
("transaction_isolation")
WaitTimeout This property is required. int
The number of seconds the server waits for activity on a noninteractive connection before closing it.
AutoIncrementIncrement This property is required. 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.
AutoIncrementOffset This property is required. 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.
Autocommit This property is required. bool
("autocommit")
BigTables This property is required. bool
If enabled, the server stores all temporary tables on disk rather than in memory.
BinlogExpireLogsSeconds This property is required. int
Sets the binary log expiration period in seconds. binlogExpireLogsSeconds corresponds to the MySQL binary logging system variable binlog_expire_logs_seconds.
BinlogGroupCommitSyncDelay This property is required. 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.
BinlogGroupCommitSyncNoDelayCount This property is required. 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.
BinlogRowMetadata This property is required. 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.
BinlogRowValueOptions This property is required. 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 This property is required. 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 This property is required. 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.
CharacterSetServer This property is required. string
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.
CollationServer This property is required. string
The server's default collation.
CompletionType This property is required. string
("completion_type")
ConnectTimeout This property is required. int
The number of seconds that the mysqld server waits for a connect packet before responding with Bad handshake.
ConnectionMemoryChunkSize This property is required. int
Set the chunking size for updates to the global memory usage counter Global_connection_memory.
ConnectionMemoryLimit This property is required. string
Set the maximum amount of memory that can be used by a single user connection.
CteMaxRecursionDepth This property is required. string
("cte_max_recursion_depth")
DefaultAuthenticationPlugin This property is required. string
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.
ExplainFormat This property is required. string
This variable determines the default output format used by EXPLAIN in the absence of a FORMAT option when displaying a query execution plan.
ExplicitDefaultsForTimestamp This property is required. 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.
ForeignKeyChecks This property is required. bool
("foreign_key_checks")
GeneratedRandomPasswordLength This property is required. int
("generated_random_password_length") DEPRECATED -- variable should not be settable and will be ignored

Deprecated: The 'generated_random_password_length' field has been deprecated and may be removed in a future version. Do not use this field.

GlobalConnectionMemoryLimit This property is required. string
Set the total amount of memory that can be used by all user connections.
GlobalConnectionMemoryTracking This property is required. bool
Determines whether the MySQL server calculates Global_connection_memory.
GroupConcatMaxLen This property is required. string
Specifies the maximum permitted result length in bytes for the GROUP_CONCAT() function.
GroupReplicationConsistency This property is required. 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.
InformationSchemaStatsExpiry This property is required. int
("information_schema_stats_expiry")
InnodbAdaptiveHashIndex This property is required. 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.
InnodbAutoincLockMode This property is required. int
The lock mode to use for generating auto-increment values. Permissible values are 0, 1, or 2, for traditional, consecutive, or interleaved, respectively.
InnodbBufferPoolDumpPct This property is required. int
Specifies the percentage of the most recently used pages for each buffer pool to read out and dump.
InnodbBufferPoolInstances This property is required. int
("innodb_buffer_pool_instances")
InnodbBufferPoolSize This property is required. string
The size (in bytes) of the buffer pool, that is, the memory area where InnoDB caches table and index data.
InnodbChangeBuffering This property is required. string
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.
InnodbDdlBufferSize This property is required. string
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 This property is required. 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 This property is required. bool
("innodb_ft_enable_stopword")
InnodbFtMaxTokenSize This property is required. int
("innodb_ft_max_token_size")
InnodbFtMinTokenSize This property is required. int
("innodb_ft_min_token_size")
InnodbFtNumWordOptimize This property is required. int
("innodb_ft_num_word_optimize")
InnodbFtResultCacheLimit This property is required. string
("innodb_ft_result_cache_limit")
InnodbFtServerStopwordTable This property is required. string
("innodb_ft_server_stopword_table")
InnodbLockWaitTimeout This property is required. int
("innodb_lock_wait_timeout")
InnodbLogWriterThreads This property is required. 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.
InnodbMaxPurgeLag This property is required. string
The desired maximum purge lag in terms of transactions.
InnodbMaxPurgeLagDelay This property is required. int
The maximum delay in microseconds for the delay imposed when the innodb_max_purge_lag threshold is exceeded.
InnodbNumaInterleave This property is required. 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.
InnodbOnlineAlterLogMaxSize This property is required. string
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.
InnodbRedoLogCapacity This property is required. string
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.
InnodbRollbackOnTimeout This property is required. 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.
InnodbSortBufferSize This property is required. 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.
InnodbStatsPersistentSamplePages This property is required. string
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 This property is required. string
The number of index pages to sample when estimating cardinality and other statistics for an indexed column, such as those calculated by ANALYZE TABLE.
InnodbStrictMode This property is required. bool
When you enable innodbStrictMode, the InnoDB storage engine returns errors instead of warnings for invalid or incompatible table options.
InnodbUndoLogTruncate This property is required. 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.
InteractiveTimeout This property is required. int
The number of seconds the server waits for activity on an interactive connection before closing it.
JoinBufferSize This property is required. string
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.
LocalInfile This property is required. 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.
LongQueryTime This property is required. 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.
MandatoryRoles This property is required. string
("mandatory_roles")
MaxAllowedPacket This property is required. int
The maximum size of one packet or any generated/intermediate string.
MaxBinlogCacheSize This property is required. string
Sets the size of the transaction cache.
MaxConnectErrors This property is required. string
("max_connect_errors")
MaxConnections This property is required. int
("max_connections")
MaxExecutionTime This property is required. string
("max_execution_time")
MaxHeapTableSize This property is required. string
This variable sets the maximum size to which user-created MEMORY tables are permitted to grow.
MaxPreparedStmtCount This property is required. int
("max_prepared_stmt_count")
MaxSeeksForKey This property is required. string
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, “SHOW INDEX Statement”). By setting this to a low value (say, 100), you can force MySQL to prefer indexes instead of table scans.
MaxUserConnections This property is required. string
The maximum number of simultaneous connections permitted to any given MySQL user account. A value of 0 (the default) means “no limit.” 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.
MysqlFirewallMode This property is required. bool
("mysql_firewall_mode")
MysqlZstdDefaultCompressionLevel This property is required. int
DEPRECATED -- typo of mysqlx_zstd_default_compression_level. variable will be ignored.

Deprecated: The 'mysql_zstd_default_compression_level' field has been deprecated and may be removed in a future version. Do not use this field.

MysqlxConnectTimeout This property is required. int
The number of seconds X Plugin waits for the first packet to be received from newly connected clients.
MysqlxDeflateDefaultCompressionLevel This property is required. int
Set the default compression level for the deflate algorithm. ("mysqlx_deflate_default_compression_level")
MysqlxDeflateMaxClientCompressionLevel This property is required. int
Limit the upper bound of accepted compression levels for the deflate algorithm. ("mysqlx_deflate_max_client_compression_level")
MysqlxDocumentIdUniquePrefix This property is required. int
("mysqlx_document_id_unique_prefix") DEPRECATED -- variable should not be settable and will be ignored

Deprecated: The 'mysqlx_document_id_unique_prefix' field has been deprecated and may be removed in a future version. Do not use this field.

MysqlxEnableHelloNotice This property is required. bool
("mysqlx_enable_hello_notice") DEPRECATED -- variable should not be settable and will be ignored
MysqlxIdleWorkerThreadTimeout This property is required. int
("mysqlx_idle_worker_thread_timeout") DEPRECATED -- variable should not be settable and will be ignored

Deprecated: The 'mysqlx_idle_worker_thread_timeout' field has been deprecated and may be removed in a future version. Do not use this field.

MysqlxInteractiveTimeout This property is required. int
The number of seconds to wait for interactive clients to timeout.
MysqlxLz4defaultCompressionLevel This property is required. int
Set the default compression level for the lz4 algorithm. ("mysqlx_lz4_default_compression_level")
MysqlxLz4maxClientCompressionLevel This property is required. int
Limit the upper bound of accepted compression levels for the lz4 algorithm. ("mysqlx_lz4_max_client_compression_level")
MysqlxMaxAllowedPacket This property is required. int
The maximum size of network packets that can be received by X Plugin.
MysqlxMinWorkerThreads This property is required. int
("mysqlx_min_worker_threads") DEPRECATED -- variable should not be settable and will be ignored

Deprecated: The 'mysqlx_min_worker_threads' field has been deprecated and may be removed in a future version. Do not use this field.

MysqlxReadTimeout This property is required. 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.
MysqlxWaitTimeout This property is required. int
The number of seconds that X Plugin waits for activity on a connection.
MysqlxWriteTimeout This property is required. 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.
MysqlxZstdDefaultCompressionLevel This property is required. int
Set the default compression level for the zstd algorithm. ("mysqlx_zstd_default_compression_level")
MysqlxZstdMaxClientCompressionLevel This property is required. int
Limit the upper bound of accepted compression levels for the zstd algorithm. ("mysqlx_zstd_max_client_compression_level")
NetReadTimeout This property is required. int
The number of seconds to wait for more data from a connection before aborting the read.
NetWriteTimeout This property is required. int
The number of seconds to wait for a block to be written to a connection before aborting the write.
OptimizerSwitch This property is required. 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.
ParserMaxMemSize This property is required. string
("parser_max_mem_size")
QueryAllocBlockSize This property is required. string
("query_alloc_block_size") DEPRECATED -- variable should not be settable and will be ignored

Deprecated: The 'query_alloc_block_size' field has been deprecated and may be removed in a future version. Do not use this field.

QueryPreallocSize This property is required. string
("query_prealloc_size") DEPRECATED -- variable should not be settable and will be ignored
RangeOptimizerMaxMemSize This property is required. string
The limit on memory consumption for the range optimizer. A value of 0 means “no limit.” 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.

Deprecated: The 'query_prealloc_size' field has been deprecated and may be removed in a future version. Do not use this field.

RegexpTimeLimit This property is required. 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 This property is required. string
The maximum amount of space to use for all relay logs.
ReplicaNetTimeout This property is required. 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.
ReplicaParallelWorkers This property is required. 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.)
ReplicaTypeConversions This property is required. 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.
RequireSecureTransport This property is required. 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.
SkipNameResolve This property is required. 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, “DNS Lookups and the Host Cache”.
SortBufferSize This property is required. string
Each session that must perform a sort allocates a buffer of this size.
SqlGenerateInvisiblePrimaryKey This property is required. 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.
SqlMode This property is required. string
("sql_mode")
SqlRequirePrimaryKey This property is required. bool
("sql_require_primary_key")
SqlWarnings This property is required. bool
("sql_warnings")
TableDefinitionCache This property is required. 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.
TableOpenCache This property is required. int
The number of open tables for all threads. Increasing this value increases the number of file descriptors that mysqld requires.
TemptableMaxRam This property is required. string
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, “Internal Temporary Table Use in MySQL”.
ThreadPoolDedicatedListeners This property is required. 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 This property is required. 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 This property is required. 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.
ThreadPoolSize This property is required. 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.
ThreadPoolTransactionDelay This property is required. 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.
TimeZone This property is required. string
Initializes the time zone for each client that connects.
TmpTableSize This property is required. string
The maximum size of internal in-memory temporary tables. This variable does not apply to user-created MEMORY tables.
TransactionIsolation This property is required. string
("transaction_isolation")
WaitTimeout This property is required. int
The number of seconds the server waits for activity on a noninteractive connection before closing it.
autoIncrementIncrement This property is required. Integer
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.
autoIncrementOffset This property is required. Integer
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.
autocommit This property is required. Boolean
("autocommit")
bigTables This property is required. Boolean
If enabled, the server stores all temporary tables on disk rather than in memory.
binlogExpireLogsSeconds This property is required. Integer
Sets the binary log expiration period in seconds. binlogExpireLogsSeconds corresponds to the MySQL binary logging system variable binlog_expire_logs_seconds.
binlogGroupCommitSyncDelay This property is required. Integer
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.
binlogGroupCommitSyncNoDelayCount This property is required. Integer
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.
binlogRowMetadata This property is required. 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.
binlogRowValueOptions This property is required. 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 This property is required. 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.
blockEncryptionMode This property is required. 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.
characterSetServer This property is required. String
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.
collationServer This property is required. String
The server's default collation.
completionType This property is required. String
("completion_type")
connectTimeout This property is required. Integer
The number of seconds that the mysqld server waits for a connect packet before responding with Bad handshake.
connectionMemoryChunkSize This property is required. Integer
Set the chunking size for updates to the global memory usage counter Global_connection_memory.
connectionMemoryLimit This property is required. String
Set the maximum amount of memory that can be used by a single user connection.
cteMaxRecursionDepth This property is required. String
("cte_max_recursion_depth")
defaultAuthenticationPlugin This property is required. String
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.
explainFormat This property is required. String
This variable determines the default output format used by EXPLAIN in the absence of a FORMAT option when displaying a query execution plan.
explicitDefaultsForTimestamp This property is required. Boolean
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.
foreignKeyChecks This property is required. Boolean
("foreign_key_checks")
generatedRandomPasswordLength This property is required. Integer
("generated_random_password_length") DEPRECATED -- variable should not be settable and will be ignored

Deprecated: The 'generated_random_password_length' field has been deprecated and may be removed in a future version. Do not use this field.

globalConnectionMemoryLimit This property is required. String
Set the total amount of memory that can be used by all user connections.
globalConnectionMemoryTracking This property is required. Boolean
Determines whether the MySQL server calculates Global_connection_memory.
groupConcatMaxLen This property is required. String
Specifies the maximum permitted result length in bytes for the GROUP_CONCAT() function.
groupReplicationConsistency This property is required. 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.
informationSchemaStatsExpiry This property is required. Integer
("information_schema_stats_expiry")
innodbAdaptiveHashIndex This property is required. Boolean
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.
innodbAutoincLockMode This property is required. Integer
The lock mode to use for generating auto-increment values. Permissible values are 0, 1, or 2, for traditional, consecutive, or interleaved, respectively.
innodbBufferPoolDumpPct This property is required. Integer
Specifies the percentage of the most recently used pages for each buffer pool to read out and dump.
innodbBufferPoolInstances This property is required. Integer
("innodb_buffer_pool_instances")
innodbBufferPoolSize This property is required. String
The size (in bytes) of the buffer pool, that is, the memory area where InnoDB caches table and index data.
innodbChangeBuffering This property is required. String
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.
innodbDdlBufferSize This property is required. String
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 This property is required. Integer
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 This property is required. Boolean
("innodb_ft_enable_stopword")
innodbFtMaxTokenSize This property is required. Integer
("innodb_ft_max_token_size")
innodbFtMinTokenSize This property is required. Integer
("innodb_ft_min_token_size")
innodbFtNumWordOptimize This property is required. Integer
("innodb_ft_num_word_optimize")
innodbFtResultCacheLimit This property is required. String
("innodb_ft_result_cache_limit")
innodbFtServerStopwordTable This property is required. String
("innodb_ft_server_stopword_table")
innodbLockWaitTimeout This property is required. Integer
("innodb_lock_wait_timeout")
innodbLogWriterThreads This property is required. 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.
innodbMaxPurgeLag This property is required. String
The desired maximum purge lag in terms of transactions.
innodbMaxPurgeLagDelay This property is required. Integer
The maximum delay in microseconds for the delay imposed when the innodb_max_purge_lag threshold is exceeded.
innodbNumaInterleave This property is required. Boolean
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.
innodbOnlineAlterLogMaxSize This property is required. String
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.
innodbRedoLogCapacity This property is required. String
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.
innodbRollbackOnTimeout This property is required. Boolean
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.
innodbSortBufferSize This property is required. Integer
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.
innodbStatsPersistentSamplePages This property is required. String
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 This property is required. String
The number of index pages to sample when estimating cardinality and other statistics for an indexed column, such as those calculated by ANALYZE TABLE.
innodbStrictMode This property is required. Boolean
When you enable innodbStrictMode, the InnoDB storage engine returns errors instead of warnings for invalid or incompatible table options.
innodbUndoLogTruncate This property is required. Boolean
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.
interactiveTimeout This property is required. Integer
The number of seconds the server waits for activity on an interactive connection before closing it.
joinBufferSize This property is required. String
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.
localInfile This property is required. Boolean
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.
longQueryTime This property is required. Integer
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.
mandatoryRoles This property is required. String
("mandatory_roles")
maxAllowedPacket This property is required. Integer
The maximum size of one packet or any generated/intermediate string.
maxBinlogCacheSize This property is required. String
Sets the size of the transaction cache.
maxConnectErrors This property is required. String
("max_connect_errors")
maxConnections This property is required. Integer
("max_connections")
maxExecutionTime This property is required. String
("max_execution_time")
maxHeapTableSize This property is required. String
This variable sets the maximum size to which user-created MEMORY tables are permitted to grow.
maxPreparedStmtCount This property is required. Integer
("max_prepared_stmt_count")
maxSeeksForKey This property is required. String
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, “SHOW INDEX Statement”). By setting this to a low value (say, 100), you can force MySQL to prefer indexes instead of table scans.
maxUserConnections This property is required. String
The maximum number of simultaneous connections permitted to any given MySQL user account. A value of 0 (the default) means “no limit.” 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.
mysqlFirewallMode This property is required. Boolean
("mysql_firewall_mode")
mysqlZstdDefaultCompressionLevel This property is required. Integer
DEPRECATED -- typo of mysqlx_zstd_default_compression_level. variable will be ignored.

Deprecated: The 'mysql_zstd_default_compression_level' field has been deprecated and may be removed in a future version. Do not use this field.

mysqlxConnectTimeout This property is required. Integer
The number of seconds X Plugin waits for the first packet to be received from newly connected clients.
mysqlxDeflateDefaultCompressionLevel This property is required. Integer
Set the default compression level for the deflate algorithm. ("mysqlx_deflate_default_compression_level")
mysqlxDeflateMaxClientCompressionLevel This property is required. Integer
Limit the upper bound of accepted compression levels for the deflate algorithm. ("mysqlx_deflate_max_client_compression_level")
mysqlxDocumentIdUniquePrefix This property is required. Integer
("mysqlx_document_id_unique_prefix") DEPRECATED -- variable should not be settable and will be ignored

Deprecated: The 'mysqlx_document_id_unique_prefix' field has been deprecated and may be removed in a future version. Do not use this field.

mysqlxEnableHelloNotice This property is required. Boolean
("mysqlx_enable_hello_notice") DEPRECATED -- variable should not be settable and will be ignored
mysqlxIdleWorkerThreadTimeout This property is required. Integer
("mysqlx_idle_worker_thread_timeout") DEPRECATED -- variable should not be settable and will be ignored

Deprecated: The 'mysqlx_idle_worker_thread_timeout' field has been deprecated and may be removed in a future version. Do not use this field.

mysqlxInteractiveTimeout This property is required. Integer
The number of seconds to wait for interactive clients to timeout.
mysqlxLz4defaultCompressionLevel This property is required. Integer
Set the default compression level for the lz4 algorithm. ("mysqlx_lz4_default_compression_level")
mysqlxLz4maxClientCompressionLevel This property is required. Integer
Limit the upper bound of accepted compression levels for the lz4 algorithm. ("mysqlx_lz4_max_client_compression_level")
mysqlxMaxAllowedPacket This property is required. Integer
The maximum size of network packets that can be received by X Plugin.
mysqlxMinWorkerThreads This property is required. Integer
("mysqlx_min_worker_threads") DEPRECATED -- variable should not be settable and will be ignored

Deprecated: The 'mysqlx_min_worker_threads' field has been deprecated and may be removed in a future version. Do not use this field.

mysqlxReadTimeout This property is required. 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.
mysqlxWaitTimeout This property is required. Integer
The number of seconds that X Plugin waits for activity on a connection.
mysqlxWriteTimeout This property is required. 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.
mysqlxZstdDefaultCompressionLevel This property is required. Integer
Set the default compression level for the zstd algorithm. ("mysqlx_zstd_default_compression_level")
mysqlxZstdMaxClientCompressionLevel This property is required. Integer
Limit the upper bound of accepted compression levels for the zstd algorithm. ("mysqlx_zstd_max_client_compression_level")
netReadTimeout This property is required. Integer
The number of seconds to wait for more data from a connection before aborting the read.
netWriteTimeout This property is required. Integer
The number of seconds to wait for a block to be written to a connection before aborting the write.
optimizerSwitch This property is required. 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.
parserMaxMemSize This property is required. String
("parser_max_mem_size")
queryAllocBlockSize This property is required. String
("query_alloc_block_size") DEPRECATED -- variable should not be settable and will be ignored

Deprecated: The 'query_alloc_block_size' field has been deprecated and may be removed in a future version. Do not use this field.

queryPreallocSize This property is required. String
("query_prealloc_size") DEPRECATED -- variable should not be settable and will be ignored
rangeOptimizerMaxMemSize This property is required. String
The limit on memory consumption for the range optimizer. A value of 0 means “no limit.” 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.

Deprecated: The 'query_prealloc_size' field has been deprecated and may be removed in a future version. Do not use this field.

regexpTimeLimit This property is required. Integer
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 This property is required. String
The maximum amount of space to use for all relay logs.
replicaNetTimeout This property is required. Integer
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.
replicaParallelWorkers This property is required. Integer
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.)
replicaTypeConversions This property is required. 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.
requireSecureTransport This property is required. Boolean
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.
skipNameResolve This property is required. Boolean
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, “DNS Lookups and the Host Cache”.
sortBufferSize This property is required. String
Each session that must perform a sort allocates a buffer of this size.
sqlGenerateInvisiblePrimaryKey This property is required. Boolean
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.
sqlMode This property is required. String
("sql_mode")
sqlRequirePrimaryKey This property is required. Boolean
("sql_require_primary_key")
sqlWarnings This property is required. Boolean
("sql_warnings")
tableDefinitionCache This property is required. Integer
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.
tableOpenCache This property is required. Integer
The number of open tables for all threads. Increasing this value increases the number of file descriptors that mysqld requires.
temptableMaxRam This property is required. String
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, “Internal Temporary Table Use in MySQL”.
threadPoolDedicatedListeners This property is required. 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.
threadPoolMaxTransactionsLimit This property is required. 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.
threadPoolQueryThreadsPerGroup This property is required. Integer
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.
threadPoolSize This property is required. Integer
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.
threadPoolTransactionDelay This property is required. Integer
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.
timeZone This property is required. String
Initializes the time zone for each client that connects.
tmpTableSize This property is required. String
The maximum size of internal in-memory temporary tables. This variable does not apply to user-created MEMORY tables.
transactionIsolation This property is required. String
("transaction_isolation")
waitTimeout This property is required. Integer
The number of seconds the server waits for activity on a noninteractive connection before closing it.
autoIncrementIncrement This property is required. number
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.
autoIncrementOffset This property is required. number
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.
autocommit This property is required. boolean
("autocommit")
bigTables This property is required. boolean
If enabled, the server stores all temporary tables on disk rather than in memory.
binlogExpireLogsSeconds This property is required. number
Sets the binary log expiration period in seconds. binlogExpireLogsSeconds corresponds to the MySQL binary logging system variable binlog_expire_logs_seconds.
binlogGroupCommitSyncDelay This property is required. number
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.
binlogGroupCommitSyncNoDelayCount This property is required. number
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.
binlogRowMetadata This property is required. 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.
binlogRowValueOptions This property is required. 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 This property is required. 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.
blockEncryptionMode This property is required. 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.
characterSetServer This property is required. string
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.
collationServer This property is required. string
The server's default collation.
completionType This property is required. string
("completion_type")
connectTimeout This property is required. number
The number of seconds that the mysqld server waits for a connect packet before responding with Bad handshake.
connectionMemoryChunkSize This property is required. number
Set the chunking size for updates to the global memory usage counter Global_connection_memory.
connectionMemoryLimit This property is required. string
Set the maximum amount of memory that can be used by a single user connection.
cteMaxRecursionDepth This property is required. string
("cte_max_recursion_depth")
defaultAuthenticationPlugin This property is required. string
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.
explainFormat This property is required. string
This variable determines the default output format used by EXPLAIN in the absence of a FORMAT option when displaying a query execution plan.
explicitDefaultsForTimestamp This property is required. boolean
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.
foreignKeyChecks This property is required. boolean
("foreign_key_checks")
generatedRandomPasswordLength This property is required. number
("generated_random_password_length") DEPRECATED -- variable should not be settable and will be ignored

Deprecated: The 'generated_random_password_length' field has been deprecated and may be removed in a future version. Do not use this field.

globalConnectionMemoryLimit This property is required. string
Set the total amount of memory that can be used by all user connections.
globalConnectionMemoryTracking This property is required. boolean
Determines whether the MySQL server calculates Global_connection_memory.
groupConcatMaxLen This property is required. string
Specifies the maximum permitted result length in bytes for the GROUP_CONCAT() function.
groupReplicationConsistency This property is required. 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.
informationSchemaStatsExpiry This property is required. number
("information_schema_stats_expiry")
innodbAdaptiveHashIndex This property is required. boolean
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.
innodbAutoincLockMode This property is required. number
The lock mode to use for generating auto-increment values. Permissible values are 0, 1, or 2, for traditional, consecutive, or interleaved, respectively.
innodbBufferPoolDumpPct This property is required. number
Specifies the percentage of the most recently used pages for each buffer pool to read out and dump.
innodbBufferPoolInstances This property is required. number
("innodb_buffer_pool_instances")
innodbBufferPoolSize This property is required. string
The size (in bytes) of the buffer pool, that is, the memory area where InnoDB caches table and index data.
innodbChangeBuffering This property is required. string
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.
innodbDdlBufferSize This property is required. string
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 This property is required. number
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 This property is required. boolean
("innodb_ft_enable_stopword")
innodbFtMaxTokenSize This property is required. number
("innodb_ft_max_token_size")
innodbFtMinTokenSize This property is required. number
("innodb_ft_min_token_size")
innodbFtNumWordOptimize This property is required. number
("innodb_ft_num_word_optimize")
innodbFtResultCacheLimit This property is required. string
("innodb_ft_result_cache_limit")
innodbFtServerStopwordTable This property is required. string
("innodb_ft_server_stopword_table")
innodbLockWaitTimeout This property is required. number
("innodb_lock_wait_timeout")
innodbLogWriterThreads This property is required. 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.
innodbMaxPurgeLag This property is required. string
The desired maximum purge lag in terms of transactions.
innodbMaxPurgeLagDelay This property is required. number
The maximum delay in microseconds for the delay imposed when the innodb_max_purge_lag threshold is exceeded.
innodbNumaInterleave This property is required. boolean
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.
innodbOnlineAlterLogMaxSize This property is required. string
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.
innodbRedoLogCapacity This property is required. string
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.
innodbRollbackOnTimeout This property is required. boolean
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.
innodbSortBufferSize This property is required. number
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.
innodbStatsPersistentSamplePages This property is required. string
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 This property is required. string
The number of index pages to sample when estimating cardinality and other statistics for an indexed column, such as those calculated by ANALYZE TABLE.
innodbStrictMode This property is required. boolean
When you enable innodbStrictMode, the InnoDB storage engine returns errors instead of warnings for invalid or incompatible table options.
innodbUndoLogTruncate This property is required. boolean
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.
interactiveTimeout This property is required. number
The number of seconds the server waits for activity on an interactive connection before closing it.
joinBufferSize This property is required. string
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.
localInfile This property is required. boolean
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.
longQueryTime This property is required. number
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.
mandatoryRoles This property is required. string
("mandatory_roles")
maxAllowedPacket This property is required. number
The maximum size of one packet or any generated/intermediate string.
maxBinlogCacheSize This property is required. string
Sets the size of the transaction cache.
maxConnectErrors This property is required. string
("max_connect_errors")
maxConnections This property is required. number
("max_connections")
maxExecutionTime This property is required. string
("max_execution_time")
maxHeapTableSize This property is required. string
This variable sets the maximum size to which user-created MEMORY tables are permitted to grow.
maxPreparedStmtCount This property is required. number
("max_prepared_stmt_count")
maxSeeksForKey This property is required. string
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, “SHOW INDEX Statement”). By setting this to a low value (say, 100), you can force MySQL to prefer indexes instead of table scans.
maxUserConnections This property is required. string
The maximum number of simultaneous connections permitted to any given MySQL user account. A value of 0 (the default) means “no limit.” 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.
mysqlFirewallMode This property is required. boolean
("mysql_firewall_mode")
mysqlZstdDefaultCompressionLevel This property is required. number
DEPRECATED -- typo of mysqlx_zstd_default_compression_level. variable will be ignored.

Deprecated: The 'mysql_zstd_default_compression_level' field has been deprecated and may be removed in a future version. Do not use this field.

mysqlxConnectTimeout This property is required. number
The number of seconds X Plugin waits for the first packet to be received from newly connected clients.
mysqlxDeflateDefaultCompressionLevel This property is required. number
Set the default compression level for the deflate algorithm. ("mysqlx_deflate_default_compression_level")
mysqlxDeflateMaxClientCompressionLevel This property is required. number
Limit the upper bound of accepted compression levels for the deflate algorithm. ("mysqlx_deflate_max_client_compression_level")
mysqlxDocumentIdUniquePrefix This property is required. number
("mysqlx_document_id_unique_prefix") DEPRECATED -- variable should not be settable and will be ignored

Deprecated: The 'mysqlx_document_id_unique_prefix' field has been deprecated and may be removed in a future version. Do not use this field.

mysqlxEnableHelloNotice This property is required. boolean
("mysqlx_enable_hello_notice") DEPRECATED -- variable should not be settable and will be ignored
mysqlxIdleWorkerThreadTimeout This property is required. number
("mysqlx_idle_worker_thread_timeout") DEPRECATED -- variable should not be settable and will be ignored

Deprecated: The 'mysqlx_idle_worker_thread_timeout' field has been deprecated and may be removed in a future version. Do not use this field.

mysqlxInteractiveTimeout This property is required. number
The number of seconds to wait for interactive clients to timeout.
mysqlxLz4defaultCompressionLevel This property is required. number
Set the default compression level for the lz4 algorithm. ("mysqlx_lz4_default_compression_level")
mysqlxLz4maxClientCompressionLevel This property is required. number
Limit the upper bound of accepted compression levels for the lz4 algorithm. ("mysqlx_lz4_max_client_compression_level")
mysqlxMaxAllowedPacket This property is required. number
The maximum size of network packets that can be received by X Plugin.
mysqlxMinWorkerThreads This property is required. number
("mysqlx_min_worker_threads") DEPRECATED -- variable should not be settable and will be ignored

Deprecated: The 'mysqlx_min_worker_threads' field has been deprecated and may be removed in a future version. Do not use this field.

mysqlxReadTimeout This property is required. number
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.
mysqlxWaitTimeout This property is required. number
The number of seconds that X Plugin waits for activity on a connection.
mysqlxWriteTimeout This property is required. number
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.
mysqlxZstdDefaultCompressionLevel This property is required. number
Set the default compression level for the zstd algorithm. ("mysqlx_zstd_default_compression_level")
mysqlxZstdMaxClientCompressionLevel This property is required. number
Limit the upper bound of accepted compression levels for the zstd algorithm. ("mysqlx_zstd_max_client_compression_level")
netReadTimeout This property is required. number
The number of seconds to wait for more data from a connection before aborting the read.
netWriteTimeout This property is required. number
The number of seconds to wait for a block to be written to a connection before aborting the write.
optimizerSwitch This property is required. 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.
parserMaxMemSize This property is required. string
("parser_max_mem_size")
queryAllocBlockSize This property is required. string
("query_alloc_block_size") DEPRECATED -- variable should not be settable and will be ignored

Deprecated: The 'query_alloc_block_size' field has been deprecated and may be removed in a future version. Do not use this field.

queryPreallocSize This property is required. string
("query_prealloc_size") DEPRECATED -- variable should not be settable and will be ignored
rangeOptimizerMaxMemSize This property is required. string
The limit on memory consumption for the range optimizer. A value of 0 means “no limit.” 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.

Deprecated: The 'query_prealloc_size' field has been deprecated and may be removed in a future version. Do not use this field.

regexpTimeLimit This property is required. number
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 This property is required. string
The maximum amount of space to use for all relay logs.
replicaNetTimeout This property is required. number
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.
replicaParallelWorkers This property is required. number
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.)
replicaTypeConversions This property is required. 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.
requireSecureTransport This property is required. boolean
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.
skipNameResolve This property is required. boolean
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, “DNS Lookups and the Host Cache”.
sortBufferSize This property is required. string
Each session that must perform a sort allocates a buffer of this size.
sqlGenerateInvisiblePrimaryKey This property is required. boolean
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.
sqlMode This property is required. string
("sql_mode")
sqlRequirePrimaryKey This property is required. boolean
("sql_require_primary_key")
sqlWarnings This property is required. boolean
("sql_warnings")
tableDefinitionCache This property is required. number
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.
tableOpenCache This property is required. number
The number of open tables for all threads. Increasing this value increases the number of file descriptors that mysqld requires.
temptableMaxRam This property is required. string
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, “Internal Temporary Table Use in MySQL”.
threadPoolDedicatedListeners This property is required. 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.
threadPoolMaxTransactionsLimit This property is required. number
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 This property is required. number
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.
threadPoolSize This property is required. number
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.
threadPoolTransactionDelay This property is required. number
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.
timeZone This property is required. string
Initializes the time zone for each client that connects.
tmpTableSize This property is required. string
The maximum size of internal in-memory temporary tables. This variable does not apply to user-created MEMORY tables.
transactionIsolation This property is required. string
("transaction_isolation")
waitTimeout This property is required. number
The number of seconds the server waits for activity on a noninteractive connection before closing it.
auto_increment_increment This property is required. 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.
auto_increment_offset This property is required. 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.
autocommit This property is required. bool
("autocommit")
big_tables This property is required. bool
If enabled, the server stores all temporary tables on disk rather than in memory.
binlog_expire_logs_seconds This property is required. int
Sets the binary log expiration period in seconds. binlogExpireLogsSeconds corresponds to the MySQL binary logging system variable binlog_expire_logs_seconds.
binlog_group_commit_sync_delay This property is required. 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.
binlog_group_commit_sync_no_delay_count This property is required. 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.
binlog_row_metadata This property is required. str
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 This property is required. str
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 This property is required. 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.
block_encryption_mode This property is required. str
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.
character_set_server This property is required. str
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.
collation_server This property is required. str
The server's default collation.
completion_type This property is required. str
("completion_type")
connect_timeout This property is required. int
The number of seconds that the mysqld server waits for a connect packet before responding with Bad handshake.
connection_memory_chunk_size This property is required. int
Set the chunking size for updates to the global memory usage counter Global_connection_memory.
connection_memory_limit This property is required. str
Set the maximum amount of memory that can be used by a single user connection.
cte_max_recursion_depth This property is required. str
("cte_max_recursion_depth")
default_authentication_plugin This property is required. str
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.
explain_format This property is required. str
This variable determines the default output format used by EXPLAIN in the absence of a FORMAT option when displaying a query execution plan.
explicit_defaults_for_timestamp This property is required. 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.
foreign_key_checks This property is required. bool
("foreign_key_checks")
generated_random_password_length This property is required. int
("generated_random_password_length") DEPRECATED -- variable should not be settable and will be ignored

Deprecated: The 'generated_random_password_length' field has been deprecated and may be removed in a future version. Do not use this field.

global_connection_memory_limit This property is required. str
Set the total amount of memory that can be used by all user connections.
global_connection_memory_tracking This property is required. bool
Determines whether the MySQL server calculates Global_connection_memory.
group_concat_max_len This property is required. str
Specifies the maximum permitted result length in bytes for the GROUP_CONCAT() function.
group_replication_consistency This property is required. str
  • 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 This property is required. int
("information_schema_stats_expiry")
innodb_adaptive_hash_index This property is required. 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.
innodb_autoinc_lock_mode This property is required. int
The lock mode to use for generating auto-increment values. Permissible values are 0, 1, or 2, for traditional, consecutive, or interleaved, respectively.
innodb_buffer_pool_dump_pct This property is required. int
Specifies the percentage of the most recently used pages for each buffer pool to read out and dump.
innodb_buffer_pool_instances This property is required. int
("innodb_buffer_pool_instances")
innodb_buffer_pool_size This property is required. str
The size (in bytes) of the buffer pool, that is, the memory area where InnoDB caches table and index data.
innodb_change_buffering This property is required. str
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.
innodb_ddl_buffer_size This property is required. str
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)
innodb_ddl_threads This property is required. 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)
innodb_ft_enable_stopword This property is required. bool
("innodb_ft_enable_stopword")
innodb_ft_max_token_size This property is required. int
("innodb_ft_max_token_size")
innodb_ft_min_token_size This property is required. int
("innodb_ft_min_token_size")
innodb_ft_num_word_optimize This property is required. int
("innodb_ft_num_word_optimize")
innodb_ft_result_cache_limit This property is required. str
("innodb_ft_result_cache_limit")
innodb_ft_server_stopword_table This property is required. str
("innodb_ft_server_stopword_table")
innodb_lock_wait_timeout This property is required. int
("innodb_lock_wait_timeout")
innodb_log_writer_threads This property is required. 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.
innodb_max_purge_lag This property is required. str
The desired maximum purge lag in terms of transactions.
innodb_max_purge_lag_delay This property is required. int
The maximum delay in microseconds for the delay imposed when the innodb_max_purge_lag threshold is exceeded.
innodb_numa_interleave This property is required. 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.
innodb_online_alter_log_max_size This property is required. str
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.
innodb_redo_log_capacity This property is required. str
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.
innodb_rollback_on_timeout This property is required. 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.
innodb_sort_buffer_size This property is required. 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.
innodb_stats_persistent_sample_pages This property is required. str
The number of index pages to sample when estimating cardinality and other statistics for an indexed column, such as those calculated by ANALYZE TABLE.
innodb_stats_transient_sample_pages This property is required. str
The number of index pages to sample when estimating cardinality and other statistics for an indexed column, such as those calculated by ANALYZE TABLE.
innodb_strict_mode This property is required. bool
When you enable innodbStrictMode, the InnoDB storage engine returns errors instead of warnings for invalid or incompatible table options.
innodb_undo_log_truncate This property is required. 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.
interactive_timeout This property is required. int
The number of seconds the server waits for activity on an interactive connection before closing it.
join_buffer_size This property is required. str
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.
local_infile This property is required. 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.
long_query_time This property is required. 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.
mandatory_roles This property is required. str
("mandatory_roles")
max_allowed_packet This property is required. int
The maximum size of one packet or any generated/intermediate string.
max_binlog_cache_size This property is required. str
Sets the size of the transaction cache.
max_connect_errors This property is required. str
("max_connect_errors")
max_connections This property is required. int
("max_connections")
max_execution_time This property is required. str
("max_execution_time")
max_heap_table_size This property is required. str
This variable sets the maximum size to which user-created MEMORY tables are permitted to grow.
max_prepared_stmt_count This property is required. int
("max_prepared_stmt_count")
max_seeks_for_key This property is required. str
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, “SHOW INDEX Statement”). By setting this to a low value (say, 100), you can force MySQL to prefer indexes instead of table scans.
max_user_connections This property is required. str
The maximum number of simultaneous connections permitted to any given MySQL user account. A value of 0 (the default) means “no limit.” 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.
mysql_firewall_mode This property is required. bool
("mysql_firewall_mode")
mysql_zstd_default_compression_level This property is required. int
DEPRECATED -- typo of mysqlx_zstd_default_compression_level. variable will be ignored.

Deprecated: The 'mysql_zstd_default_compression_level' field has been deprecated and may be removed in a future version. Do not use this field.

mysqlx_connect_timeout This property is required. int
The number of seconds X Plugin waits for the first packet to be received from newly connected clients.
mysqlx_deflate_default_compression_level This property is required. int
Set the default compression level for the deflate algorithm. ("mysqlx_deflate_default_compression_level")
mysqlx_deflate_max_client_compression_level This property is required. int
Limit the upper bound of accepted compression levels for the deflate algorithm. ("mysqlx_deflate_max_client_compression_level")
mysqlx_document_id_unique_prefix This property is required. int
("mysqlx_document_id_unique_prefix") DEPRECATED -- variable should not be settable and will be ignored

Deprecated: The 'mysqlx_document_id_unique_prefix' field has been deprecated and may be removed in a future version. Do not use this field.

mysqlx_enable_hello_notice This property is required. bool
("mysqlx_enable_hello_notice") DEPRECATED -- variable should not be settable and will be ignored
mysqlx_idle_worker_thread_timeout This property is required. int
("mysqlx_idle_worker_thread_timeout") DEPRECATED -- variable should not be settable and will be ignored

Deprecated: The 'mysqlx_idle_worker_thread_timeout' field has been deprecated and may be removed in a future version. Do not use this field.

mysqlx_interactive_timeout This property is required. int
The number of seconds to wait for interactive clients to timeout.
mysqlx_lz4default_compression_level This property is required. int
Set the default compression level for the lz4 algorithm. ("mysqlx_lz4_default_compression_level")
mysqlx_lz4max_client_compression_level This property is required. int
Limit the upper bound of accepted compression levels for the lz4 algorithm. ("mysqlx_lz4_max_client_compression_level")
mysqlx_max_allowed_packet This property is required. int
The maximum size of network packets that can be received by X Plugin.
mysqlx_min_worker_threads This property is required. int
("mysqlx_min_worker_threads") DEPRECATED -- variable should not be settable and will be ignored

Deprecated: The 'mysqlx_min_worker_threads' field has been deprecated and may be removed in a future version. Do not use this field.

mysqlx_read_timeout This property is required. 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.
mysqlx_wait_timeout This property is required. int
The number of seconds that X Plugin waits for activity on a connection.
mysqlx_write_timeout This property is required. 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.
mysqlx_zstd_default_compression_level This property is required. int
Set the default compression level for the zstd algorithm. ("mysqlx_zstd_default_compression_level")
mysqlx_zstd_max_client_compression_level This property is required. int
Limit the upper bound of accepted compression levels for the zstd algorithm. ("mysqlx_zstd_max_client_compression_level")
net_read_timeout This property is required. int
The number of seconds to wait for more data from a connection before aborting the read.
net_write_timeout This property is required. int
The number of seconds to wait for a block to be written to a connection before aborting the write.
optimizer_switch This property is required. str
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.
parser_max_mem_size This property is required. str
("parser_max_mem_size")
query_alloc_block_size This property is required. str
("query_alloc_block_size") DEPRECATED -- variable should not be settable and will be ignored

Deprecated: The 'query_alloc_block_size' field has been deprecated and may be removed in a future version. Do not use this field.

query_prealloc_size This property is required. str
("query_prealloc_size") DEPRECATED -- variable should not be settable and will be ignored
range_optimizer_max_mem_size This property is required. str
The limit on memory consumption for the range optimizer. A value of 0 means “no limit.” 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.

Deprecated: The 'query_prealloc_size' field has been deprecated and may be removed in a future version. Do not use this field.

regexp_time_limit This property is required. 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)
relay_log_space_limit This property is required. str
The maximum amount of space to use for all relay logs.
replica_net_timeout This property is required. 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.
replica_parallel_workers This property is required. 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.)
replica_type_conversions This property is required. str
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.
require_secure_transport This property is required. 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.
skip_name_resolve This property is required. 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, “DNS Lookups and the Host Cache”.
sort_buffer_size This property is required. str
Each session that must perform a sort allocates a buffer of this size.
sql_generate_invisible_primary_key This property is required. 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.
sql_mode This property is required. str
("sql_mode")
sql_require_primary_key This property is required. bool
("sql_require_primary_key")
sql_warnings This property is required. bool
("sql_warnings")
table_definition_cache This property is required. 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_open_cache This property is required. int
The number of open tables for all threads. Increasing this value increases the number of file descriptors that mysqld requires.
temptable_max_ram This property is required. str
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, “Internal Temporary Table Use in MySQL”.
thread_pool_dedicated_listeners This property is required. 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.
thread_pool_max_transactions_limit This property is required. 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.
thread_pool_query_threads_per_group This property is required. 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.
thread_pool_size This property is required. 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.
thread_pool_transaction_delay This property is required. 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.
time_zone This property is required. str
Initializes the time zone for each client that connects.
tmp_table_size This property is required. str
The maximum size of internal in-memory temporary tables. This variable does not apply to user-created MEMORY tables.
transaction_isolation This property is required. str
("transaction_isolation")
wait_timeout This property is required. int
The number of seconds the server waits for activity on a noninteractive connection before closing it.
autoIncrementIncrement This property is required. Number
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.
autoIncrementOffset This property is required. Number
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.
autocommit This property is required. Boolean
("autocommit")
bigTables This property is required. Boolean
If enabled, the server stores all temporary tables on disk rather than in memory.
binlogExpireLogsSeconds This property is required. Number
Sets the binary log expiration period in seconds. binlogExpireLogsSeconds corresponds to the MySQL binary logging system variable binlog_expire_logs_seconds.
binlogGroupCommitSyncDelay This property is required. Number
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.
binlogGroupCommitSyncNoDelayCount This property is required. Number
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.
binlogRowMetadata This property is required. 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.
binlogRowValueOptions This property is required. 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 This property is required. 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.
blockEncryptionMode This property is required. 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.
characterSetServer This property is required. String
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.
collationServer This property is required. String
The server's default collation.
completionType This property is required. String
("completion_type")
connectTimeout This property is required. Number
The number of seconds that the mysqld server waits for a connect packet before responding with Bad handshake.
connectionMemoryChunkSize This property is required. Number
Set the chunking size for updates to the global memory usage counter Global_connection_memory.
connectionMemoryLimit This property is required. String
Set the maximum amount of memory that can be used by a single user connection.
cteMaxRecursionDepth This property is required. String
("cte_max_recursion_depth")
defaultAuthenticationPlugin This property is required. String
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.
explainFormat This property is required. String
This variable determines the default output format used by EXPLAIN in the absence of a FORMAT option when displaying a query execution plan.
explicitDefaultsForTimestamp This property is required. Boolean
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.
foreignKeyChecks This property is required. Boolean
("foreign_key_checks")
generatedRandomPasswordLength This property is required. Number
("generated_random_password_length") DEPRECATED -- variable should not be settable and will be ignored

Deprecated: The 'generated_random_password_length' field has been deprecated and may be removed in a future version. Do not use this field.

globalConnectionMemoryLimit This property is required. String
Set the total amount of memory that can be used by all user connections.
globalConnectionMemoryTracking This property is required. Boolean
Determines whether the MySQL server calculates Global_connection_memory.
groupConcatMaxLen This property is required. String
Specifies the maximum permitted result length in bytes for the GROUP_CONCAT() function.
groupReplicationConsistency This property is required. 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.
informationSchemaStatsExpiry This property is required. Number
("information_schema_stats_expiry")
innodbAdaptiveHashIndex This property is required. Boolean
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.
innodbAutoincLockMode This property is required. Number
The lock mode to use for generating auto-increment values. Permissible values are 0, 1, or 2, for traditional, consecutive, or interleaved, respectively.
innodbBufferPoolDumpPct This property is required. Number
Specifies the percentage of the most recently used pages for each buffer pool to read out and dump.
innodbBufferPoolInstances This property is required. Number
("innodb_buffer_pool_instances")
innodbBufferPoolSize This property is required. String
The size (in bytes) of the buffer pool, that is, the memory area where InnoDB caches table and index data.
innodbChangeBuffering This property is required. String
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.
innodbDdlBufferSize This property is required. String
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 This property is required. Number
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 This property is required. Boolean
("innodb_ft_enable_stopword")
innodbFtMaxTokenSize This property is required. Number
("innodb_ft_max_token_size")
innodbFtMinTokenSize This property is required. Number
("innodb_ft_min_token_size")
innodbFtNumWordOptimize This property is required. Number
("innodb_ft_num_word_optimize")
innodbFtResultCacheLimit This property is required. String
("innodb_ft_result_cache_limit")
innodbFtServerStopwordTable This property is required. String
("innodb_ft_server_stopword_table")
innodbLockWaitTimeout This property is required. Number
("innodb_lock_wait_timeout")
innodbLogWriterThreads This property is required. 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.
innodbMaxPurgeLag This property is required. String
The desired maximum purge lag in terms of transactions.
innodbMaxPurgeLagDelay This property is required. Number
The maximum delay in microseconds for the delay imposed when the innodb_max_purge_lag threshold is exceeded.
innodbNumaInterleave This property is required. Boolean
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.
innodbOnlineAlterLogMaxSize This property is required. String
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.
innodbRedoLogCapacity This property is required. String
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.
innodbRollbackOnTimeout This property is required. Boolean
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.
innodbSortBufferSize This property is required. Number
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.
innodbStatsPersistentSamplePages This property is required. String
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 This property is required. String
The number of index pages to sample when estimating cardinality and other statistics for an indexed column, such as those calculated by ANALYZE TABLE.
innodbStrictMode This property is required. Boolean
When you enable innodbStrictMode, the InnoDB storage engine returns errors instead of warnings for invalid or incompatible table options.
innodbUndoLogTruncate This property is required. Boolean
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.
interactiveTimeout This property is required. Number
The number of seconds the server waits for activity on an interactive connection before closing it.
joinBufferSize This property is required. String
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.
localInfile This property is required. Boolean
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.
longQueryTime This property is required. Number
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.
mandatoryRoles This property is required. String
("mandatory_roles")
maxAllowedPacket This property is required. Number
The maximum size of one packet or any generated/intermediate string.
maxBinlogCacheSize This property is required. String
Sets the size of the transaction cache.
maxConnectErrors This property is required. String
("max_connect_errors")
maxConnections This property is required. Number
("max_connections")
maxExecutionTime This property is required. String
("max_execution_time")
maxHeapTableSize This property is required. String
This variable sets the maximum size to which user-created MEMORY tables are permitted to grow.
maxPreparedStmtCount This property is required. Number
("max_prepared_stmt_count")
maxSeeksForKey This property is required. String
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, “SHOW INDEX Statement”). By setting this to a low value (say, 100), you can force MySQL to prefer indexes instead of table scans.
maxUserConnections This property is required. String
The maximum number of simultaneous connections permitted to any given MySQL user account. A value of 0 (the default) means “no limit.” 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.
mysqlFirewallMode This property is required. Boolean
("mysql_firewall_mode")
mysqlZstdDefaultCompressionLevel This property is required. Number
DEPRECATED -- typo of mysqlx_zstd_default_compression_level. variable will be ignored.

Deprecated: The 'mysql_zstd_default_compression_level' field has been deprecated and may be removed in a future version. Do not use this field.

mysqlxConnectTimeout This property is required. Number
The number of seconds X Plugin waits for the first packet to be received from newly connected clients.
mysqlxDeflateDefaultCompressionLevel This property is required. Number
Set the default compression level for the deflate algorithm. ("mysqlx_deflate_default_compression_level")
mysqlxDeflateMaxClientCompressionLevel This property is required. Number
Limit the upper bound of accepted compression levels for the deflate algorithm. ("mysqlx_deflate_max_client_compression_level")
mysqlxDocumentIdUniquePrefix This property is required. Number
("mysqlx_document_id_unique_prefix") DEPRECATED -- variable should not be settable and will be ignored

Deprecated: The 'mysqlx_document_id_unique_prefix' field has been deprecated and may be removed in a future version. Do not use this field.

mysqlxEnableHelloNotice This property is required. Boolean
("mysqlx_enable_hello_notice") DEPRECATED -- variable should not be settable and will be ignored
mysqlxIdleWorkerThreadTimeout This property is required. Number
("mysqlx_idle_worker_thread_timeout") DEPRECATED -- variable should not be settable and will be ignored

Deprecated: The 'mysqlx_idle_worker_thread_timeout' field has been deprecated and may be removed in a future version. Do not use this field.

mysqlxInteractiveTimeout This property is required. Number
The number of seconds to wait for interactive clients to timeout.
mysqlxLz4defaultCompressionLevel This property is required. Number
Set the default compression level for the lz4 algorithm. ("mysqlx_lz4_default_compression_level")
mysqlxLz4maxClientCompressionLevel This property is required. Number
Limit the upper bound of accepted compression levels for the lz4 algorithm. ("mysqlx_lz4_max_client_compression_level")
mysqlxMaxAllowedPacket This property is required. Number
The maximum size of network packets that can be received by X Plugin.
mysqlxMinWorkerThreads This property is required. Number
("mysqlx_min_worker_threads") DEPRECATED -- variable should not be settable and will be ignored

Deprecated: The 'mysqlx_min_worker_threads' field has been deprecated and may be removed in a future version. Do not use this field.

mysqlxReadTimeout This property is required. Number
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.
mysqlxWaitTimeout This property is required. Number
The number of seconds that X Plugin waits for activity on a connection.
mysqlxWriteTimeout This property is required. Number
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.
mysqlxZstdDefaultCompressionLevel This property is required. Number
Set the default compression level for the zstd algorithm. ("mysqlx_zstd_default_compression_level")
mysqlxZstdMaxClientCompressionLevel This property is required. Number
Limit the upper bound of accepted compression levels for the zstd algorithm. ("mysqlx_zstd_max_client_compression_level")
netReadTimeout This property is required. Number
The number of seconds to wait for more data from a connection before aborting the read.
netWriteTimeout This property is required. Number
The number of seconds to wait for a block to be written to a connection before aborting the write.
optimizerSwitch This property is required. 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.
parserMaxMemSize This property is required. String
("parser_max_mem_size")
queryAllocBlockSize This property is required. String
("query_alloc_block_size") DEPRECATED -- variable should not be settable and will be ignored

Deprecated: The 'query_alloc_block_size' field has been deprecated and may be removed in a future version. Do not use this field.

queryPreallocSize This property is required. String
("query_prealloc_size") DEPRECATED -- variable should not be settable and will be ignored
rangeOptimizerMaxMemSize This property is required. String
The limit on memory consumption for the range optimizer. A value of 0 means “no limit.” 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.

Deprecated: The 'query_prealloc_size' field has been deprecated and may be removed in a future version. Do not use this field.

regexpTimeLimit This property is required. Number
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 This property is required. String
The maximum amount of space to use for all relay logs.
replicaNetTimeout This property is required. Number
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.
replicaParallelWorkers This property is required. Number
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.)
replicaTypeConversions This property is required. 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.
requireSecureTransport This property is required. Boolean
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.
skipNameResolve This property is required. Boolean
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, “DNS Lookups and the Host Cache”.
sortBufferSize This property is required. String
Each session that must perform a sort allocates a buffer of this size.
sqlGenerateInvisiblePrimaryKey This property is required. Boolean
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.
sqlMode This property is required. String
("sql_mode")
sqlRequirePrimaryKey This property is required. Boolean
("sql_require_primary_key")
sqlWarnings This property is required. Boolean
("sql_warnings")
tableDefinitionCache This property is required. Number
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.
tableOpenCache This property is required. Number
The number of open tables for all threads. Increasing this value increases the number of file descriptors that mysqld requires.
temptableMaxRam This property is required. String
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, “Internal Temporary Table Use in MySQL”.
threadPoolDedicatedListeners This property is required. 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.
threadPoolMaxTransactionsLimit This property is required. Number
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 This property is required. Number
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.
threadPoolSize This property is required. Number
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.
threadPoolTransactionDelay This property is required. Number
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.
timeZone This property is required. String
Initializes the time zone for each client that connects.
tmpTableSize This property is required. String
The maximum size of internal in-memory temporary tables. This variable does not apply to user-created MEMORY tables.
transactionIsolation This property is required. String
("transaction_isolation")
waitTimeout This property is required. Number
The number of seconds the server waits for activity on a noninteractive connection before closing it.

GetMysqlConfigurationsFilter

Name This property is required. string
Values This property is required. List<string>
Regex bool
Name This property is required. string
Values This property is required. []string
Regex bool
name This property is required. String
values This property is required. List<String>
regex Boolean
name This property is required. string
values This property is required. string[]
regex boolean
name This property is required. str
values This property is required. Sequence[str]
regex bool
name This property is required. String
values This property is required. List<String>
regex Boolean

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.
Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi