Nikita-tech-writer commented on a change in pull request #8701:
URL: https://github.com/apache/ignite/pull/8701#discussion_r564091349
##########
File path: docs/_docs/tools/control-script.adoc
##########
@@ -521,6 +521,50 @@ validate_indexes has finished with errors (listed above).
Like `idle_verify`, index validation tool works correctly only if updates are
stopped. Otherwise, there may be a race between the checker thread and the
thread that updates the entry/index, which can result in a false positive error
report.
====
+=== Check SQL Index Inline Size
+
+During the operation of the Ignite cluster it could have a different SQL index
inline size on cluster nodes.
+For example, due to the `IGNITE_MAX_INDEX_PAYLOAD_SIZE` property value is
different on cluster nodes. The difference
+of index inline size may lead to performance drop.
Review comment:
```suggestion
A running Ignite cluster could have different SQL index inline sizes on its
cluster nodes.
For example, it could happen due to the `IGNITE_MAX_INDEX_PAYLOAD_SIZE`
property value is different on the cluster nodes. The difference
between index inline sizes may lead to a performance drop.
```
##########
File path: docs/_docs/tools/control-script.adoc
##########
@@ -521,6 +521,50 @@ validate_indexes has finished with errors (listed above).
Like `idle_verify`, index validation tool works correctly only if updates are
stopped. Otherwise, there may be a race between the checker thread and the
thread that updates the entry/index, which can result in a false positive error
report.
====
+=== Check SQL Index Inline Size
+
+During the operation of the Ignite cluster it could have a different SQL index
inline size on cluster nodes.
+For example, due to the `IGNITE_MAX_INDEX_PAYLOAD_SIZE` property value is
different on cluster nodes. The difference
+of index inline size may lead to performance drop.
+
+The `check_index_inline_sizes` command validates the indexes inline size of
given caches on all cluster nodes. The inline
+size of secondary indexes is always checked on a node join and the WARN
message is printed to the log if differ.
Review comment:
```suggestion
The `check_index_inline_sizes` command validates the indexes inline size of
given caches on all cluster nodes. The inline
size of secondary indexes is always checked on a node join and a WARN
message is printed to the log if they differ.
```
##########
File path: docs/_docs/tools/control-script.adoc
##########
@@ -521,6 +521,50 @@ validate_indexes has finished with errors (listed above).
Like `idle_verify`, index validation tool works correctly only if updates are
stopped. Otherwise, there may be a race between the checker thread and the
thread that updates the entry/index, which can result in a false positive error
report.
====
+=== Check SQL Index Inline Size
+
+During the operation of the Ignite cluster it could have a different SQL index
inline size on cluster nodes.
+For example, due to the `IGNITE_MAX_INDEX_PAYLOAD_SIZE` property value is
different on cluster nodes. The difference
+of index inline size may lead to performance drop.
+
+The `check_index_inline_sizes` command validates the indexes inline size of
given caches on all cluster nodes. The inline
+size of secondary indexes is always checked on a node join and the WARN
message is printed to the log if differ.
+
+[tabs]
+--
+tab:Shell[]
+[source,shell]
+----
+# Checks that secondary indexes inline sizes are the same on all cluster nodes.
Review comment:
I would rather remove this comment from the tab and put it before the
command:
Use the command below to check if the secondary indexes inline sizes are the
same on all cluster nodes.
##########
File path: docs/_docs/tools/control-script.adoc
##########
@@ -521,6 +521,50 @@ validate_indexes has finished with errors (listed above).
Like `idle_verify`, index validation tool works correctly only if updates are
stopped. Otherwise, there may be a race between the checker thread and the
thread that updates the entry/index, which can result in a false positive error
report.
====
+=== Check SQL Index Inline Size
+
+During the operation of the Ignite cluster it could have a different SQL index
inline size on cluster nodes.
+For example, due to the `IGNITE_MAX_INDEX_PAYLOAD_SIZE` property value is
different on cluster nodes. The difference
+of index inline size may lead to performance drop.
+
+The `check_index_inline_sizes` command validates the indexes inline size of
given caches on all cluster nodes. The inline
+size of secondary indexes is always checked on a node join and the WARN
message is printed to the log if differ.
+
+[tabs]
+--
+tab:Shell[]
+[source,shell]
+----
+# Checks that secondary indexes inline sizes are the same on all cluster nodes.
+control.sh|bat --cache check_index_inline_sizes
+----
+--
+
+The console output if the index inline sizes are different:
Review comment:
```suggestion
If the index inline sizes are different, the console output is similar to
the data below:
```
##########
File path: docs/_docs/tools/control-script.adoc
##########
@@ -521,6 +521,50 @@ validate_indexes has finished with errors (listed above).
Like `idle_verify`, index validation tool works correctly only if updates are
stopped. Otherwise, there may be a race between the checker thread and the
thread that updates the entry/index, which can result in a false positive error
report.
====
+=== Check SQL Index Inline Size
+
+During the operation of the Ignite cluster it could have a different SQL index
inline size on cluster nodes.
+For example, due to the `IGNITE_MAX_INDEX_PAYLOAD_SIZE` property value is
different on cluster nodes. The difference
+of index inline size may lead to performance drop.
Review comment:
I suggest keeping the wording as simple as possible (for example,
_During the operation of the Ignite cluster_ = _A running Ignite cluster_ ,
etc.)
##########
File path: docs/_docs/tools/control-script.adoc
##########
@@ -521,6 +521,50 @@ validate_indexes has finished with errors (listed above).
Like `idle_verify`, index validation tool works correctly only if updates are
stopped. Otherwise, there may be a race between the checker thread and the
thread that updates the entry/index, which can result in a false positive error
report.
====
+=== Check SQL Index Inline Size
+
+During the operation of the Ignite cluster it could have a different SQL index
inline size on cluster nodes.
+For example, due to the `IGNITE_MAX_INDEX_PAYLOAD_SIZE` property value is
different on cluster nodes. The difference
+of index inline size may lead to performance drop.
+
+The `check_index_inline_sizes` command validates the indexes inline size of
given caches on all cluster nodes. The inline
+size of secondary indexes is always checked on a node join and the WARN
message is printed to the log if differ.
+
+[tabs]
+--
+tab:Shell[]
+[source,shell]
+----
+# Checks that secondary indexes inline sizes are the same on all cluster nodes.
+control.sh|bat --cache check_index_inline_sizes
+----
+--
+
+The console output if the index inline sizes are different:
Review comment:
A topic comes first, then comes a rheme (a new information about the
topic).......
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
