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, ...)]
["external_tables": JSON_ARRAY("db_object" [, "db_object"].. )
}
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.2.3, “Auto Unload Command-Line Help”.
Use key-value pairs in JSON
format to
specify options
. HeatWave uses the
default setting if there is no option specification. Use
NULL
to specify no arguments.
For syntax examples, see Section 2.5.2.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 indryrun
mode automatically if the HeatWave Cluster is not active.
-
output
: Defines how Auto Unload produces output. Permitted values are:normal
: The default. Produces summarized output and sends it tostdout
and to theheatwave_autopilot_report
table. See Section 6.1, “HeatWave Autopilot Report Table”.silent
: Sends output to theheatwave_autopilot_report
table only. See Section 6.1, “HeatWave Autopilot Report Table”. Thesilent
output type is useful if human-readable output is not required; when the output is consumed by a script, for example. For an example of a stored procedure with an Auto Unload call that uses thesilent
output type, see Section 2.5.2.4, “Auto Unload Examples”.help
: Displays Auto Unload command-line help. See Section 2.5.2.3, “Auto Unload Command-Line Help”.
-
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
orINRECOVERY_RPDGSTABSTATE
.