This is an automated email from the ASF dual-hosted git repository. dmagda pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/ignite.git
The following commit(s) were added to refs/heads/master by this push: new 760f050 IGNITE-13285 (#8691) 760f050 is described below commit 760f0509337b99d661c044ebad90605837da7962 Author: Nikita Safonov <73828260+nikita-tech-wri...@users.noreply.github.com> AuthorDate: Wed Jan 27 21:02:26 2021 +0300 IGNITE-13285 (#8691) * IGNITE-13285 Added docs on control.sh indexes manipulation commands * IGNITE-13285 Added "Unix" and "Windows" tabs * IGNITE-13285 Fixed minor misprint. --- docs/_docs/tools/control-script.adoc | 78 +++++++++++++++++++++++++++++++++++- 1 file changed, 77 insertions(+), 1 deletion(-) diff --git a/docs/_docs/tools/control-script.adoc b/docs/_docs/tools/control-script.adoc index 48684b2..d5ce4fe 100644 --- a/docs/_docs/tools/control-script.adoc +++ b/docs/_docs/tools/control-script.adoc @@ -751,9 +751,85 @@ io.dataregion.default.PagesReplaceAge 0 io.dataregion.default.PhysicalMemoryPages 0 Command [METRIC] finished with code: 0 +== Indexes Management + +The commands below allow to get a specific information on indexes and to trigger the indexes rebuild process. + +To get the list of all indexes that match specified filters, use the command: + +[tabs] +-- +tab:Unix[] +[source,shell] +---- +control.sh --cache indexes_list [--node-id nodeId] [--group-name grpRegExp] [--cache-name cacheRegExp] [--index-name idxNameRegExp] +---- +tab:Window[] +[source,shell] +---- +control.bat --cache indexes_list [--node-id nodeId] [--group-name grpRegExp] [--cache-name cacheRegExp] [--index-name idxNameRegExp] +---- +-- + +Parameters: + +[cols="1,3",opts="header"] +|=== +| Parameter | Description +| `--node-id nodeId`| Node ID for the job execution. If the ID is not specified, a node is chosen by the grid. +| `--group-name regExp`| Regular expression enabling filtering by cache group name. +| `--cache-name regExp`| Regular expression enabling filtering by cache name. +| `--index-name regExp`| Regular expression enabling filtering by index name. +|=== + +To get the list of all caches that have index rebuild in progress, use the command below: + + +[tabs] +-- +tab:Unix[] +[source,shell] +---- +control.sh --cache indexes_rebuild_status [--node-id nodeId] +---- +tab:Window[] +[source,shell] +---- +control.bat --cache indexes_rebuild_status [--node-id nodeId] +---- +-- + + +To trigger the rebuild process of all indexes for the specified caches or the cache groups, use the command: + +[tabs] +-- +tab:Unix[] +[source,shell] +---- +control.sh --cache indexes_force_rebuild --node-id nodeId --cache-name cacheName1,...cacheNameN|--group-name groupName1,...groupNameN +---- +tab:Window[] +[source,shell] +---- +control.bat --cache indexes_force_rebuild --node-id nodeId --cache-name cacheName1,...cacheNameN|--group-name groupName1,...groupNameN +---- +-- + +Parameters: + +[cols="1,3",opts="header"] +|=== +| Parameter | Description +| `--node-id`| Node ID for the indexes rebuild. +| `--cache-names`| Comma-separated list of cache names for which indexes should be rebuilt. +| `--group-names`| Comma-separated list of cache group names for which indexes should be rebuilt. +|=== + + == System View Command -The system view command prints out the content of a system view provided in the parameters list. Use the `--node-id` parameter, If you need to get a metric from a specific node. Ignite selects a random node, if the `--node-id` is not set. +The system view command prints out the content of a system view provided in the parameters list. Use the `--node-id` parameter, if you need to get a metric from a specific node. Ignite selects a random node, if the `--node-id` is not set. [tabs] --