Skip to content

Commit 72ebec7

Browse files
author
Lars Tangvald
committed
Updated README.md text
1 parent 45a06cf commit 72ebec7

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,36 +2,35 @@
22

33
# What is MySQL Shell?
44

5-
MySQL Shell is the new client made to be used with MySQL's X Plugin, which enables MySQL to function as a document store. More information about this is available at https://dev.mysql.com/doc/refman/5.7/en/document-store.html
5+
MySQL Shell is a new command line client that supports interaction with MySQL Server through Javascript, Python and SQL. It covers the same area of usage as the `mysql` command line client, so you can use it to to perform classical relational SQL operations, while introducing a whole new area of functionality to query, update and manage MySQL as a document store, using popular scripting languages. More information about MySQL's new document store functionality is available at https://dev.mysql.com/doc/refman/5.7/en/document-store.html
66

7-
MySQL Shell is still in alpha, and this image is meant for previewing upcoming features.
7+
MySQL Shell is currently in alpha, and this Docker image is meant only for the purpose of previewing upcoming features.
88

9-
# Enabling mysqlx plugin on server
9+
# Enabling the mysqlx plugin on the MySQL server
1010

11-
To use the new features of the X Plugin it must first be enabled on the server
11+
The new document store features of MySQL are implemented as a plugin to MySQL Server. This plugin needs to be enabled on the server before you can use the shell to access the new functionality. This needs to be done only once: the server will remember this setting on restart.
1212

13-
To use the Shell image to enable the plugin, it can be started with the init command:
13+
Invoke the shell as follows:
1414

1515
docker run -it -e MYSQL_HOST=mysqlhostname mysql-shell init
1616

17-
You will be asked to enter the password for the server's root user. You should see the a message
18-
that the mysqlx plugin has been installed. This only needs to be done the first time.
17+
You will be asked to enter the password for the server's root user. You should see a message that the mysqlx plugin has been installed.
1918

2019
# Connecting to mysqlx-enabled server
2120

2221
To connect to the server, simply run the mysql-shell image the same way you would start a normal MySQL client:
2322

2423
docker run -it mysql-shell -u <username> -h mysqlhostname
2524

26-
Once logged in, if you run \status, you should see «Session type: X>
25+
Once logged in, if you run `\status`, the shell should respond with `Session type: X`.
2726

2827
# Using MySQL Shell
2928

3029
For information on how to use MySQL Shell, refer to the user guide at https://dev.mysql.com/doc/refman/5.7/en/mysql-shell.html
3130

3231
# Supported Docker Versions
3332

34-
These images are officially supported by the MySQL team on Docker version 1.9. Support for older versions (down to 1.0) is provided on a best-effort basis, but we strongly recommend running on the most recent version, since that is assumed for parts of the documentation above.
33+
These images are officially supported by the MySQL team on Docker version 1.11. Support for older versions (down to 1.0) is provided on a best-effort basis, but we strongly recommend running on the most recent version, since that is assumed for parts of the documentation above.
3534

3635
# User Feedback
3736

0 commit comments

Comments
 (0)