Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi
oci.Mysql.getMysqlConfigurations
Explore with Pulumi AI
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,
});
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)
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
})
}
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,
});
});
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());
}
}
variables:
testMysqlConfigurations:
fn::invoke:
function: oci:Mysql:getMysqlConfigurations
arguments:
compartmentId: ${compartmentId}
configurationId: ${mysqlConfigurationId}
displayName: ${mysqlConfigurationDisplayName}
shapeName: ${mysqlShapeName}
state: ${mysqlConfigurationState}
types: ${mysqlConfigurationType}
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>
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]
func GetMysqlConfigurations(ctx *Context, args *GetMysqlConfigurationsArgs, opts ...InvokeOption) (*GetMysqlConfigurationsResult, error)
func GetMysqlConfigurationsOutput(ctx *Context, args *GetMysqlConfigurationsOutputArgs, opts ...InvokeOption) GetMysqlConfigurationsResultOutput
> 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)
}
public static CompletableFuture<GetMysqlConfigurationsResult> getMysqlConfigurations(GetMysqlConfigurationsArgs args, InvokeOptions options)
public static Output<GetMysqlConfigurationsResult> getMysqlConfigurations(GetMysqlConfigurationsArgs args, InvokeOptions options)
fn::invoke:
function: oci:Mysql/getMysqlConfigurations:getMysqlConfigurations
arguments:
# arguments dictionary
The following arguments are supported:
- Compartment
Id This property is required. string - The compartment OCID.
- Configuration
Id string - The requested Configuration instance.
- Display
Name string - A filter to return only the resource matching the given display name exactly.
- Filters
Changes to this property will trigger replacement.
Mysql Configurations Filter> - Shape
Name string - The requested Shape name.
- State string
- Configuration Lifecycle State
- Types List<string>
- The requested Configuration types.
- Compartment
Id This property is required. string - The compartment OCID.
- Configuration
Id string - The requested Configuration instance.
- Display
Name string - A filter to return only the resource matching the given display name exactly.
- Filters
Changes to this property will trigger replacement.
Mysql Configurations Filter - Shape
Name string - The requested Shape name.
- State string
- Configuration Lifecycle State
- Types []string
- The requested Configuration types.
- compartment
Id This property is required. String - The compartment OCID.
- configuration
Id String - The requested Configuration instance.
- display
Name String - A filter to return only the resource matching the given display name exactly.
- filters
Changes to this property will trigger replacement.
Configurations Filter> - shape
Name String - The requested Shape name.
- state String
- Configuration Lifecycle State
- types List<String>
- The requested Configuration types.
- compartment
Id This property is required. string - The compartment OCID.
- configuration
Id string - The requested Configuration instance.
- display
Name string - A filter to return only the resource matching the given display name exactly.
- filters
Changes to this property will trigger replacement.
Mysql Configurations Filter[] - shape
Name 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.
Get Mysql Configurations Filter] - shape_
name str - The requested Shape name.
- state str
- Configuration Lifecycle State
- types Sequence[str]
- The requested Configuration types.
- compartment
Id This property is required. String - The compartment OCID.
- configuration
Id String - The requested Configuration instance.
- display
Name String - A filter to return only the resource matching the given display name exactly.
- filters
Changes to this property will trigger replacement.
- shape
Name 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:
- Compartment
Id string - OCID of the Compartment the Configuration exists in.
- Configurations
List<Get
Mysql Configurations Configuration> - The list of configurations.
- Id string
- The provider-assigned unique ID for this managed resource.
- Configuration
Id string - Display
Name string - The display name of the Configuration.
- Filters
List<Get
Mysql Configurations Filter> - Shape
Name string - The name of the associated Shape.
- State string
- The current state of the Configuration.
- Types List<string>
- The Configuration type, DEFAULT or CUSTOM.
- Compartment
Id string - OCID of the Compartment the Configuration exists in.
- Configurations
[]Get
Mysql Configurations Configuration - The list of configurations.
- Id string
- The provider-assigned unique ID for this managed resource.
- Configuration
Id string - Display
Name string - The display name of the Configuration.
- Filters
[]Get
Mysql Configurations Filter - Shape
Name 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 String - OCID of the Compartment the Configuration exists in.
- configurations
List<Get
Configurations Configuration> - The list of configurations.
- id String
- The provider-assigned unique ID for this managed resource.
- configuration
Id String - display
Name String - The display name of the Configuration.
- filters
List<Get
Configurations Filter> - shape
Name String - The name of the associated Shape.
- state String
- The current state of the Configuration.
- types List<String>
- The Configuration type, DEFAULT or CUSTOM.
- compartment
Id string - OCID of the Compartment the Configuration exists in.
- configurations
Get
Mysql Configurations Configuration[] - The list of configurations.
- id string
- The provider-assigned unique ID for this managed resource.
- configuration
Id string - display
Name string - The display name of the Configuration.
- filters
Get
Mysql Configurations Filter[] - shape
Name 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.
Get Mysql Configurations Configuration] - 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.
Get Mysql Configurations Filter] - 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.
- compartment
Id 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.
- configuration
Id String - display
Name String - The display name of the Configuration.
- filters List<Property Map>
- shape
Name 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
- Compartment
Id This property is required. string - The compartment OCID.
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.
- Display
Name This property is required. string - A filter to return only the resource matching the given display name exactly.
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.
- Init
Variables This property is required. List<GetMysql Configurations Configuration Init Variable> - 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. 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.
- Shape
Name This property is required. string - The requested Shape name.
- State
This property is required. string - Configuration Lifecycle State
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"}
- Time
Created This property is required. string - The date and time the Configuration was created, as described by RFC 3339.
- Time
Updated 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<GetMysql Configurations Configuration Variable> - User-defined service variables.
- Compartment
Id This property is required. string - The compartment OCID.
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.
- Display
Name This property is required. string - A filter to return only the resource matching the given display name exactly.
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.
- Init
Variables This property is required. []GetMysql Configurations Configuration Init Variable - 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. 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.
- Shape
Name This property is required. string - The requested Shape name.
- State
This property is required. string - Configuration Lifecycle State
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"}
- Time
Created This property is required. string - The date and time the Configuration was created, as described by RFC 3339.
- Time
Updated 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. []GetMysql Configurations Configuration Variable - User-defined service variables.
- compartment
Id This property is required. String - The compartment OCID.
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.
- display
Name This property is required. String - A filter to return only the resource matching the given display name exactly.
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.
- init
Variables This property is required. List<GetConfigurations Configuration Init Variable> - 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. 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.
- shape
Name This property is required. String - The requested Shape name.
- state
This property is required. String - Configuration Lifecycle State
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"}
- time
Created This property is required. String - The date and time the Configuration was created, as described by RFC 3339.
- time
Updated 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<GetConfigurations Configuration Variable> - User-defined service variables.
- compartment
Id This property is required. string - The compartment OCID.
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.
- display
Name This property is required. string - A filter to return only the resource matching the given display name exactly.
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.
- init
Variables This property is required. GetMysql Configurations Configuration Init Variable[] - 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. 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.
- shape
Name This property is required. string - The requested Shape name.
- state
This property is required. string - Configuration Lifecycle State
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"}
- time
Created This property is required. string - The date and time the Configuration was created, as described by RFC 3339.
- time
Updated 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. GetMysql Configurations Configuration Variable[] - User-defined service variables.
- compartment_
id This property is required. str - The compartment OCID.
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.
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.Get Mysql Configurations Configuration Init Variable] - 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
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.Get Mysql Configurations Configuration Variable] - User-defined service variables.
- compartment
Id This property is required. String - The compartment OCID.
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.
- display
Name This property is required. String - A filter to return only the resource matching the given display name exactly.
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.
- init
Variables 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.
- parent
Configuration Id 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.
- shape
Name This property is required. String - The requested Shape name.
- state
This property is required. String - Configuration Lifecycle State
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"}
- time
Created This property is required. String - The date and time the Configuration was created, as described by RFC 3339.
- time
Updated 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
- Lower
Case Table Names 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. 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. 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. 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).
- lower
Case Table Names 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
- 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. string - Configures the amount of table metadata added to the binary log when using row-based logging. binlogRowMetadata corresponds to the MySQL binary logging system variable binlog_row_metadata.
- Binlog
Row Value Options 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.
- 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. 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.
- Character
Set Server 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.
- Collation
Server This property is required. string - The server's default collation.
- Completion
Type This property is required. string - ("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. string - Set the maximum amount of memory that can be used by a single user connection.
- Cte
Max Recursion Depth This property is required. string - ("cte_max_recursion_depth")
- Default
Authentication Plugin 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.
- Explain
Format 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.
- 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
- Global
Connection Memory Limit This property is required. string - 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. string - Specifies the maximum permitted result length in bytes for the GROUP_CONCAT() function.
- Group
Replication Consistency 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.
- 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. string - 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. 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.
- Innodb
Ddl Buffer Size 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)
- 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. string - ("innodb_ft_result_cache_limit")
- Innodb
Ft Server Stopword Table This property is required. string - ("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. string - 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. 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.
- Innodb
Redo Log Capacity 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.
- 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. 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.
- Innodb
Stats Transient Sample Pages 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.
- 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. 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.
- 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. string - ("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. string - Sets the size of the transaction cache.
- Max
Connect Errors This property is required. string - ("max_connect_errors")
- Max
Connections This property is required. int - ("max_connections")
- Max
Execution Time This property is required. string - ("max_execution_time")
- Max
Heap Table Size This property is required. string - 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. 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.
- Max
User Connections 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.
- 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.
- 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
- 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
- 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
- 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. 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.
- Parser
Max Mem Size This property is required. string - ("parser_max_mem_size")
- Query
Alloc Block Size This property is required. string - ("query_alloc_block_size") DEPRECATED -- variable should not be settable and will be ignored
- Query
Prealloc Size This property is required. string - ("query_prealloc_size") DEPRECATED -- variable should not be settable and will be ignored
- Range
Optimizer Max Mem Size 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.
- 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. string - 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. 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.
- 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. string - 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. string - ("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. 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”.
- 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. string - Initializes the time zone for each client that connects.
- Tmp
Table Size This property is required. string - 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. string - ("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.
- 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. string - Configures the amount of table metadata added to the binary log when using row-based logging. binlogRowMetadata corresponds to the MySQL binary logging system variable binlog_row_metadata.
- Binlog
Row Value Options 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.
- 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. 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.
- Character
Set Server 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.
- Collation
Server This property is required. string - The server's default collation.
- Completion
Type This property is required. string - ("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. string - Set the maximum amount of memory that can be used by a single user connection.
- Cte
Max Recursion Depth This property is required. string - ("cte_max_recursion_depth")
- Default
Authentication Plugin 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.
- Explain
Format 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.
- 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
- Global
Connection Memory Limit This property is required. string - 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. string - Specifies the maximum permitted result length in bytes for the GROUP_CONCAT() function.
- Group
Replication Consistency 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.
- 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. string - 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. 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.
- Innodb
Ddl Buffer Size 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)
- 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. string - ("innodb_ft_result_cache_limit")
- Innodb
Ft Server Stopword Table This property is required. string - ("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. string - 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. 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.
- Innodb
Redo Log Capacity 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.
- 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. 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.
- Innodb
Stats Transient Sample Pages 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.
- 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. 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.
- 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. string - ("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. string - Sets the size of the transaction cache.
- Max
Connect Errors This property is required. string - ("max_connect_errors")
- Max
Connections This property is required. int - ("max_connections")
- Max
Execution Time This property is required. string - ("max_execution_time")
- Max
Heap Table Size This property is required. string - 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. 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.
- Max
User Connections 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.
- 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.
- 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
- 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
- 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
- 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. 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.
- Parser
Max Mem Size This property is required. string - ("parser_max_mem_size")
- Query
Alloc Block Size This property is required. string - ("query_alloc_block_size") DEPRECATED -- variable should not be settable and will be ignored
- Query
Prealloc Size This property is required. string - ("query_prealloc_size") DEPRECATED -- variable should not be settable and will be ignored
- Range
Optimizer Max Mem Size 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.
- 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. string - 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. 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.
- 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. string - 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. string - ("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. 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”.
- 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. string - Initializes the time zone for each client that connects.
- Tmp
Table Size This property is required. string - 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. string - ("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.
- auto
Increment Increment 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.
- auto
Increment Offset 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")
- big
Tables This property is required. Boolean - If enabled, the server stores all temporary tables on disk rather than in memory.
- binlog
Expire Logs Seconds 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.
- binlog
Group Commit Sync Delay 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.
- binlog
Group Commit Sync No Delay Count 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.
- binlog
Row Metadata 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.
- binlog
Row Value Options 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.
- binlog
Transaction Compression 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.
- block
Encryption Mode 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.
- character
Set Server 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.
- collation
Server This property is required. String - The server's default collation.
- completion
Type This property is required. String - ("completion_type")
- connect
Timeout This property is required. Integer - 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. Integer - Set the chunking size for updates to the global memory usage counter Global_connection_memory.
- connection
Memory Limit This property is required. String - Set the maximum amount of memory that can be used by a single user connection.
- cte
Max Recursion Depth This property is required. String - ("cte_max_recursion_depth")
- default
Authentication Plugin 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.
- explain
Format 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.
- explicit
Defaults For Timestamp 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.
- foreign
Key Checks This property is required. Boolean - ("foreign_key_checks")
- generated
Random Password Length This property is required. Integer - ("generated_random_password_length") DEPRECATED -- variable should not be settable and will be ignored
- global
Connection Memory Limit This property is required. String - Set the total amount of memory that can be used by all user connections.
- global
Connection Memory Tracking This property is required. Boolean - Determines whether the MySQL server calculates Global_connection_memory.
- group
Concat Max Len This property is required. String - Specifies the maximum permitted result length in bytes for the GROUP_CONCAT() function.
- group
Replication Consistency 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.
- information
Schema Stats Expiry This property is required. Integer - ("information_schema_stats_expiry")
- innodb
Adaptive Hash Index 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.
- innodb
Autoinc Lock Mode 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.
- innodb
Buffer Pool Dump Pct This property is required. Integer - 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. Integer - ("innodb_buffer_pool_instances")
- innodb
Buffer Pool Size 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.
- innodb
Change Buffering 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.
- innodb
Ddl Buffer Size 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)
- innodb
Ddl Threads 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)
- innodb
Ft Enable Stopword This property is required. Boolean - ("innodb_ft_enable_stopword")
- innodb
Ft Max Token Size This property is required. Integer - ("innodb_ft_max_token_size")
- innodb
Ft Min Token Size This property is required. Integer - ("innodb_ft_min_token_size")
- innodb
Ft Num Word Optimize This property is required. Integer - ("innodb_ft_num_word_optimize")
- innodb
Ft Result Cache Limit This property is required. String - ("innodb_ft_result_cache_limit")
- innodb
Ft Server Stopword Table This property is required. String - ("innodb_ft_server_stopword_table")
- innodb
Lock Wait Timeout This property is required. Integer - ("innodb_lock_wait_timeout")
- innodb
Log Writer Threads 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.
- innodb
Max Purge Lag This property is required. String - The desired maximum purge lag in terms of transactions.
- innodb
Max Purge Lag Delay This property is required. Integer - 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. 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.
- innodb
Online Alter Log Max Size 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.
- innodb
Redo Log Capacity 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.
- innodb
Rollback On Timeout 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.
- innodb
Sort Buffer Size 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.
- innodb
Stats Persistent Sample Pages 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.
- innodb
Stats Transient Sample Pages 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.
- innodb
Strict Mode This property is required. Boolean - 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. 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.
- interactive
Timeout This property is required. Integer - The number of seconds the server waits for activity on an interactive connection before closing it.
- join
Buffer Size 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.
- local
Infile 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.
- long
Query Time 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.
- mandatory
Roles This property is required. String - ("mandatory_roles")
- max
Allowed Packet This property is required. Integer - The maximum size of one packet or any generated/intermediate string.
- max
Binlog Cache Size This property is required. String - Sets the size of the transaction cache.
- max
Connect Errors This property is required. String - ("max_connect_errors")
- max
Connections This property is required. Integer - ("max_connections")
- max
Execution Time This property is required. String - ("max_execution_time")
- max
Heap Table Size This property is required. String - This variable sets the maximum size to which user-created MEMORY tables are permitted to grow.
- max
Prepared Stmt Count This property is required. Integer - ("max_prepared_stmt_count")
- max
Seeks For Key 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.
- max
User Connections 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.
- mysql
Firewall Mode This property is required. Boolean - ("mysql_firewall_mode")
- mysql
Zstd Default Compression Level This property is required. Integer - DEPRECATED -- typo of mysqlx_zstd_default_compression_level. variable will be ignored.
- mysqlx
Connect Timeout This property is required. Integer - 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. Integer - Set the default compression level for the deflate algorithm. ("mysqlx_deflate_default_compression_level")
- mysqlx
Deflate Max Client Compression Level This property is required. Integer - 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. Integer - ("mysqlx_document_id_unique_prefix") DEPRECATED -- variable should not be settable and will be ignored
- mysqlx
Enable Hello Notice This property is required. Boolean - ("mysqlx_enable_hello_notice") DEPRECATED -- variable should not be settable and will be ignored
- mysqlx
Idle Worker Thread Timeout This property is required. Integer - ("mysqlx_idle_worker_thread_timeout") DEPRECATED -- variable should not be settable and will be ignored
- mysqlx
Interactive Timeout This property is required. Integer - The number of seconds to wait for interactive clients to timeout.
- mysqlx
Lz4default Compression Level This property is required. Integer - Set the default compression level for the lz4 algorithm. ("mysqlx_lz4_default_compression_level")
- mysqlx
Lz4max Client Compression Level This property is required. Integer - 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. Integer - The maximum size of network packets that can be received by X Plugin.
- mysqlx
Min Worker Threads This property is required. Integer - ("mysqlx_min_worker_threads") DEPRECATED -- variable should not be settable and will be ignored
- mysqlx
Read Timeout 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.
- mysqlx
Wait Timeout This property is required. Integer - The number of seconds that X Plugin waits for activity on a connection.
- mysqlx
Write Timeout 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.
- mysqlx
Zstd Default Compression Level This property is required. Integer - Set the default compression level for the zstd algorithm. ("mysqlx_zstd_default_compression_level")
- mysqlx
Zstd Max Client Compression Level This property is required. Integer - 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. Integer - The number of seconds to wait for more data from a connection before aborting the read.
- net
Write Timeout This property is required. Integer - 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. 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.
- parser
Max Mem Size This property is required. String - ("parser_max_mem_size")
- query
Alloc Block Size This property is required. String - ("query_alloc_block_size") DEPRECATED -- variable should not be settable and will be ignored
- query
Prealloc Size This property is required. String - ("query_prealloc_size") DEPRECATED -- variable should not be settable and will be ignored
- range
Optimizer Max Mem Size 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.
- regexp
Time Limit 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)
- relay
Log Space Limit This property is required. String - The maximum amount of space to use for all relay logs.
- replica
Net Timeout 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.
- replica
Parallel Workers 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.)
- replica
Type Conversions 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.
- require
Secure Transport 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.
- skip
Name Resolve 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”.
- sort
Buffer Size This property is required. String - Each session that must perform a sort allocates a buffer of this size.
- sql
Generate Invisible Primary Key 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.
- sql
Mode This property is required. String - ("sql_mode")
- sql
Require Primary Key This property is required. Boolean - ("sql_require_primary_key")
- sql
Warnings This property is required. Boolean - ("sql_warnings")
- table
Definition Cache 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.
- table
Open Cache 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.
- temptable
Max Ram 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”.
- thread
Pool Dedicated Listeners 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.
- thread
Pool Max Transactions Limit 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.
- thread
Pool Query Threads Per Group 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.
- thread
Pool Size 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.
- thread
Pool Transaction Delay 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.
- time
Zone This property is required. String - Initializes the time zone for each client that connects.
- tmp
Table Size This property is required. String - 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. String - ("transaction_isolation")
- wait
Timeout This property is required. Integer - The number of seconds the server waits for activity on a noninteractive connection before closing it.
- auto
Increment Increment 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.
- auto
Increment Offset 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")
- big
Tables This property is required. boolean - If enabled, the server stores all temporary tables on disk rather than in memory.
- binlog
Expire Logs Seconds 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.
- binlog
Group Commit Sync Delay 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.
- binlog
Group Commit Sync No Delay Count 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.
- binlog
Row Metadata 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.
- binlog
Row Value Options 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.
- binlog
Transaction Compression 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.
- block
Encryption Mode 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.
- character
Set Server 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.
- collation
Server This property is required. string - The server's default collation.
- completion
Type This property is required. string - ("completion_type")
- connect
Timeout This property is required. number - 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. number - Set the chunking size for updates to the global memory usage counter Global_connection_memory.
- connection
Memory Limit This property is required. string - Set the maximum amount of memory that can be used by a single user connection.
- cte
Max Recursion Depth This property is required. string - ("cte_max_recursion_depth")
- default
Authentication Plugin 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.
- explain
Format 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.
- explicit
Defaults For Timestamp 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.
- foreign
Key Checks This property is required. boolean - ("foreign_key_checks")
- generated
Random Password Length This property is required. number - ("generated_random_password_length") DEPRECATED -- variable should not be settable and will be ignored
- global
Connection Memory Limit This property is required. string - Set the total amount of memory that can be used by all user connections.
- global
Connection Memory Tracking This property is required. boolean - Determines whether the MySQL server calculates Global_connection_memory.
- group
Concat Max Len This property is required. string - Specifies the maximum permitted result length in bytes for the GROUP_CONCAT() function.
- group
Replication Consistency 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.
- information
Schema Stats Expiry This property is required. number - ("information_schema_stats_expiry")
- innodb
Adaptive Hash Index 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.
- innodb
Autoinc Lock Mode 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.
- innodb
Buffer Pool Dump Pct This property is required. number - 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. number - ("innodb_buffer_pool_instances")
- innodb
Buffer Pool Size 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.
- innodb
Change Buffering 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.
- innodb
Ddl Buffer Size 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)
- innodb
Ddl Threads 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)
- innodb
Ft Enable Stopword This property is required. boolean - ("innodb_ft_enable_stopword")
- innodb
Ft Max Token Size This property is required. number - ("innodb_ft_max_token_size")
- innodb
Ft Min Token Size This property is required. number - ("innodb_ft_min_token_size")
- innodb
Ft Num Word Optimize This property is required. number - ("innodb_ft_num_word_optimize")
- innodb
Ft Result Cache Limit This property is required. string - ("innodb_ft_result_cache_limit")
- innodb
Ft Server Stopword Table This property is required. string - ("innodb_ft_server_stopword_table")
- innodb
Lock Wait Timeout This property is required. number - ("innodb_lock_wait_timeout")
- innodb
Log Writer Threads 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.
- innodb
Max Purge Lag This property is required. string - The desired maximum purge lag in terms of transactions.
- innodb
Max Purge Lag Delay This property is required. number - 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. 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.
- innodb
Online Alter Log Max Size 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.
- innodb
Redo Log Capacity 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.
- innodb
Rollback On Timeout 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.
- innodb
Sort Buffer Size 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.
- innodb
Stats Persistent Sample Pages 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.
- innodb
Stats Transient Sample Pages 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.
- innodb
Strict Mode This property is required. boolean - 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. 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.
- interactive
Timeout This property is required. number - The number of seconds the server waits for activity on an interactive connection before closing it.
- join
Buffer Size 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.
- local
Infile 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.
- long
Query Time 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.
- mandatory
Roles This property is required. string - ("mandatory_roles")
- max
Allowed Packet This property is required. number - The maximum size of one packet or any generated/intermediate string.
- max
Binlog Cache Size This property is required. string - Sets the size of the transaction cache.
- max
Connect Errors This property is required. string - ("max_connect_errors")
- max
Connections This property is required. number - ("max_connections")
- max
Execution Time This property is required. string - ("max_execution_time")
- max
Heap Table Size This property is required. string - This variable sets the maximum size to which user-created MEMORY tables are permitted to grow.
- max
Prepared Stmt Count This property is required. number - ("max_prepared_stmt_count")
- max
Seeks For Key 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.
- max
User Connections 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.
- mysql
Firewall Mode This property is required. boolean - ("mysql_firewall_mode")
- mysql
Zstd Default Compression Level This property is required. number - DEPRECATED -- typo of mysqlx_zstd_default_compression_level. variable will be ignored.
- mysqlx
Connect Timeout This property is required. number - 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. number - Set the default compression level for the deflate algorithm. ("mysqlx_deflate_default_compression_level")
- mysqlx
Deflate Max Client Compression Level This property is required. number - 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. number - ("mysqlx_document_id_unique_prefix") DEPRECATED -- variable should not be settable and will be ignored
- mysqlx
Enable Hello Notice This property is required. boolean - ("mysqlx_enable_hello_notice") DEPRECATED -- variable should not be settable and will be ignored
- mysqlx
Idle Worker Thread Timeout This property is required. number - ("mysqlx_idle_worker_thread_timeout") DEPRECATED -- variable should not be settable and will be ignored
- mysqlx
Interactive Timeout This property is required. number - The number of seconds to wait for interactive clients to timeout.
- mysqlx
Lz4default Compression Level This property is required. number - Set the default compression level for the lz4 algorithm. ("mysqlx_lz4_default_compression_level")
- mysqlx
Lz4max Client Compression Level This property is required. number - 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. number - The maximum size of network packets that can be received by X Plugin.
- mysqlx
Min Worker Threads This property is required. number - ("mysqlx_min_worker_threads") DEPRECATED -- variable should not be settable and will be ignored
- mysqlx
Read Timeout 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.
- mysqlx
Wait Timeout This property is required. number - The number of seconds that X Plugin waits for activity on a connection.
- mysqlx
Write Timeout 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.
- mysqlx
Zstd Default Compression Level This property is required. number - Set the default compression level for the zstd algorithm. ("mysqlx_zstd_default_compression_level")
- mysqlx
Zstd Max Client Compression Level This property is required. number - 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. number - The number of seconds to wait for more data from a connection before aborting the read.
- net
Write Timeout This property is required. number - 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. 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.
- parser
Max Mem Size This property is required. string - ("parser_max_mem_size")
- query
Alloc Block Size This property is required. string - ("query_alloc_block_size") DEPRECATED -- variable should not be settable and will be ignored
- query
Prealloc Size This property is required. string - ("query_prealloc_size") DEPRECATED -- variable should not be settable and will be ignored
- range
Optimizer Max Mem Size 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.
- regexp
Time Limit 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)
- relay
Log Space Limit This property is required. string - The maximum amount of space to use for all relay logs.
- replica
Net Timeout 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.
- replica
Parallel Workers 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.)
- replica
Type Conversions 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.
- require
Secure Transport 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.
- skip
Name Resolve 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”.
- sort
Buffer Size This property is required. string - Each session that must perform a sort allocates a buffer of this size.
- sql
Generate Invisible Primary Key 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.
- sql
Mode This property is required. string - ("sql_mode")
- sql
Require Primary Key This property is required. boolean - ("sql_require_primary_key")
- sql
Warnings This property is required. boolean - ("sql_warnings")
- table
Definition Cache 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.
- table
Open Cache 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.
- temptable
Max Ram 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”.
- thread
Pool Dedicated Listeners 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.
- thread
Pool Max Transactions Limit 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.
- thread
Pool Query Threads Per Group 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.
- thread
Pool Size 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.
- thread
Pool Transaction Delay 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.
- time
Zone This property is required. string - Initializes the time zone for each client that connects.
- tmp
Table Size This property is required. string - 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. string - ("transaction_isolation")
- wait
Timeout 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
- 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.
- 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
- 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
- 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
- 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
- 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.
- 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.
- auto
Increment Increment 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.
- auto
Increment Offset 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")
- big
Tables This property is required. Boolean - If enabled, the server stores all temporary tables on disk rather than in memory.
- binlog
Expire Logs Seconds 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.
- binlog
Group Commit Sync Delay 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.
- binlog
Group Commit Sync No Delay Count 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.
- binlog
Row Metadata 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.
- binlog
Row Value Options 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.
- binlog
Transaction Compression 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.
- block
Encryption Mode 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.
- character
Set Server 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.
- collation
Server This property is required. String - The server's default collation.
- completion
Type This property is required. String - ("completion_type")
- connect
Timeout This property is required. Number - 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. Number - Set the chunking size for updates to the global memory usage counter Global_connection_memory.
- connection
Memory Limit This property is required. String - Set the maximum amount of memory that can be used by a single user connection.
- cte
Max Recursion Depth This property is required. String - ("cte_max_recursion_depth")
- default
Authentication Plugin 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.
- explain
Format 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.
- explicit
Defaults For Timestamp 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.
- foreign
Key Checks This property is required. Boolean - ("foreign_key_checks")
- generated
Random Password Length This property is required. Number - ("generated_random_password_length") DEPRECATED -- variable should not be settable and will be ignored
- global
Connection Memory Limit This property is required. String - Set the total amount of memory that can be used by all user connections.
- global
Connection Memory Tracking This property is required. Boolean - Determines whether the MySQL server calculates Global_connection_memory.
- group
Concat Max Len This property is required. String - Specifies the maximum permitted result length in bytes for the GROUP_CONCAT() function.
- group
Replication Consistency 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.
- information
Schema Stats Expiry This property is required. Number - ("information_schema_stats_expiry")
- innodb
Adaptive Hash Index 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.
- innodb
Autoinc Lock Mode 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.
- innodb
Buffer Pool Dump Pct This property is required. Number - 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. Number - ("innodb_buffer_pool_instances")
- innodb
Buffer Pool Size 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.
- innodb
Change Buffering 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.
- innodb
Ddl Buffer Size 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)
- innodb
Ddl Threads 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)
- innodb
Ft Enable Stopword This property is required. Boolean - ("innodb_ft_enable_stopword")
- innodb
Ft Max Token Size This property is required. Number - ("innodb_ft_max_token_size")
- innodb
Ft Min Token Size This property is required. Number - ("innodb_ft_min_token_size")
- innodb
Ft Num Word Optimize This property is required. Number - ("innodb_ft_num_word_optimize")
- innodb
Ft Result Cache Limit This property is required. String - ("innodb_ft_result_cache_limit")
- innodb
Ft Server Stopword Table This property is required. String - ("innodb_ft_server_stopword_table")
- innodb
Lock Wait Timeout This property is required. Number - ("innodb_lock_wait_timeout")
- innodb
Log Writer Threads 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.
- innodb
Max Purge Lag This property is required. String - The desired maximum purge lag in terms of transactions.
- innodb
Max Purge Lag Delay This property is required. Number - 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. 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.
- innodb
Online Alter Log Max Size 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.
- innodb
Redo Log Capacity 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.
- innodb
Rollback On Timeout 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.
- innodb
Sort Buffer Size 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.
- innodb
Stats Persistent Sample Pages 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.
- innodb
Stats Transient Sample Pages 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.
- innodb
Strict Mode This property is required. Boolean - 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. 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.
- interactive
Timeout This property is required. Number - The number of seconds the server waits for activity on an interactive connection before closing it.
- join
Buffer Size 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.
- local
Infile 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.
- long
Query Time 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.
- mandatory
Roles This property is required. String - ("mandatory_roles")
- max
Allowed Packet This property is required. Number - The maximum size of one packet or any generated/intermediate string.
- max
Binlog Cache Size This property is required. String - Sets the size of the transaction cache.
- max
Connect Errors This property is required. String - ("max_connect_errors")
- max
Connections This property is required. Number - ("max_connections")
- max
Execution Time This property is required. String - ("max_execution_time")
- max
Heap Table Size This property is required. String - This variable sets the maximum size to which user-created MEMORY tables are permitted to grow.
- max
Prepared Stmt Count This property is required. Number - ("max_prepared_stmt_count")
- max
Seeks For Key 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.
- max
User Connections 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.
- mysql
Firewall Mode This property is required. Boolean - ("mysql_firewall_mode")
- mysql
Zstd Default Compression Level This property is required. Number - DEPRECATED -- typo of mysqlx_zstd_default_compression_level. variable will be ignored.
- mysqlx
Connect Timeout This property is required. Number - 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. Number - Set the default compression level for the deflate algorithm. ("mysqlx_deflate_default_compression_level")
- mysqlx
Deflate Max Client Compression Level This property is required. Number - 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. Number - ("mysqlx_document_id_unique_prefix") DEPRECATED -- variable should not be settable and will be ignored
- mysqlx
Enable Hello Notice This property is required. Boolean - ("mysqlx_enable_hello_notice") DEPRECATED -- variable should not be settable and will be ignored
- mysqlx
Idle Worker Thread Timeout This property is required. Number - ("mysqlx_idle_worker_thread_timeout") DEPRECATED -- variable should not be settable and will be ignored
- mysqlx
Interactive Timeout This property is required. Number - The number of seconds to wait for interactive clients to timeout.
- mysqlx
Lz4default Compression Level This property is required. Number - Set the default compression level for the lz4 algorithm. ("mysqlx_lz4_default_compression_level")
- mysqlx
Lz4max Client Compression Level This property is required. Number - 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. Number - The maximum size of network packets that can be received by X Plugin.
- mysqlx
Min Worker Threads This property is required. Number - ("mysqlx_min_worker_threads") DEPRECATED -- variable should not be settable and will be ignored
- mysqlx
Read Timeout 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.
- mysqlx
Wait Timeout This property is required. Number - The number of seconds that X Plugin waits for activity on a connection.
- mysqlx
Write Timeout 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.
- mysqlx
Zstd Default Compression Level This property is required. Number - Set the default compression level for the zstd algorithm. ("mysqlx_zstd_default_compression_level")
- mysqlx
Zstd Max Client Compression Level This property is required. Number - 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. Number - The number of seconds to wait for more data from a connection before aborting the read.
- net
Write Timeout This property is required. Number - 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. 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.
- parser
Max Mem Size This property is required. String - ("parser_max_mem_size")
- query
Alloc Block Size This property is required. String - ("query_alloc_block_size") DEPRECATED -- variable should not be settable and will be ignored
- query
Prealloc Size This property is required. String - ("query_prealloc_size") DEPRECATED -- variable should not be settable and will be ignored
- range
Optimizer Max Mem Size 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.
- regexp
Time Limit 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)
- relay
Log Space Limit This property is required. String - The maximum amount of space to use for all relay logs.
- replica
Net Timeout 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.
- replica
Parallel Workers 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.)
- replica
Type Conversions 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.
- require
Secure Transport 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.
- skip
Name Resolve 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”.
- sort
Buffer Size This property is required. String - Each session that must perform a sort allocates a buffer of this size.
- sql
Generate Invisible Primary Key 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.
- sql
Mode This property is required. String - ("sql_mode")
- sql
Require Primary Key This property is required. Boolean - ("sql_require_primary_key")
- sql
Warnings This property is required. Boolean - ("sql_warnings")
- table
Definition Cache 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.
- table
Open Cache 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.
- temptable
Max Ram 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”.
- thread
Pool Dedicated Listeners 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.
- thread
Pool Max Transactions Limit 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.
- thread
Pool Query Threads Per Group 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.
- thread
Pool Size 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.
- thread
Pool Transaction Delay 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.
- time
Zone This property is required. String - Initializes the time zone for each client that connects.
- tmp
Table Size This property is required. String - 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. String - ("transaction_isolation")
- wait
Timeout This property is required. Number - The number of seconds the server waits for activity on a noninteractive connection before closing it.
GetMysqlConfigurationsFilter
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.