MySQL Installer Guide

Abstract

This document describes MySQL Installer, an application that simplifies the installation and updating process for a wide range of MySQL products, including MySQL Notifier, MySQL Workbench, and MySQL for Excel.

For notes detailing the changes in each release of MySQL Installer, see MySQL Installer Release Notes.

For legal information, see the Legal Notices.

For help with using MySQL, please visit either the MySQL Forums or MySQL Mailing Lists, where you can discuss your issues with other MySQL users.

For additional documentation on MySQL products, including translations of the documentation into other languages, and downloadable versions in variety of formats, including HTML and PDF formats, see the MySQL Documentation Library.

Licensing information.  This product may include third-party software, used under license. If you are using a Commercial release of MySQL Installer, see this document for licensing information, including licensing information relating to third-party software that may be included in this Commercial release. If you are using a Community release of MySQL Installer, see this document for licensing information, including licensing information relating to third-party software that may be included in this Community release.

Document generated on: 2016-05-31 (revision: 47872)

Preface and Legal Notices

This document describes MySQL Installer, an application that simplifies the installation and updating process for a wide range of MySQL products, including MySQL Notifier, MySQL Workbench, and MySQL for Excel.

Legal Notices

Copyright © 1997, 2016, Oracle and/or its affiliates. All rights reserved.

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle Support

Oracle customers that have purchased support have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.

This documentation is NOT distributed under a GPL license. Use of this documentation is subject to the following terms:

You may create a printed copy of this documentation solely for your own personal use. Conversion to other formats is allowed as long as the actual content is not altered or edited in any way. You shall not publish or distribute this documentation in any form or on any media, except if you distribute the documentation in a manner similar to how Oracle disseminates it (that is, electronically for download on a Web site with the software) or on a CD-ROM or similar medium, provided however that the documentation is disseminated together with the software on the same medium. Any other use, such as any dissemination of printed copies or use of this documentation, in whole or in part, in another publication, requires the prior written consent from an authorized representative of Oracle. Oracle and/or its affiliates reserve any and all rights to this documentation not expressly granted above.

Chapter 1 Installing MySQL on Microsoft Windows Using MySQL Installer

MySQL Installer is an application that manages MySQL products on Microsoft Windows. It installs, updates, removes, and configures MySQL products, and remains on the system as its own application. MySQL Installer is only available for Microsoft Windows, and includes both GUI and command-line interfaces.

The supported MySQL products include:

MySQL Server (one or multiple versions on the same system)

MySQL Workbench

MySQL Connectors (.Net / Python / ODBC / Java / C / C++)

MySQL Notifier

MySQL for Excel

MySQL for Visual Studio

MySQL Utilities and MySQL Fabric

MySQL Samples and Examples

MySQL Documentation

MySQL Installer is also installed and remains on the system as its own application, that is used to install additional MySQL products, and also to update and configure existing MySQL products

The Enterprise edition installs the Enterprise versions of the above products, and also includes MySQL Enterprise Backup and MySQL Enterprise Firewall

Installer package types

Full: Bundles all of the MySQL products (including the MySQL server). The file size is over 300MB, and its name has the form mysql-installer-community-VERSION.N.msi where VERSION is the MySQL Server version number such as 5.7 and N is the package number, which begins at 0.

Web: Only contains the Installer and configuration files, and it downloads the MySQL products you choose to install. The size of this file is about 2MB; the name of the file has the form mysql-installer-community-web-VERSION.N.msi where VERSION is the MySQL Server version number such as 5.7 and N is the package number, which begins at 0.

Updates: MySQL Installer can upgrade itself, so an additional download is not requires to update MySQL Installer.

Installer editions

Community edition: Downloadable at http://dev.mysql.com/downloads/installer/. It installs the community edition of all MySQL products.

Commercial edition: Downloadable at either My Oracle Support (MOS) or https://edelivery.oracle.com/. It installs the commercial version of all MySQL products, including Workbench SE/EE, MySQL Enterprise Backup, and MySQL Enterprise Firewall. It also integrates with your MOS account.

Note

Entering your MOS credentials is optional when installing bundled MySQL products, but your credentials are required when choosing non-bundled MySQL products that MySQL Installer must download.

For notes detailing the changes in each release of MySQL Installer, see MySQL Installer Release Notes.

MySQL Installer is compatible with pre-existing installations, and adds them to its list of installed components. While the standard MySQL Installer is bundled with a specific version of MySQL server, a single MySQL Installer instance can install and manage multiple MySQL server versions. For example, a single MySQL Installer instance can install (and update) versions 5.5, 5.6, and 5.7 on the same host.

Note

A single host can not have both community and commercial editions of MySQL server installed. For example, if you want both MySQL Server 5.6 and 5.7 installed on a single host, both must be the same edition.

MySQL Installer handles the initial configuration and set up of the applications. 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.

Note

Some definitions are host dependent. For example, query_cache is enabled if the host has fewer than three cores.

It can optionally import example databases.

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

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.

MySQL Installer can optionally check for updated components and download them for you.

Chapter 2 MySQL Installer GUI

Table of Contents

2.1 MySQL Product Catalog

2.2 Remove MySQL Products

2.3 Alter MySQL Products

Installing MySQL Installer adds a link to the Start menu under the MySQL group. Click Start, All Programs MySQL, MySQL Installer to reload the MySQL Installer GUI.

Note

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.

MySQL Installer requires you to accept the license agreement before it will install MySQL products.

Figure 2.1 MySQL Installer - License Agreement

Installing New Packages

Choose the appropriate Setup Type for your system. This type determines which MySQL products are initially installed on your system, or select Custom to manually choose the products.

Developer: Install all products needed to develop applications with MySQL. This is the default option.

Server only: Only install the MySQL server.

Client only: Only install the MySQL client products, such as MySQL Workbench. This does not include the MySQL server.

Full: Install all available MySQL products.

Custom: Manually select the MySQL products to install, and optionally configure custom MySQL data and installation paths.

Note

After the initial installation, you may use MySQL Installer to manually select MySQL products to install or remove. In other words, MySQL Installer becomes a MySQL product management system.

Figure 2.2 MySQL Installer - Choosing a Setup Type

MySQL Installer checks your system for the external requirements (pre-requisites) required to install the selected MySQL products. MySQL Installer can download and install some prerequisites, but others require manual intervention. Download and install all prerequisites that have Status set to "Manual". Click Check to recheck if a manual prerequisite was installed. After manually installing those requirements, click Execute to download and install the other prerequisites. Once finished, click Next to continue.

Figure 2.3 MySQL Installer - Check Requirements

The next window lists the MySQL products that are scheduled for installation:

Figure 2.4 MySQL Installer - Installation Progress

As components are installed, their Status changes from a progress percentage to "Complete".

After all components are installed, the next step configures some of the recently installed MySQL products. The Configuration Overview window displays the progress and then loads a configuration window, if required. Our example configures MySQL Server 5.6.x.

Configuring MySQL Server

Configuring the MySQL server begins with defining several Type and Networking options.

Figure 2.5 MySQL Installer - Configuration Overview

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.

Developer: 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 localhost connections are allowed. Also define the Port Number and whether to open the firewall port for network access.

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

Figure 2.6 MySQL Installer - MySQL Server Configuration: Type and Networking

Accounts and Roles

Next, define your MySQL account information. Assigning a root password is required.

Optionally, you can add 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 dropdown for a list of role descriptions.

Note

If the MySQL Server is already installed, then you must also enter the Current Root Password.

Figure 2.7 MySQL Installer - MySQL Server Configuration: User Accounts and Roles

Figure 2.8 MySQL Installer - MySQL Server Configuration: User Accounts and Roles: Adding a User

Windows Service

Next, configure the Windows Service details. This includes the service name, whether the MySQL server should be loaded at startup, and how the MySQL server Windows service is executed.

Figure 2.9 MySQL Installer - MySQL Server Configuration: Windows Service

Note

When configuring Run Windows Services as ... using a Custom User, the custom user 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.

On Microsoft Windows 7, this is configured by loading the Start Menu, Control Panel, Administrative Tools, Local Security Policy, Local Policies, User Rights Assignment, then Log On As A Service. Choose Add User or Group here to add the custom user, and then OK, OK to save.

Advanced Options

The next configuration step is available if the Advanced Configuration option was checked. This section includes options that are related to the MySQL log files:

Figure 2.10 MySQL Installer - MySQL Server Configuration: Logging Options

Click Next to continue on to the final page before all of the requested changes are applied. This Apply Server Configuration page details the configuration steps that will be performed.

Figure 2.11 MySQL Installer - MySQL Server Configuration: Apply Server Configuration

Click Execute to execute the configuration steps. The icon for each step toggles from white to green on success, or the process stops on failure. Click the Log tab to view the log.

After the MySQL Installer configuration process is finished, MySQL Installer reloads the opening page where you can execute other installation and configuration related actions.

MySQL Installer is added to the Microsoft Windows Start menu under the MySQL group. Opening MySQL Installer loads its dashboard where installed MySQL products are listed, and other MySQL Installer actions are available:

Figure 2.12 MySQL Installer - Main Dashboard

Adding MySQL Products

Click Add to add new products. This loads the Select Products and Features page:

Figure 2.13 MySQL Installer - Select Products and Features

From here, choose the MySQL products you want to install from the left Available Products pane, and then click the green right arrow to queue products for installation.

Optionally, click Edit to open the product and features search filter:

Figure 2.14 MySQL Installer - Select Products and Features Filter

For example, you might choose to include Pre-Release products in your selections, such as a Beta product that has not yet reached General Availability (GA) status.

Select all of the MySQL products you want to install, then click Next to continue using the defaults, or highlight a selected product and click Advanced Options to optionally alter options such as the MySQL server data and installation paths. Click Execute to execute the installation process to install all of the selected products.

2.1 MySQL Product Catalog

MySQL Installer stores a MySQL product catalog. The catalog can be updated either manually or automatically, and the catalog change history is also available. The automatic update is enabled by default.

Note

The product catalog update also checks for a newer version of MySQL Installer, and prompts for an update if one is present.

Manual updates

You can update the MySQL product catalog at any time by clicking Catalog on the Installer dashboard.

Figure 2.15 MySQL Installer - Open the MySQL Product Catalog

From there, click Execute to update the product catalog.

Automatic updates

MySQL Installer can automatically update the MySQL product catalog. By default, this feature is enabled to execute each day at 12:00 AM. To configure this feature, click the wrench icon on the Installer dashboard.

The next window configures the Automatic Catalog Update. Enable or disable this feature, and also set the hour.

Figure 2.16 MySQL Installer - Configure the Catalog Scheduler

This option uses the Windows Task Scheduler to schedule a task named "ManifestUpdate".

Change History

MySQL Installer tracks the change history for all of the MySQL products. Click Catalog from the dashboard, optionally update the catalog (or, toggle the Do not update at this time checkbox), click Next/Execute, and then view the change history.

Figure 2.17 MySQL Installer - Catalog Change History

2.2 Remove MySQL Products

MySQL Installer can also remove MySQL products from your system. To remove a MySQL product, click Remove from the Installer dashboard. This opens a window with a list of installed MySQL products. Select the MySQL products you want to remove (uninstall), and then click Execute to begin the removal process.

Note

To select all MySQL products, click the [ ] checkbox to the left of the Product label.

Figure 2.18 MySQL Installer - Removing Products: Select

Figure 2.19 MySQL Installer - Removing Products: Executed

2.3 Alter MySQL Products

Use MySQL Installer to modify, configure, or upgrade your MySQL product installations.

Upgrade

Upgradable MySQL products are listed on the main dashboard with an arrow icon ( Upgrade ) next to their version number.

Figure 2.20 MySQL Installer - Upgrade a MySQL Product

Note

The "upgrade" functionality requires a current product catalog. This catalog is updated either manually or automatically (daily) by enabling the Automatic Catalog Update feature. For additional information, see Section 2.1, “MySQL Product Catalog”.

Click Upgrade to upgrade the available products. Our example indicates that MySQL Workbench 6.2.4 can be upgraded version 6.3.1 or 6.2.5, and MySQL server from 5.5.41 to 5.5.42.

Figure 2.21 MySQL Installer - Select Products To Upgrade

If multiple upgrade versions are available (such as our MySQL Workbench example above), select the desired version for the upgrade in the Available Upgrades area.

Note

Optionally, click the Changes link to view the version's release notes.

After selecting (checking) the products and versions to upgrade, click Next to begin the upgrade process.

Figure 2.22 MySQL Installer - Apply Updates

A MySQL server upgrade will also check and upgrade the server's database. Although optional, this step is recommended.

Figure 2.23 MySQL Installer - Check and Upgrade Database

Upon completion, your upgraded products will be upgraded and available to use. A MySQL server upgrade also restarts the MySQL server.

Reconfigure

Some MySQL products, such as the MySQL server, include a Reconfigure option. It opens the same configuration options that were set when the MySQL product was installed, and is pre-populated with the current values.

To execute, click the Reconfigure link under the Quick Action column on the main dashboard for the MySQL product that you want to reconfigure.

Figure 2.24 MySQL Installer - Reconfigure a MySQL Product

In the case of the MySQL server, this opens a configuration wizard that relates to the selected product. For example, for MySQL Server this includes setting the type, ports, log paths, and so on.

Modify

Many MySQL products contain feature components that can be added or removed. For example, Debug binaries and Client Programs are subcomponents of the MySQL server.

The modify the features of a product, click Modify on the main dashboard.

Figure 2.25 MySQL Installer - Modify Product Features

Click Execute to execute the modification request.

Chapter 3 MySQL Installer Console

MySQLInstallerConsole provides functionality similar to the GUI version of MySQL Installer, but from the command-line. It is installed when MySQL Installer is initially executed, and then available within the MySQL Installer directory. Typically that is in C:\Program Files (x86)\MySQL\MySQL Installer\, and the console must be executed with administrative privileges.

To use, invoke the Command Prompt with administrative privileges by choosing Start, Accessories, then right-click on Command Prompt and choose Run as administrator. And from the command-line, optionally change the directory to where MySQLInstallerConsole is located:

C:\> cd "C:\Program Files (x86)\MySQL\MySQL Installer for Windows"
C:\> MySQLInstallerConsole.exe help
C:\Program Files (x86)\MySQL\MySQL Installer for Windows>MySQLInstallerConsole.exe help
The following commands are available:
Configure - Configures one or more of your installed programs.
Help      - Provides list of available commands.
Install   - Install and configure one or more available MySQL programs.
List      - Provides an interactive way to list all products available.
Modify    - Modifies the features of installed products.
Remove    - Removes one or more products from your system.
Status    - Shows the status of all installed products.
Update    - Update the current product catalog.
Upgrade   - Upgrades one or more of your installed programs.

MySQLInstallerConsole supports the following options, which are specified on the command line:

Note

Configuration block values that contain a colon (":") must be wrapped in double quotes. For example, installdir="C:\MySQL\MySQL Server 5.6".

configure [product1]:[setting]=[value]; [product2]:[setting]=[value]; [...]

Configure one or more MySQL products on your system. Multiple setting=value pairs can be configured for each product.

Switches include:

-showsettings : Displays the available options for the selected product, by passing in the product name after -showsettings.

-silent : Disable confirmation prompts.

C:\> MySQLInstallerConsole configure -showsettings server
C:\> MySQLInstallerConsole configure server:port=3307

help [command]

Displays a help message with usage examples, and then exits. Pass in an additional command to receive help specific to that command.

C:\> MySQLInstallerConsole help
C:\> MySQLInstallerConsole help install

install [product]:[features]:[config block]:[config block]:[config block]; [...]

Install one or more MySQL products on your system.

Switches and syntax options include:

-type=[SetupType] : Installs a predefined set of software. The "SetupType" can be one of the following:

Note

Non-custom setup types can only be chosen if no other MySQL products are installed.

Developer: Installs a complete development environment.

Server: Installs a single MySQL server

Client: Installs client programs and libraries

Full: Installs everything

Custom: Installs user selected products. This is the default option.

-showsettings : Displays the available options for the selected product, by passing in the product name after -showsettings.

-silent : Disable confirmation prompts.

[config block]: One or more configuration blocks can be specified. Each configuration block is a semicolon separated list of key value pairs. A block can include either a "config" or "user" type key, where "config" is the default type if one is not defined.

Configuration block values that contain a colon (":") must be wrapped in double quotes. For example, installdir="C:\MySQL\MySQL Server 5.6".

Only one "config" type block can be defined per product. A "user" block should be defined for each user that should be created during the product's installation.

Note

Adding users is not supported when a product is being reconfigured.

[feature]: The feature block is a semicolon separated list of features, or '*' to select all features.

C:\> MySQLInstallerConsole install server;5.6.25:*:port=3307;serverid=2:type=user;username=foo;password=bar;role=DBManager
C:\> MySQLInstallerConsole install server;5.6.25;x64 -silent

An example that passes in additional configuration blocks, broken up by ^ to fit this screen:

C:\> MySQLInstallerConsole install server;5.6.25;x64:*:type=config;openfirewall=true; ^
          generallog=true;binlog=true;serverid=3306;enable_tcpip=true;port=3306;rootpasswd=pass; ^
          installdir="C:\MySQL\MySQL Server 5.6":type=user;datadir="C:\MySQL\data";username=foo;password=bar;role=DBManager

list

Lists an interactive console where all of the available MySQL products can be searched. Execute MySQLInstallerConsole list to launch the console, and enter in a substring to search.

C:\> MySQLInstallerConsole list

modify [product1:-removelist|+addlist] [product2:-removelist|+addlist] [...]

Modifies or displays features of a previously installed MySQL product.

-silent : Disable confirmation prompts.

C:\> MySQLInstallerConsole modify server
C:\> MySQLInstallerConsole modify server:+documentation
C:\> MySQLInstallerConsole modify server:-debug

remove [product1] [product2] [...]

Removes one ore more products from your system.

* : Pass in * to remove all of the MySQL products.

-continue : Continue the operation even if an error occurs.

-silent : Disable confirmation prompts.

C:\> MySQLInstallerConsole remove *
C:\> MySQLInstallerConsole remove server

status

Provides a quick overview of the MySQL products that are installed on the system. Information includes product name and version, architecture, date installed, and install location.

C:\> MySQLInstallerConsole status

upgrade [product1:version] [product2:version], [...]

Upgrades one or more products on your system. Syntax options include:

* : Pass in * to upgrade all products to the latest version, or pass in specific products.

! : Pass in ! as a version number to upgrade the MySQL product to its latest version.

-silent : Disable confirmation prompts.

C:\> MySQLInstallerConsole upgrade *
C:\> MySQLInstallerConsole upgrade workbench:6.3.5
C:\> MySQLInstallerConsole upgrade workbench:!
C:\> MySQLInstallerConsole upgrade workbench:6.3.5 excel:1.3.2

update

Downloads the latest MySQL product catalog to your system. On success, the download catalog will be applied the next time either MySQLInstaller or MySQLInstallerConsole is executed.

C:\> MySQLInstallerConsole update

Note

The Automatic Catalog Update GUI option executes this command from the Windows Task Scheduler.