Documentation Home
MySQL 8.0 Reference Manual
Related Documentation Download this Manual
PDF (US Ltr) - 38.0Mb
PDF (A4) - 38.0Mb
PDF (RPM) - 33.0Mb
HTML Download (TGZ) - 8.0Mb
HTML Download (Zip) - 8.1Mb
HTML Download (RPM) - 6.9Mb
Man Pages (TGZ) - 132.9Kb
Man Pages (Zip) - 189.5Kb
Info (Gzip) - 3.4Mb
Info (Zip) - 3.4Mb
Excerpts from this Manual

MySQL 8.0 Reference Manual  /  Using MySQL as a Document Store  /  Setting Up MySQL as a Document Store

20.2 Setting Up MySQL as a Document Store

This section describes the X Plugin, the X Protocol, and how to use MySQL Shell as a MySQL Server client.

The X Plugin is enabled by default and is part of MySQL Server. This plugin implements the X Protocol that is a prerequisite for using MySQL as a document store, and also used by X Protocol clients that connect to MySQL Server.


The X Plugin is enabled by default as of MySQL 8.0 and is statically linked.

Because X Plugin is enabled by default, installing or upgrading to MySQL 8 makes the plugin available. The following shows how to use MySQL Shell and a standard MySQL Client to check if the plugin is installed:

Check the X Plugin Installation

Verify that the X Plugin is installed.

An installed X Plugin shows up in the plugins list on the MySQL server, for example:

MySQL Shell command:

shell> mysqlsh -u user --sqlc -P 3306 -e "SHOW plugins"

MySQL Client program command:

shell> mysql -u user -p -e "SHOW plugins"

A mysqlxplugin; result is highlighted here:

| Name                       | Status   | Type               | Library | License |


| mysqlx                     | ACTIVE   | DAEMON             | NULL    | GPL     |



Disabling the X Plugin

The X Plugin can be disabled at startup by either setting mysqlx=0 in your MySQL configuration file, or by passing in either --mysqlx=0 or --skip-mysqlx when starting the MySQL server.

User Comments
Sign Up Login You must be logged in to post a comment.