Documentation Home
MySQL HeatWave User Guide
Related Documentation Download this Manual
PDF (US Ltr) - 1.6Mb
PDF (A4) - 1.6Mb


2.5.3.1 Auto Unload Syntax

mysql> CALL sys.heatwave_unload (db_list,[options]);

db_list: {
     JSON_ARRAY(["schema_name","schema_name"] ...)

options: {
     JSON_OBJECT("key","value"[,"key","value"] ...)
          "key","value": {
          ["mode",{"normal"|"dryrun"}]
          ["output",{"normal"|"silent"|"help"}]
          ["exclude_list",JSON_ARRAY(schema_name_1, schema_name_2.table_name_1, ...)]
}

db_list specifies the schemas to unload. The list is specified as a JSON_ARRAY and requires one or more valid schema names. An empty array is permitted to view the Auto Unload command-line help, see Section 2.5.3.3, “Auto Unload Command-Line Help”.

Use key-value pairs in JSON format to specify parameters. HeatWave uses the default setting if there is no option setting. Use NULL to specify no arguments.

For syntax examples, see Section 2.5.3.4, “Auto Unload Examples”.

Auto Unload options include:

  • mode: Defines the Auto Unload operational mode. Permitted values are:

    • normal: The default. Generates and executes the unload script.

    • dryrun: Generates an unload script only. Auto Unload executes in dryrun mode automatically if the HeatWave Cluster is not active.

  • output: Defines how Auto Unload produces output. Permitted values are:

  • exclude_list: Defines a list of schemas and tables to exclude from the unload script. Names must be fully qualified without backticks.

    Auto Unload automatically excludes tables that are loading, unloading or in recovery. This is when the load_status is one of the following: NOLOAD_RPDGSTABSTATE, LOADING_RPDGSTABSTATE, UNLOADING_RPDGSTABSTATE or INRECOVERY_RPDGSTABSTATE.