Table of Contents

12.1 Upgrade Checker Utility

12.2 JSON Import Utility

12.2.1 Running the Utility

12.2.2 Importing JSON Documents With the Mysqlsh Command Interface

12.2.3 Conversions for Representations of BSON Data Types

12.3 Table Export Utility

12.4 Parallel Table Import Utility

12.5 Instance Dump Utility, Schema Dump Utility, and Table Dump Utility

12.6 Dump Loading Utility

12.7 Binary Log Dumping and Loading Utilities

12.7.1 Dumping Binary Logs

12.7.2 Loading Binary Log Dumps

12.8 Copy Instance, Schemas, and Tables

12.9 Diagnostics Utilities

12.9.1 collectDiagnostics Utility

12.9.2 collectHighLoadDiagnostics Utility

12.9.3 collectSlowQueryDiagnostics Utility

checkForServerUpgrade()

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

importJSON()

A JSON import utility that enables you to import JSON documents to a MySQL Server collection or table. SeeSection 12.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. SeeSection 12.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. SeeSection 12.4, “Parallel Table Import Utility”.

dumpInstance(), dumpSchemas(), dumpTables(),

An instance dump utility, schema dump utility, table dump utility that can export all schemas, a selected schema, selected tables and views, from a MySQL instance to cloud storage or a set of local files. SeeSection 12.5, “Instance Dump Utility, Schema Dump Utility, and Table Dump Utility”.

dumpBinlogs()

A dump utility which can dump binary logs from a MySQL instance to cloud storage or a set of local files.

loadDump()

A dump loading utility that can import data dumped using MySQL Shell's Instance, Schema, and Table dump utilities into a MySQL instance. SeeSection 12.6, “Dump Loading Utility”.

loadBinlogs()

A dump loading utility that can import binary logs dumped using MySQL Shell's binlog dump utility into a MySQL instance. SeeSection 12.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 MySQL HeatWave Service DB Systems.

SeeSection 12.9.1, “collectDiagnostics Utility”.

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.