Configure server parameters in Azure Database for MySQL - Flexible Server using the Azure CLI

  • Article

APPLIES TO: Azure Database for MySQL - Flexible Server

You can list, show, and update parameters for an Azure Database for MySQL Flexible Server instance by using Azure CLI, the Azure command-line utility. The server parameters are configured with the default and recommended value when you create the server.

This article describes how to list, show, and update server parameters by using the Azure CLI.

Note

Server parameters can be updated globally at the server-level, use the Azure CLI or Azure portal

Prerequisites

To step through this how-to guide, you need:

List server parameters for an Azure Database for MySQL Flexible Server instance

To list all parameters in an Azure Database for MySQL Flexible Server instance and their values, run the az mysql flexible-server parameter list command.

You can list the server parameters for the server mydemoserver.mysql.database.chinacloudapi.cn under resource group myresourcegroup.

az mysql flexible-server parameter list --resource-group myresourcegroup --server-name mydemoserver

For the definition of each of the listed parameters, see the MySQL reference section on Server System Variables.

Show server parameter details

To show details about a particular parameter for an Azure Database for MySQL Flexible Server instance, run the az mysql flexible-server parameter show command.

This example shows details of the slow_query_log server parameter for server mydemoserver.mysql.database.chinacloudapi.cn under resource group myresourcegroup.

az mysql flexible-server parameter show --name slow_query_log --resource-group myresourcegroup --server-name mydemoserver

Modify a server parameter value

You can also modify the value of a certain Azure Database for MySQL Flexible Server instance parameter, which updates the underlying configuration value for the MySQL server engine. To update the server parameter, use the az mysql flexible-server parameter set command.

To update the slow_query_log server parameter of server mydemoserver.mysql.database.chinacloudapi.cn under resource group myresourcegroup.

az mysql flexible-server parameter set --name slow_query_log --resource-group myresourcegroup --server-name mydemoserver --value ON

To update multiple server parameters like slow_query_log and audit_log_enabled of server mydemoserver.mysql.database.chinacloudapi.cn under resource group myresourcegroup.

az mysql flexible-server parameter set-batch -resource-group myresourcegroup --server-name mydemoserver --source "user-override" --args slow_query_log="ON" audit_log_enabled="ON"

If you want to reset the value of a parameter, omit the optional --value parameter, and the service applies the default value. For the example above, it would look like:

az mysql flexible-server parameter set --name slow_query_log --resource-group myresourcegroup --server-name mydemoserver

This code resets the slow_query_log to the default value OFF.

Setting non-modifiable server parameters

If the Azure Database for MySQL Flexible Server parameter you want to update is non-modifiable, you can optionally set the parameter at the connection level using init_connect. This sets the server parameters for each client connecting to the server.

Update the init_connect server parameter of server mydemoserver.mysql.database.chinacloudapi.cn under resource group myresourcegroup to set values such as character set.

az mysql flexible-server parameter set --name init_connect --resource-group myresourcegroup --server-name mydemoserver --value "SET character_set_client=utf8;SET character_set_database=utf8mb4;SET character_set_connection=latin1;SET character_set_results=latin1;"

Note

init_connect can be used to change parameters that do not require SUPER privilege(s) at the session level. To verify if you can set the parameter using init_connect, execute the set session parameter_name=YOUR_DESIRED_VALUE; command and if it errors out with Access denied; you need SUPER privileges(s) error, then you cannot set the parameter using `init_connect'.

Working with the time zone parameter

Setting the global level time zone

The global level time zone can be set using the az mysql flexible-server parameter set command.

The following command updates the time_zone server parameter of server mydemoserver.mysql.database.chinacloudapi.cn under resource group myresourcegroup to ** +08:00**.

az mysql flexible-server parameter set --name time_zone --resource-group myresourcegroup --server-name mydemoserver --value " +08:00"

Setting the session level time zone

The session level time zone can be set by running the SET time_zone command from a tool like the MySQL command line or MySQL Workbench. The example below sets the time zone to the ** +08:00** time zone.

SET time_zone = ' +08:00';

Refer to the MySQL documentation for Date and Time Functions.

Note

To change time zone at session level, Server parameter time_zone has to be updated globally to required timezone at least once, in order to update the mysql.time_zone_name table.

Next steps