Documentation Home
MySQL 8.0 Reference Manual
Related Documentation Download this Manual
PDF (US Ltr) - 37.7Mb
PDF (A4) - 37.7Mb
PDF (RPM) - 33.8Mb
HTML Download (TGZ) - 8.4Mb
HTML Download (Zip) - 8.4Mb
HTML Download (RPM) - 7.3Mb
Man Pages (TGZ) - 130.0Kb
Man Pages (Zip) - 185.6Kb
Info (Gzip) - 3.3Mb
Info (Zip) - 3.3Mb

Pre-General Availability Draft: 2018-02-21 Installation Workflow with MySQL Installer

MySQL Installer provides a wizard-like tool to install and configure new MySQL products for Windows. Unlike the initial setup, which runs only once, MySQL Installer invokes the wizard each time you download or install a new product. For first-time installations, the steps of the initial setup proceed directly into the steps of the installation.


Full permissions are granted to the user executing MySQL Installer to all generated files, such as my.ini. This does not apply to files and directories for specific products, such as the MySQL server data directory in %ProgramData% that is owned by SYSTEM.

Products installed and configured on a host follow a general pattern that might require your input during the various steps. MySQL Installer loads all selected products together using the following workflow:

  • Product download. If you installed the full (not web) MySQL Installer package, all MSI files were loaded to the Product Cache folder during the initial setup and are not downloaded again. Otherwise, the status of each product changes from Downloading to Downloaded.

  • Product installation. The status of each product in the list changes from Ready to Install to Installing to Complete. During the process, click Show Details to view the installation actions.

    If you cancel the installation at this point, the products are installed, but the server (if installed) is not yet configured. To restart the server configuration, open MySQL Installer from the Start menu and click the Reconfigure link next to the appropriate server in the dashboard.

  • Product configuration. This step applies to MySQL server and samples in most cases. The status for each item in the list should indicate, Ready to Configure. Click Next to begin the step-by-step configuration of all items in the list.

    The configuration options presented during this step depend on which version of the database you selected to install. After the installation completes, you can reconfigure MySQL server from the MySQL Installer dashboard.

  • Installation compete. This step finalizes the installation and enables you to start some applications when the installation finishes. Sandbox InnoDB Cluster Test Setup

You have two options to implement a high-availability solution when you install MySQL 5.7.17 or higher using MySQL Installer:

  • Standalone MySQL Server / Classic MySQL Replication (default)

    Select this option to begin the initial configuration of a standalone MySQL server. You can configure multiple servers with classic MySQL Replication manually or use MySQL Shell 1.0.9 or higher to configure a production InnoDB cluster.


    Existing instance ports (3310 to 3390) set for a sandbox InnoDB cluster that was created manually using MySQL Shell, will be deleted by MySQL Installer if you later run the sandbox InnoDB cluster test setup.

    For a description of the server configuration options that apply to a standalone MySQL server on Windows, see Section, “Server Configuration with MySQL Installer”.

  • Sandbox InnoDB Cluster Test Setup (for testing only)

    Select this option to create and configure sandbox InnoDB cluster instances locally for testing. You can configure a sandbox InnoDB cluster to have three, five, seven, or nine MySQL server instances. Use the Reconfigure quick action in the MySQL Installer toolbar to adjust the number of instances in the InnoDB cluster after the configuration has finished.

    Figure 2.9 Sandbox InnoDB cluster Test Setup

    MySQL Installer options for a sandbox InnoDB cluster test setup.

The sandbox InnoDB cluster, named sandboxCluster by default, is available on selected ports. After the configuration executes, click the Summary tab to view the specific ports that apply to your cluster. Sandbox InnoDB cluster configuration entries are stored in the installer_config.xml file.

You can use MySQL Installer to install MySQL Shell 1.0.9, if it is not installed. MySQL Shell enables you to manage the sandbox instances. To connect with the MySQL Shell on port 3310, execute the following command:

shell> mysqlsh root@localhost:3310

MySQL Installer also provides a wizard for configuring MySQL Router to connect to the test InnoDB cluster that was created in this step. For configuration details, see MySQL Router Configuration. To learn more about MySQL Router operations, see Routing for MySQL InnoDB cluster. Server Configuration with MySQL Installer

MySQL Installer handles the initial configuration of the MySQL server. For example:

  • It creates the configuration file (my.ini) that is used to configure the MySQL server. The values written to this file are influenced by choices you make during the installation process. Some definitions are host dependent. For example, query_cache is enabled if the host has fewer than three cores.


    Query cache was deprecated in MySQL 5.7 and removed in MySQL 8.0 (and later).

  • By default, a Windows service for the MySQL server is added.

  • Provides default installation and data paths for MySQL server. For instructions on how to change the default paths, see Section, “Setting Alternative Server Paths with MySQL Installer”.

  • It can optionally create MySQL server user accounts with configurable permissions based on general roles, such as DB Administrator, DB Designer, and Backup Admin. It optionally creates a Windows user named MysqlSys with limited privileges, which would then run the MySQL Server.

    User accounts may also be added and configured in MySQL Workbench.

  • Checking Show Advanced Options allows additional Logging Options to be set. This includes defining custom file paths for the error log, general log, slow query log (including the configuration of seconds it requires to execute a query), and the binary log.

During the configuration process, click Next to proceed to the next step or Back to return to the previous step. Click Execute at the final step to apply the server configuration.

The sections that follow describe the server configuration options that apply to MySQL server on Windows. The server version you installed will determine which steps and options you can configure.

Type and Networking
  • Server Configuration Type

    Choose the MySQL server configuration type that describes your setup. This setting defines the amount of system resources (memory) that will be assigned to your MySQL server instance.

    • Development: A machine that will host many other applications, and typically this is your personal workstation. This option configures MySQL to use the least amount of memory.

    • Server: Several other applications will be running on this machine, such as a web server. This option configures MySQL to use a medium amount of memory.

    • Dedicated: A machine that is dedicated to running the MySQL server. Because no other major applications will run on this server, such as a web server, this option configures MySQL to use the majority of available memory.

  • Connectivity

    Connectivity options control how the connection to MySQL is made. Options include:

    • TCP/IP: You may enable TCP/IP Networking here as otherwise only local host connections are allowed. Also define the Port Number and whether to open the firewall port for network access. If the port number is in use already, you will see the information icon () next to the default value and Next is disabled until you provide a new port number.

    • Named Pipe: Enable and define the pipe name, similar to using the --enable-named-pipe option.

    • Shared Memory: Enable and then define the memory name, similar to using the --shared-memory option.

  • Advanced Configuration

    Check Show Advanced Options to set additional logging options in a later step. This includes defining custom file paths for the error log, general log, slow query log (including the configuration of seconds it requires to execute a query), and the binary log.

  • MySQL Enterprise Firewall (Commercial Edition only)

    The Enable Enterprise Firewall check box is selected by default. For post-installation instructions, see MySQL Enterprise Firewall.

Accounts and Roles
  • Root Account Password

    Assigning a root password is required and you will be asked for it when performing other MySQL Installer operations. Password strength is evaluated when you repeat the password in the box provided. For descriptive information regarding password requirements or status, move your mouse pointer over the information icon () when it appears.

  • MySQL User Accounts

    Optionally, you can create additional MySQL user accounts with predefined user roles. Each predefined role, such as DB Admin, are configured with their own set of privileges. For example, the DB Admin role has more privileges than the DB Designer role. Click the Role drop-down list for a description of each role.


    If the MySQL server is installed, then you must also enter the current root password.

Windows Service

On the Windows platform, MySQL server can run as a named service managed by the operating system and be configured to start up automatically when Windows starts. Alternatively, you can configure MySQL server to run as an executable program that requires manual configuration.

  • Configure MySQL server as a Windows service (Selected by default.)

    When the default configuration option is selected, you can also select the following:

    • Start the MySQL Server at System Startup

      When selected (default), the service startup type is set to Automatic; otherwise, the startup type is set to Manual.

    • Run Windows Service as

      When Standard System Account is selected (default), the service logs on as Network Service.

      The Custom User option must have privileges to log on to Microsoft Windows as a service. The Next button will be disabled until this user is configured with the required privileges.

      A custom user is configured in Windows by searching for "local security policy" in the Start menu. In the Local Security Policy window, select Local Policies, User Rights Assignment, and then Log On As A Service to open the property dialog. Click Add User or Group to add the custom user and then click OK in each dialog to save the changes.

  • Deselect the Windows Service option

Plugins and Extensions

The Plugins and Extensions step is visible during a new installation of MySQL 5.7.12 (or higher) only. If you are upgrading from a previous MySQL version, then you need to open MySQL Installer again and select the Reconfigure MySQL server option.

  • Enable X Protocol / MySQL as a Document Store (Selected by default.)

    When the X Protocol option is selected, MySQL Installer loads and starts the X Plugin. Without the X Plugin running, X Protocol clients cannot connect to the server.

    • Port Number: 33060

      Requires an unused port. The default port number is 33060.

    • Open Firewall port for network access

      Open by default when the X Protocol is selected.

    For more information about using MySQL as a document store and the X Plugin, see Section 20.2, “Key Concepts” and Section 20.7, “X Plugin”.

Advanced Options

This step is available if the Show Advanced Configuration check box was selected during the Type and Networking step. To enable this step now, click Back to return to the Type and Networking step and select the check box.

Advanced configuration options are related to the following MySQL log files:

Apply Server Configuration

All configuration settings are applied to the MySQL server when you click Execute. Use the Configuration Steps tab to follow the progress of each action; the icon for each toggles from white to green on success. Otherwise, the process stops and displays an error message if an individual action times out. Click the Log tab to view the log.

When the installation is done and you click Finish, MySQL Installer and the installed MySQL products are added to the Microsoft Windows Start menu under the MySQL group. Opening MySQL Installer loads the dashboard where installed MySQL products are listed and other MySQL Installer operations are available. Setting Alternative Server Paths with MySQL Installer

You can change the default installation path, the data path, or both when you install MySQL server. After you have installed the server, the paths cannot be altered without removing and reinstalling the server instance.

To change paths for MySQL server

  1. Identify the MySQL server to change and display the Advanced Options link.

    1. Navigate to the Select Products and Features step by doing one of the following:

      1. If this is an initial setup, select the Custom setup type and click Next.

      2. If MySQL Installer is installed already, launch it from the Start menu and then click Add from the dashboard.

    2. Click Edit to filter the list of products, locate the server instance to be installed in the Available Products list.

    3. With the server instance selected, use the arrow to move the selected server to the Products/Features To Be Installed list.

    4. Click the server to select it. When you select the server, the Advanced Options link appears. For details, see the figure that follows.

  2. Click Advanced Options to open a dialog window with the path-setting options. After setting the path, click Next to continue with the configuration steps.

    Figure 2.10 Change MySQL Server Path

    MySQL Installer provides the Custom setup type, which enables you to change the default installation and data paths. MySQL Applications, Connectors, and Documentation

MySQL Installer provides you with a suite of tools for developing and managing business-critical applications on Windows. The suite consist of applications, connectors, documentation, and samples.

During the initial setup, choose any predetermined setup type, except Server only, to install the latest GA version of the tools. Use the Custom setup type to install an individual tool or specific version. If MySQL Installer is installed on the host already, use the Add operation to select and install tools from the MySQL Installer dashboard.

MySQL Router Configuration

MySQL Installer provides a configuration wizard that can bootstrap an installed instance of MySQL Router 2.1.3 or later to route traffic between MySQL applications and an InnoDB cluster. When configured, MySQL Router runs as a local Windows service. For detailed information about using MySQL Router with an InnoDB cluster, see Routing for MySQL InnoDB cluster.

To configure MySQL Router, do the following:

  1. Set up InnoDB cluster. For instructions on how to configure a sandbox InnoDB cluster on the local host using MySQL Installer, see Section, “Sandbox InnoDB Cluster Test Setup”. InnoDB cluster requires MySQL Server 5.7.17 or higher.

    For general InnoDB cluster information, see Chapter 22, InnoDB Cluster.

  2. Using MySQL Installer, download and install the MySQL Router application. After the installation finishes, the configuration wizard prompts you for information. Select the Configure MySQL Router for InnoDB cluster check box to begin the configuration and provide the following configuration values:

    • Hostname: localhost by default.

    • Port: The port number of the primary server in the InnoDB cluster. The default is 3310.

    • Management User: An administrative user with root-level privileges.

    • Password: The password for the management user.

    • Classic MySQL protocol connections to InnoDB cluster

      Read/Write: Set the first base port number to one that is unused (between 80 and 65532) and the wizard will select the remaining ports for you.

      The figure that follows shows an example of the MySQL Router configuration screen.

    Figure 2.11 MySQL Router Configuration

    MySQL Installer options for the MySQL Router configuration.

  3. Click Next and then Execute to apply the configuration. Click Finish to close MySQL Installer or return to the MySQL Installer dashboard.

User Comments
Sign Up Login You must be logged in to post a comment.