Chapter 3 MySQL Installer Console
Prev

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.exe 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.exe 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
```
update
Downloads the latest MySQL product catalog to your system. On success, the download catalog will be applied the next time either MySQLInstaller.exe or MySQLInstallerConsole.exe is executed.
```
C:\> MySQLInstallerConsole update
```
Note

The Automatic Catalog Update GUI option executes this command from the Windows Task Scheduler.
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
```