Chapter 11 MySQL Shell Utilities

Table of Contents

11.1 Upgrade Checker Utility

11.2 JSON Import Utility

11.2.1 Running the Utility

11.2.2 Importing JSON Documents With the Mysqlsh Command Interface

11.2.3 Importing JSON Documents With the --import Command

11.2.4 Conversions for Representations of BSON Data Types

11.3 Table Export Utility

11.4 Parallel Table Import Utility

11.5 Instance Dump Utility, Schema Dump Utility, and Table Dump Utility

11.6 Dump Loading Utility

11.7 Copy Instance, Schemas, and Tables

11.8 Diagnostics Utilities

11.8.1 collectDiagnostics Utility

11.8.2 collectHighLoadDiagnostics Utility

11.8.3 collectSlowQueryDiagnostics Utility

MySQL Shell includes utilities for working with MySQL. To access the utilities from within MySQL Shell, use the util global object, which is available in JavaScript and Python modes, but not SQL mode. The util global object provides the following functions:

checkForServerUpgrade()

An upgrade checker utility that enables you to verify whether MySQL server instances are ready for upgrade. See Section 11.1, “Upgrade Checker Utility”.

importJSON()

A JSON import utility that enables you to import JSON documents to a MySQL Server collection or table. See Section 11.2, “JSON Import Utility”.

exportTable()

A table export utility that exports a MySQL relational table into a data file, which can then be uploaded into a table on a target MySQL server using MySQL Shell's parallel table import utility, or to import data to a different application, or as a light-weight logical backup for a single data table. See Section 11.3, “Table Export Utility”.

importTable()

A parallel table import utility that splits up a single data file and uses multiple threads to load the chunks into a MySQL table. See Section 11.4, “Parallel Table Import Utility”.

dumpInstance(), dumpSchemas(), dumpTables()

An instance dump utility, schema dump utility, and table dump utility that can export all schemas, a selected schema, or selected tables and views, from a MySQL instance into an Oracle Cloud Infrastructure Object Storage bucket or a set of local files. See Section 11.5, “Instance Dump Utility, Schema Dump Utility, and Table Dump Utility”.

loadDump()

A dump loading utility that can import schemas dumped using MySQL Shell's instance dump utility and schema dump utility into a MySQL instance. See Section 11.6, “Dump Loading Utility”.

collectDiagnostics()

A diagnostics generation utility that gathers information from the connected MySQL server, generates reports in TSV and YAML formats, and presents them in a zip archive in the location of your choice.

This utility enables you to retrieve diagnostic information from standalone servers, members of replication topologies, and HeatWave Service DB Systems.

See Section 11.8.1, “collectDiagnostics Utility”.

Important

MySQL Shell reads MySQL Server option files and login paths by default. As a result, if you connect to a MySQL Server which uses an option file, it will be used, by default, and attempt to create a global session using that configuration. If you do not want to use the options file, you must add --no-defaults to your command line.