Nikita-tech-writer commented on a change in pull request #8703:
URL: https://github.com/apache/ignite/pull/8703#discussion_r584709747
##########
File path: docs/_docs/memory-configuration/data-regions.adoc
##########
@@ -84,51 +84,103 @@ tab:C++[unsupported]
== Cache Warm-Up Strategy
-The cache warm-up strategy provides an ability to load data from the disk to
the node before it is joined to the cluster.
-This prevents performance loss when the node is restarted.
+Ignite does not require you to warm memory up from disk on restarts. As soon
as a cluster is inter-connected, your application can query and compute on it.
At the same time, the memory warm-up feature is designed for low-latency
applications that prefer data being loaded in memory before it can be queried.
-[NOTE]
-====
-The cache warm-up strategy is applicable only to the data regions. It can be
configured both for all regions (by default) or for each region separately.
-====
-
-Presently, Ignite warm-up strategy implies loading data into the region,
starting with indexes, until it runs out of free space.
+Presently, the Ignite warm-up strategy implies loading data into all or
specific data regions of Ignite, starting with indexes, until it runs out of
free space. It can be configured both for all regions (by default) or for each
region separately.
To warm up all data regions, pass the configuration parameter
`LoadAllWarmUpStrategy` to the
`DataStorageConfiguration#setDefaultWarmUpConfiguration` as follows:
-[source, java]
+:xmlFile: code-snippets/xml/warm-up-strategy.xml
+:javaFile: {javaCodeDir}/WarmUpStrategy.java
+
+[tabs]
+--
+tab:XML[]
+[source,xml]
----
-setDefaultWarmUpConfiguration(loadAllWarmUpStrategy)
+include::{xmlFile}[tag=warm-all-regions,indent=0]
----
+tab:Java[]
+[source,java]
+----
+include::{javaFile}[tag=warm-all-regions,indent=0]
+----
+tab:C#/.NET[unsupported]
+
+tab:C++[unsupported]
+--
+
To warm up a specific data region, pass the configuration parameter
`LoadAllWarmUpStrategy` to the
`DataStorageConfiguration#setWarmUpConfiguration` as follows:
-[source, java]
+
+[tabs]
+--
+tab:XML[]
+[source,xml]
----
-setWarmUpConfiguration(loadAllWarmUpStrategy)
+include::{xmlFile}[tag=warm-specific-region,indent=0]
----
+tab:Java[]
+[source,java]
+----
+include::{javaFile}[tag=warm-specific-region,indent=0]
+----
+tab:C#/.NET[unsupported]
-To stop warming up all data regions, pass the configuration parameter
`NoOpWarmUpStrategy` to the
`DataStorageConfiguration#setDefaultWarmUpConfiguration` as follows:
+tab:C++[unsupported]
+--
-[source, java]
+
+To disable the warm-up for all data regions, pass the configuration parameter
`NoOpWarmUpConfiguration` to the
`DataStorageConfiguration#setDefaultWarmUpConfiguration` as follows:
+
+
+[tabs]
+--
+tab:XML[]
+[source,xml]
+----
+include::{xmlFile}[tag=disable-all-regions,indent=0]
----
-setDefaultWarmUpConfiguration(noOpWarmUpStrategy)
+tab:Java[]
+[source,java]
----
+include::{javaFile}[tag=disable-all-regions,indent=0]
+----
+tab:C#/.NET[unsupported]
-To stop warming up a specific data region, pass the configuration parameter
`NoOpWarmUpStrategy` to the `DataStorageConfiguration#setWarmUpConfiguration`
as follows:
+tab:C++[unsupported]
+--
-[source, java]
+
+To disable the warm-up for a specific data region, pass the configuration
parameter `NoOpWarmUpStrategy` to the
`DataStorageConfiguration#setWarmUpConfiguration` as follows:
+
+[tabs]
+--
+tab:XML[]
+[source,xml]
+----
+include::{xmlFile}[tag=disable-specific-region,indent=0]
+----
+tab:Java[]
+[source,java]
----
-setWarmUpConfiguration(noOpWarmUpStrategy)
+include::{javaFile}[tag=disable-specific-region,indent=0]
----
+tab:C#/.NET[unsupported]
-You can also stop the cache warming up process by using `control.sh` and JMX.
+tab:C++[unsupported]
+--
+
+
+You can also disable the cache warm-up by using `control.sh` and JMX.
Review comment:
Fixed.
##########
File path: docs/_docs/memory-configuration/data-regions.adoc
##########
@@ -84,51 +84,103 @@ tab:C++[unsupported]
== Cache Warm-Up Strategy
-The cache warm-up strategy provides an ability to load data from the disk to
the node before it is joined to the cluster.
-This prevents performance loss when the node is restarted.
+Ignite does not require you to warm memory up from disk on restarts. As soon
as a cluster is inter-connected, your application can query and compute on it.
At the same time, the memory warm-up feature is designed for low-latency
applications that prefer data being loaded in memory before it can be queried.
-[NOTE]
-====
-The cache warm-up strategy is applicable only to the data regions. It can be
configured both for all regions (by default) or for each region separately.
-====
-
-Presently, Ignite warm-up strategy implies loading data into the region,
starting with indexes, until it runs out of free space.
+Presently, the Ignite warm-up strategy implies loading data into all or
specific data regions of Ignite, starting with indexes, until it runs out of
free space. It can be configured both for all regions (by default) or for each
region separately.
To warm up all data regions, pass the configuration parameter
`LoadAllWarmUpStrategy` to the
`DataStorageConfiguration#setDefaultWarmUpConfiguration` as follows:
-[source, java]
+:xmlFile: code-snippets/xml/warm-up-strategy.xml
+:javaFile: {javaCodeDir}/WarmUpStrategy.java
+
+[tabs]
+--
+tab:XML[]
+[source,xml]
----
-setDefaultWarmUpConfiguration(loadAllWarmUpStrategy)
+include::{xmlFile}[tag=warm-all-regions,indent=0]
----
+tab:Java[]
+[source,java]
+----
+include::{javaFile}[tag=warm-all-regions,indent=0]
+----
+tab:C#/.NET[unsupported]
+
+tab:C++[unsupported]
+--
+
To warm up a specific data region, pass the configuration parameter
`LoadAllWarmUpStrategy` to the
`DataStorageConfiguration#setWarmUpConfiguration` as follows:
-[source, java]
+
+[tabs]
+--
+tab:XML[]
+[source,xml]
----
-setWarmUpConfiguration(loadAllWarmUpStrategy)
+include::{xmlFile}[tag=warm-specific-region,indent=0]
----
+tab:Java[]
+[source,java]
+----
+include::{javaFile}[tag=warm-specific-region,indent=0]
+----
+tab:C#/.NET[unsupported]
-To stop warming up all data regions, pass the configuration parameter
`NoOpWarmUpStrategy` to the
`DataStorageConfiguration#setDefaultWarmUpConfiguration` as follows:
+tab:C++[unsupported]
+--
-[source, java]
+
+To disable the warm-up for all data regions, pass the configuration parameter
`NoOpWarmUpConfiguration` to the
`DataStorageConfiguration#setDefaultWarmUpConfiguration` as follows:
+
+
+[tabs]
+--
+tab:XML[]
+[source,xml]
+----
+include::{xmlFile}[tag=disable-all-regions,indent=0]
----
-setDefaultWarmUpConfiguration(noOpWarmUpStrategy)
+tab:Java[]
+[source,java]
----
+include::{javaFile}[tag=disable-all-regions,indent=0]
+----
+tab:C#/.NET[unsupported]
-To stop warming up a specific data region, pass the configuration parameter
`NoOpWarmUpStrategy` to the `DataStorageConfiguration#setWarmUpConfiguration`
as follows:
+tab:C++[unsupported]
+--
-[source, java]
+
+To disable the warm-up for a specific data region, pass the configuration
parameter `NoOpWarmUpStrategy` to the
`DataStorageConfiguration#setWarmUpConfiguration` as follows:
+
+[tabs]
+--
+tab:XML[]
+[source,xml]
+----
+include::{xmlFile}[tag=disable-specific-region,indent=0]
+----
+tab:Java[]
+[source,java]
----
-setWarmUpConfiguration(noOpWarmUpStrategy)
+include::{javaFile}[tag=disable-specific-region,indent=0]
----
+tab:C#/.NET[unsupported]
-You can also stop the cache warming up process by using `control.sh` and JMX.
+tab:C++[unsupported]
+--
+
+
+You can also disable the cache warm-up by using `control.sh` and JMX.
-To stop the warming up using control.sh:
+
+To disable the warm-up using control.sh:
Review comment:
Fixed.
##########
File path: docs/_docs/memory-configuration/data-regions.adoc
##########
@@ -140,7 +192,9 @@ control.bat --warm-up --stop --yes
----
--
-To stop the warming up using JMX, use the method below:
+
+To disable the warm-up using JMX, use the method:
Review comment:
Fixed.
----------------------------------------------------------------
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]
