MySQL Shell 8.4  /  ...  /  Using Compressed Connections

4.3.7 Using Compressed Connections

You can request compression for MySQL Shell connections that use classic MySQL protocol, and X Protocol. When compression is requested for a session, if the server supports compression and can agree a compression algorithm with MySQL Shell, all information sent between the client and the server is compressed. Compression is also applied if requested to connections used by a MySQL Shell utility, such as the upgrade checker utility.

For X Protocol connections, the default is that compression is requested, and uncompressed connections are allowed if the negotiations for a compressed connection do not succeed. For classic MySQL protocol connections, the default is that compression is disabled. After the connection has been made, the MySQL Shell \status command shows whether or not compression is in use for a session. The command displays a Compression: line that says Disabled or Enabled to indicate whether the connection is compressed. If compression is enabled, the compression algorithm in use is also displayed.

You can set the defaultCompress MySQL Shell configuration option to request compression for every global session. Because the default for X Protocol connections is that compression is requested where the MySQL Shell release supports this, this configuration option only has an effect for classic MySQL protocol connections.

For more information on how connection compression operates for X Protocol connections, see Connection Compression with X Plugin. For more information on how connection compression operates for classic MySQL protocol connections, and on the compression settings and capabilities of a MySQL Server instance, see Connection Compression Control.