Add support for table and index recommendations under a new command group

Author: nachoalonsoportillo

src/azure-cli/azure/cli/command_modules/rdbms/_flexible_server_location_capabilities_util.py

@@ -52,7 +52,7 @@ def _postgres_parse_list_capability(result):
     restricted = offer_restricted[0].status if offer_restricted else None
     zone_redundant = [feature for feature in supported_features if feature.name == "ZoneRedundantHa"]
     geo_backup = [feature for feature in supported_features if feature.name == "GeoBackup"]
-    index_tuning = [feature for feature in supported_features if feature.name == "IndexTuning"]
+    automated_tuning = [feature for feature in supported_features if feature.name == "IndexTuning"]
 
     if restricted == "Enabled":
         raise InvalidArgumentValueError("The location is restricted for provisioning of flexible servers. Please try using another region.")
@@ -62,7 +62,7 @@ def _postgres_parse_list_capability(result):
 
     single_az = zone_redundant[0].status != "Enabled" if zone_redundant else True
     geo_backup_supported = geo_backup[0].status == "Enabled" if geo_backup else False
-    index_tuning_supported = index_tuning[0].status == "Enabled" if index_tuning else False
+    automated_tuning_supported = automated_tuning[0].status == "Enabled" if automated_tuning else False
 
     tiers = result[0].supported_server_editions
     tiers_dict = {}

src/azure-cli/azure/cli/command_modules/rdbms/_helptext_pg.py

@@ -1164,55 +1164,63 @@
     text: az postgres flexible-server fabric-mirroring update-databases -g testgroup -s testsvr --database-names testdb2 testdb3
 """
 
-helps['postgres flexible-server index-tuning'] = """
+helps['postgres flexible-server tuning'] = """
 type: group
-short-summary: Index tuning analyzes read queries captured in Query Store and recommends index changes to optimize these queries.
+short-summary: Automated tuning analyzes read queries captured in Query Store and recommends table or index changes to optimize these queries.
 """
 
-helps['postgres flexible-server index-tuning update'] = """
+helps['postgres flexible-server tuning update'] = """
 type: command
-short-summary: Update index tuning to be enabled/disabled for a PostgreSQL flexible server.
+short-summary: Update automated tuning to be enabled/disabled for a PostgreSQL flexible server.
 examples:
-  - name: Update index tuning to be enabled/disabled for a PostgreSQL flexible server.
-    text: az postgres flexible-server index-tuning update -g testgroup -s testsvr --enabled True
+  - name: Update automated tuning to be enabled/disabled for a PostgreSQL flexible server.
+    text: az postgres flexible-server tuning update -g testgroup -s testsvr --enabled True
 """
 
-helps['postgres flexible-server index-tuning show'] = """
+helps['postgres flexible-server tuning show'] = """
 type: command
-short-summary: Show state of index tuning for a PostgreSQL flexible server.
+short-summary: Show state of automated tuning for a PostgreSQL flexible server.
 examples:
-  - name: Show state of index tuning for a PostgreSQL flexible server.
-    text: az postgres flexible-server index-tuning show -g testgroup -s testsvr
+  - name: Show state of automated tuning for a PostgreSQL flexible server.
+    text: az postgres flexible-server tuning show -g testgroup -s testsvr
 """
 
-helps['postgres flexible-server index-tuning list-settings'] = """
+helps['postgres flexible-server tuning list-settings'] = """
 type: command
-short-summary: Get tuning settings associated for a PostgreSQL flexible server.
+short-summary: Get automated tuning settings associated to a PostgreSQL flexible server.
 examples:
-  - name: Get tuning settings for a PostgreSQL flexible server.
-    text: az postgres flexible-server index-tuning list-settings -g testgroup -s testsvr
+  - name: Get automated tuning settings for a PostgreSQL flexible server.
+    text: az postgres flexible-server tuning list-settings -g testgroup -s testsvr
 """
 
-helps['postgres flexible-server index-tuning show-settings'] = """
+helps['postgres flexible-server tuning show-settings'] = """
 type: command
-short-summary: Get a tuning setting for a PostgreSQL flexible server.
+short-summary: Get an automated tuning setting for a PostgreSQL flexible server.
 examples:
-  - name: Get a tuning setting for a PostgreSQL flexible server.
-    text: az postgres flexible-server index-tuning show-settings -g testgroup -s testsvr --name setting-name
+  - name: Get an automated tuning setting for a PostgreSQL flexible server.
+    text: az postgres flexible-server tuning show-settings -g testgroup -s testsvr --name setting-name
 """
 
-helps['postgres flexible-server index-tuning set-settings'] = """
+helps['postgres flexible-server tuning set-settings'] = """
 type: command
-short-summary: Update a tuning setting for a PostgreSQL flexible server.
+short-summary: Update an automated tuning setting for a PostgreSQL flexible server.
 examples:
-  - name: Update a tuning setting for a PostgreSQL flexible server.
-    text: az postgres flexible-server index-tuning set-settings -g testgroup -s testsvr --name setting-name --value setting-value
+  - name: Update an automated tuning setting for a PostgreSQL flexible server.
+    text: az postgres flexible-server tuning set-settings -g testgroup -s testsvr --name setting-name --value setting-value
 """
 
-helps['postgres flexible-server index-tuning list-recommendations'] = """
+helps['postgres flexible-server tuning list-index-recommendations'] = """
 type: command
-short-summary: Get available tuning index recommendations associated with a PostgreSQL flexible server.
+short-summary: Get available automated tuning index recommendations associated with a PostgreSQL flexible server.
 examples:
-  - name: Get tuning index recommendations for a PostgreSQL flexible server. Filter by selected type.
-    text: az postgres flexible-server index-tuning list-recommendations -g testgroup -s testsvr --recommendation-type CreateIndex
+  - name: Get automated tuning index recommendations for a PostgreSQL flexible server. Filter by selected type.
+    text: az postgres flexible-server tuning list-index-recommendations -g testgroup -s testsvr --recommendation-type CreateIndex
+"""
+
+helps['postgres flexible-server tuning list-table-recommendations'] = """
+type: command
+short-summary: Get available automated tuning table recommendations associated with a PostgreSQL flexible server.
+examples:
+  - name: Get automated tuning table recommendations for a PostgreSQL flexible server. Filter by selected type.
+    text: az postgres flexible-server tuning list-table-recommendations -g testgroup -s testsvr --recommendation-type AnalyzeTable
 """

src/azure-cli/azure/cli/command_modules/rdbms/_params.py

@@ -23,7 +23,7 @@
 from .randomname.generate import generate_username
 from ._flexible_server_util import get_current_time
 from argcomplete.completers import FilesCompleter
-from ._util import get_index_tuning_settings_map
+from ._util import get_automated_tuning_settings_map
 
 
 def load_arguments(self, _):    # pylint: disable=too-many-statements, too-many-locals
@@ -1057,34 +1057,40 @@ def _flexible_server_params(command_group):
                 c.argument('resource_group_name', arg_type=resource_group_name_type)
                 c.argument('server_name', options_list=['--server-name', '-s'], id_part='name', arg_type=server_name_arg_type, required=False)
 
-        # index tuning
+        # automated tuning
         if command_group == 'postgres':
-            for scope in ['update', 'show', 'list-settings', 'show-settings', 'set-settings', 'list-recommendations']:
-                argument_context_string = '{} flexible-server index-tuning {}'.format(command_group, scope)
+            for scope in ['update', 'show', 'list-settings', 'show-settings', 'set-settings', 'list-table-recommendations', 'list-index-recommendations']:
+                argument_context_string = '{} flexible-server tuning {}'.format(command_group, scope)
                 with self.argument_context(argument_context_string) as c:
                     c.argument('server_name', options_list=['--server-name', '-s'], arg_type=server_name_arg_type)
 
-            with self.argument_context('{} flexible-server index-tuning update'.format(command_group)) as c:
-                c.argument('index_tuning_enabled',
+            with self.argument_context('{} flexible-server tuning update'.format(command_group)) as c:
+                c.argument('tuning_enabled',
                            options_list=['--enabled'],
                            required=True,
-                           help='Enable or disable index tuning feature.',
+                           help='Enable or disable index and table tuning feature.',
                            arg_type=get_enum_type(['True', 'False']))
 
-            with self.argument_context('{} flexible-server index-tuning list-recommendations'.format(command_group)) as c:
+            with self.argument_context('{} flexible-server tuning list-index-recommendations'.format(command_group)) as c:
                 c.argument('recommendation_type',
                            options_list=['--recommendation-type', '-r'],
                            help='Retrieve recommendations based on type.',
-                           arg_type=get_enum_type(['CreateIndex', 'DropIndex']))
+                           arg_type=get_enum_type(['CreateIndex', 'DropIndex', 'ReIndex']))
+
+            with self.argument_context('{} flexible-server tuning list-table-recommendations'.format(command_group)) as c:
+                c.argument('recommendation_type',
+                           options_list=['--recommendation-type', '-r'],
+                           help='Retrieve recommendations based on type.',
+                           arg_type=get_enum_type(['AnalyzeTable']))
 
             for scope in ['show-settings', 'set-settings']:
-                argument_context_string = '{} flexible-server index-tuning {}'.format(command_group, scope)
+                argument_context_string = '{} flexible-server tuning {}'.format(command_group, scope)
                 with self.argument_context(argument_context_string) as c:
                     c.argument('setting_name', options_list=['--name', '-n'], required=True,
-                               arg_type=get_enum_type(get_index_tuning_settings_map().keys()),
+                               arg_type=get_enum_type(get_automated_tuning_settings_map().keys()),
                                help='The name of the tuning setting.')
 
-            with self.argument_context('{} flexible-server index-tuning set-settings'.format(command_group)) as c:
+            with self.argument_context('{} flexible-server tuning set-settings'.format(command_group)) as c:
                 c.argument('value', options_list=['--value', '-v'],
                            help='Value of the tuning setting.')
 

src/azure-cli/azure/cli/command_modules/rdbms/_util.py

@@ -105,7 +105,7 @@ def call(*args, **kwargs):
     return decorate
 
 
-def get_index_tuning_settings_map():
+def get_automated_tuning_settings_map():
     return {
         'analysis_interval': 'index_tuning.analysis_interval',
         'max_columns_per_index': 'index_tuning.max_columns_per_index',

src/azure-cli/azure/cli/command_modules/rdbms/flexible_server_commands.py

@@ -296,11 +296,12 @@ def load_flexibleserver_command_table(self, _):
         g.custom_command('stop', 'flexible_server_fabric_mirroring_stop')
         g.custom_command('update-databases', 'flexible_server_fabric_mirroring_update_databases')
 
-    with self.command_group('postgres flexible-server index-tuning', postgres_flexible_config_sdk,
+    with self.command_group('postgres flexible-server automated-tuning', postgres_flexible_config_sdk,
                             client_factory=cf_postgres_flexible_config) as g:
-        g.custom_command('update', 'index_tuning_update', custom_command_type=flexible_servers_custom_postgres)
-        g.custom_show_command('show', 'index_tuning_show', custom_command_type=flexible_servers_custom_postgres)
-        g.custom_command('list-settings', 'index_tuning_settings_list', custom_command_type=flexible_servers_custom_postgres)
-        g.custom_command('show-settings', 'index_tuning_settings_get', custom_command_type=flexible_servers_custom_postgres)
-        g.custom_command('set-settings', 'index_tuning_settings_set', custom_command_type=flexible_servers_custom_postgres)
-        g.custom_command('list-recommendations', 'recommendations_list', custom_command_type=flexible_servers_custom_postgres)
+        g.custom_command('update', 'automated_tuning_update', custom_command_type=flexible_servers_custom_postgres)
+        g.custom_show_command('show', 'automated_tuning_show', custom_command_type=flexible_servers_custom_postgres)
+        g.custom_command('list-settings', 'automated_tuning_settings_list', custom_command_type=flexible_servers_custom_postgres)
+        g.custom_command('show-settings', 'automated_tuning_settings_get', custom_command_type=flexible_servers_custom_postgres)
+        g.custom_command('set-settings', 'automated_tuning_settings_set', custom_command_type=flexible_servers_custom_postgres)
+        g.custom_command('list-index-recommendations', 'index_recommendations_list', custom_command_type=flexible_servers_custom_postgres)
+        g.custom_command('list-table-recommendations', 'table_recommendations_list', custom_command_type=flexible_servers_custom_postgres)