[IGNITE-17522] Add documentation for the index rebuild operation in the maintenance mode

• Type: Task
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 2.14
• Component/s: documentation
• Ignite Flags: Docs Required, Release Notes Required
• Assignee: Igor Gusev
• Reporter: Semyon Danilov
• Reviewer: Semyon Danilov
• Created: 12/Aug/22 13:13
• Updated: 31/Aug/22 14:59
• Resolved: 31/Aug/22 14:59

Description

The new command's syntax is as follows:

  --cache schedule_indexes_rebuild --node-id nodeId --cache-names cacheName[index1,...indexN],cacheName2,cacheName3[index1] --group-names groupName1,groupName2,...groupNameN
    Schedules rebuild of the indexes for specified caches via the Maintenance Mode. Schedules rebuild of specified caches and cache-groups

    Parameters:
      --node-id      - (Optional) Specify node for indexes rebuild. If not specified, schedules rebuild on all nodes.
      --cache-names  - Comma-separated list of cache names with optionally specified indexes. If indexes are not specified then all indexes of the cache will be scheduled for the rebuild operation. Can be used simultaneously with cache group names.
      --group-names  - Comma-separated list of cache group names for which indexes should be scheduled for the rebuild. Can be used simultaneously with cache names.

Issue Links

• is caused by: IGNITE-17002 Indexes rebuild in Maintenance Mode
• links to: GitHub Pull Request #10224