After you have installed and started MySQL server, connect
MySQL Shell to the server instance. You need to know the
address of the MySQL server instance you plan to connect to. To
be able to use the instance as a Document Store, the server
instance must have X Plugin installed and you should
connect to the server using X Protocol. For example to
connect to the instance
the default X Protocol port of 33060 use the network
If you connect to the instance using MySQL classic protocol,
for example by using the default port of 3306 rather than the
mysqlx_port, you cannot use
the Document Store functionality shown in this tutorial. For
db global object is not
populated. To use the Document Store, always connect using
If MySQL Shell is not already running, open a terminal window and issue:
Alternatively, if MySQL Shell is already running use the
\connect command by issuing:
You need to specify the address of the MySQL server instance which you want to connect MySQL Shell to. For example in the previous example:
userrepresents the user name of your MySQL account.
ds1.example.comis the hostname of the server instance running MySQL. Replace this with the hostname of the MySQL server instance you are using as a Document Store.
The default schema for this session is
world_x. For instructions on setting up the
world_xschema, see Section 20.3.2, “Download and Import world_x Database”.
For more information, see Section 4.2.5, “Connecting to the Server Using URI-Like Strings or Key-Value Pairs”.
Once MySQL Shell opens, the
prompt indicates that the active language for this session is
MySQL Shell supports input-line editing as follows:
left-arrow and right-arrow keys move horizontally within the current input line.
up-arrow and down-arrow keys move up and down through the set of previously entered lines.
Backspace deletes the character before the cursor and typing new characters enters them at the cursor position.
Enter sends the current input line to the server.
Type mysqlsh --help at the prompt of your command interpreter for a list of command-line options.
\help at the MySQL Shell prompt for a
list of available commands and their descriptions.
\help followed by a command name for
detailed help about an individual MySQL Shell command. For
example, to view help on the
mysql-js> \help \connect