5.9.1.1 Autopilot Indexing Syntax

Autopilot Indexing uses the following syntax:

mysql> CALL sys.autopilot_index_advisor ([options]);
  
 options: {
     JSON_OBJECT('key','value'[,'key','value'] ...)
        'key','value': 
        ['output',{'normal'|'silent'|'help'}]
        ['target_schema',JSON_ARRAY({'schema_name'[,'schema_name']}]
}

Autopilot Indexing options are specified as key-value pairs in JSON format. Options include:

• output: Defines how Autopilot Indexing produces output. Permitted values are:

  • normal: The default. Produces summarized output and sends it to stdout and to the autopilot_index_advisor_report table. See Section 5.9.1.4, “Autopilot Index Advisor Report Table”.

  • silent: Sends output to the autopilot_index_advisor_report table only. See Section 5.9.1.4, “Autopilot Index Advisor Report Table”. The silent output type is useful if human-readable output is not required; when the output is consumed by a script, for example.

  • help: Displays Autopilot Indexing command-line help.

• target_schema: Defines one or more schemas for Advisor to analyze. The list is specified as a JSON array. If a target schema is not specified, Advisor analyzes all user defined schemas. When a target schema is specified, Advisor generates recommendations for tables belonging to the target schema. For the most accurate recommendations, specify one schema at a time. Only run Advisor on multiple schemas if the queries access tables in multiple schemas.