Skip navigation links
8.1.1.2 Manage Server Instances Dialog »
Section Navigation      [Toggle]

8.1.1.1. New Server Instance Wizard

Clicking the New Server Instance action item launches the Create a new server instance wizard. The wizard provides a step-by-step approach to creating a new server instance. This is most suitable for beginners. Once some familiarity is achieved with the various settings and parameters required, a new instance can also be quickly created from the Manage Server Instances dialog discussed later.

The steps presented in the wizard are as follows:

  1. Specify host machine

  2. Operating system

  3. Host SSH Connection

  4. Test Settings

  5. Database Connection

  6. Test DB Connection

  7. MySQL Config File

  8. Specify Commands

  9. Complete Setup

  10. Results

Specify host machine

On this page you can select Localhost if you intend to manage a server on your local machine. Or you can select Remote Host. In this latter case you will need to provide the IP address or the network name of the remote server. Click Next to continue.

Operating system

On this page you simply select the operating system that applies to your server. You should also ensure that the option you select from the drop-down listbox also reflects your MySQL Server version and installation type, for example, Windows (MySQL 5.1 Installer Package).

Host SSH Connection

If you specified a Remote Host on the Specify Host Machine page, you will be presented with the Host SSH Connection page. This page allows you to enable SSH for the login to the server instance. This facility allows you to create a secure connection to remotely administer and configure the server instance. You need to enter the username and password of the account that will be used to log in to the server for administration and configuration activities. If you do not enter a password, you will be prompted for the password when the connection is established by MySQL Workbench. You can optionally specify the path to your SSH key for use with the server, rather than enter a username and password.

Note

This connection is to allow remote administration and configuration of the MySQL Server itself. It is not the same as the connection used to connect to a server for general database manipulation.

Note

If managing a remote server, you will need to use an SSH connection type if you wish to start or stop the server or edit its configuration file. Other administrative functions do not require an SSH connection type.

Test Settings

On the next page your settings will be tested. The wizard will report back the results of attempting to connect to the server. If an error occurs you will be directed to view the logs, which can be done by clicking the Show Logs button.

Database Connection

This page allows you to select a connection to a specific database. The settings entered previously have been concerned with the connection to the server required for admnistrative purposes. This page is concerned with connection to a specific database. You can either launch the Manage DB Connections dialog or select a pre-existing connection from a drop-down listbox. The former is most useful if you have not created any connections. If you do need to create a connection at this point then refer to Section 6.1, “Manage Connections”. Once a connection has been selected click Next to continue.

Test DB Connection

On this page your database connection will be tested and results displayed. If an error occurred you will be directed to view the logs. This can be achieved by clicking the Show Logs button.

MySQL Config File

In order for MySQL Server configuration information to be fetched and displayed in MySQL Workbench the location of the MySQL Server configuration file needs to be known. The wizard will be able to determine the most likely location of the configuration file, based on the selection made on the Operating System page of the wizard. However, it is possible to test that this information is correct by clicking the Check path and Check section buttons. The wizard will then report if the configuration file and server configuration section can in fact be accessed. It is also possible to manually enter the location of the configuration file, and the section pertaining to MySQL Server data, but again these manually entered values should be tested using the buttons provided. Click the Next button to continue.

Specify Commands

This page allows you to set the commands required to start, stop and check the status of the running server instance. These felds will have defaults set based on the option selected on the Operating System page of the wizard. It is possible to customize the commands if required, but the defaults will be suitable in most cases. Click Next to continue.

Complete Setup

On this page you finally assign a name to the server instance. This name is used in various parts of the GUI to allow you to recall this instance. After setting a suitable name, click Next to continue.

Results

This is the final page of the wizard. It simply summarizes the settings you have selected. If everything looks good click Finish to create the server instance and exit the wizard.