Synchronized core docs from refs/heads/main

infinispan · Jan 30, 2025 · bb36132 · bb36132
1 parent 6448a39
commit bb36132
Show file tree

Hide file tree

Showing 23 changed files with 3,573 additions and 33 deletions.
diff --git a/docs/dev/cheat-sheets/cache-configuration.html b/docs/dev/cheat-sheets/cache-configuration.html
@@ -1196,7 +1196,7 @@ <h2 id="configuration_formats"><a class="anchor" href="#configuration_formats"><
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2025-01-29 12:58:56 UTC
+Last updated 2025-01-30 11:00:15 UTC
 </div>
 </div>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>

diff --git a/docs/dev/index.html b/docs/dev/index.html
@@ -634,7 +634,7 @@ <h2 id="developing_applications_with_infinispan" class="discrete">Developing app
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2025-01-29 12:58:56 UTC
+Last updated 2025-01-30 11:00:15 UTC
 </div>
 </div>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>

diff --git a/docs/dev/titles/cli/cli.html b/docs/dev/titles/cli/cli.html
@@ -6539,7 +6539,7 @@ <h4 id="see_also_32"><a class="anchor" href="#see_also_32"></a>9.44.4. SEE ALSO<
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2025-01-29 12:58:56 UTC
+Last updated 2025-01-30 11:00:15 UTC
 </div>
 </div>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>

diff --git a/docs/dev/titles/configuring/configuring.html b/docs/dev/titles/configuring/configuring.html
@@ -13161,7 +13161,7 @@ <h4 id="asynchronous_thread_pool" class="discrete">Asynchronous thread pool</h4>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2025-01-29 12:58:56 UTC
+Last updated 2025-01-30 11:00:15 UTC
 </div>
 </div>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>

diff --git a/docs/dev/titles/contributing/contributing.html b/docs/dev/titles/contributing/contributing.html
@@ -3632,7 +3632,7 @@ <h3 id="infinispan_methods_and_corresponding_verbs"><a class="anchor" href="#inf
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2025-01-29 12:58:56 UTC
+Last updated 2025-01-30 11:00:15 UTC
 </div>
 </div>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>

diff --git a/docs/dev/titles/developing/developing.html b/docs/dev/titles/developing/developing.html
@@ -548,7 +548,7 @@ <h1>Infinispan Developer Guide</h1>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2025-01-29 12:58:56 UTC
+Last updated 2025-01-30 11:00:15 UTC
 </div>
 </div>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>

diff --git a/docs/dev/titles/embedding/embedding.html b/docs/dev/titles/embedding/embedding.html
@@ -7444,7 +7444,7 @@ <h3 id="extending_the_configuration_builders_and_parsers"><a class="anchor" href
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2025-01-29 12:58:56 UTC
+Last updated 2025-01-30 11:00:15 UTC
 </div>
 </div>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>

diff --git a/docs/dev/titles/encoding/encoding.html b/docs/dev/titles/encoding/encoding.html
@@ -2624,7 +2624,7 @@ <h3 id="converting-data-on-demand_transcoding"><a class="anchor" href="#converti
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2025-01-29 12:58:56 UTC
+Last updated 2025-01-30 11:00:15 UTC
 </div>
 </div>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>

diff --git a/docs/dev/titles/getting_started/getting_started.html b/docs/dev/titles/getting_started/getting_started.html
@@ -758,7 +758,7 @@ <h3 id="mvn_archetypes"><a class="anchor" href="#mvn_archetypes"></a>1.2. Genera
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2025-01-29 12:58:56 UTC
+Last updated 2025-01-30 11:00:15 UTC
 </div>
 </div>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>

diff --git a/docs/dev/titles/hibernate/hibernate.html b/docs/dev/titles/hibernate/hibernate.html
@@ -1485,7 +1485,7 @@ <h3 id="using_minimal_puts"><a class="anchor" href="#using_minimal_puts"></a>1.6
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2025-01-29 12:58:56 UTC
+Last updated 2025-01-30 11:00:15 UTC
 </div>
 </div>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>

diff --git a/docs/dev/titles/hotrod_java/hotrod_java.html b/docs/dev/titles/hotrod_java/hotrod_java.html
@@ -3627,7 +3627,7 @@ <h4 id="adding_the_test_container_to_your_project_dependencies"><a class="anchor
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2025-01-29 12:58:56 UTC
+Last updated 2025-01-30 11:00:15 UTC
 </div>
 </div>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>

diff --git a/docs/dev/titles/hotrod_protocol/hotrod_protocol.html b/docs/dev/titles/hotrod_protocol/hotrod_protocol.html
@@ -8939,7 +8939,7 @@ <h3 id="hot_rod_protocol_4_1"><a class="anchor" href="#hot_rod_protocol_4_1"></a
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2025-01-29 12:58:56 UTC
+Last updated 2025-01-30 11:00:15 UTC
 </div>
 </div>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>

diff --git a/docs/dev/titles/memcached/memcached.html b/docs/dev/titles/memcached/memcached.html
@@ -701,7 +701,7 @@ <h4 id="individual_statistics"><a class="anchor" href="#individual_statistics"><
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2025-01-29 12:58:56 UTC
+Last updated 2025-01-30 11:00:15 UTC
 </div>
 </div>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>

diff --git a/docs/dev/titles/query/query.html b/docs/dev/titles/query/query.html
@@ -542,7 +542,11 @@ <h1>Querying Infinispan caches</h1>
 <ul class="sectlevel2">
 <li><a href="#indexing-caches_indexing-caches">1.1. Configuring Infinispan to index caches</a>
 <ul class="sectlevel3">
-<li><a href="#indexing-configuration_indexing-caches">1.1.1. Index configuration</a></li>
+<li><a href="#indexing-configuration_indexing-caches">1.1.1. Index configuration</a>
+<ul class="sectlevel5">
+<li><a href="#automatic_strategy_and_shared_cache_stores">Automatic strategy and shared cache stores</a></li>
+</ul>
+</li>
 </ul>
 </li>
 <li><a href="#indexing-annotations_indexing-caches">1.2. Infinispan native indexing annotations</a></li>
@@ -910,7 +914,7 @@ <h6 id="index_path" class="discrete">Index path</h6>
 </tr>
 </table>
 </div>
-<h5 id="index_startup_mode" class="discrete">Index startup mode</h5>
+<h5 id="indexing-configuration_startup-mode" class="discrete">Index startup mode</h5>
 <div class="paragraph">
 <p>When Infinispan starts caches it can perform operations to ensure the index is consistent with data in the cache.
 By default it:</p>
@@ -1006,6 +1010,49 @@ <h5 id="index_startup_mode" class="discrete">Index startup mode</h5>
 &lt;/distributed-cache&gt;</code></pre>
 </div>
 </div>
+<div class="sect5">
+<h6 id="automatic_strategy_and_shared_cache_stores"><a class="anchor" href="#automatic_strategy_and_shared_cache_stores"></a>Automatic strategy and shared cache stores</h6>
+<div class="paragraph">
+<p>In case of:</p>
+</div>
+<div class="olist arabic">
+<ol class="arabic">
+<li>
+<p>A shared storage is configured</p>
+</li>
+<li>
+<p>The indexes are persistent on file system</p>
+</li>
+</ol>
+</div>
+<div class="paragraph">
+<p>The <code>AUTO</code> startup mode will apply the <code>REINDEX</code> strategy.
+This is done in order to not miss potential updates in case of crash and recovery of an indexed node.</p>
+</div>
+<div class="paragraph">
+<p>Thus <code>AUTO</code> in this case may penalize the average user using a shared cache store that does not do any eviction,
+since more reindex than necessary will be triggered.
+For this reason if:</p>
+</div>
+<div class="olist arabic">
+<ol class="arabic">
+<li>
+<p>A shared storage is configured</p>
+</li>
+<li>
+<p>The indexes are persistent on file system</p>
+</li>
+<li>
+<p>Automatic evictions are not possible: cache memory <code>max-size</code> and <code>max-count</code> are not used</p>
+</li>
+<li>
+<p>Manual eviction using the embedded API <code>cache.eviction()</code> is not used</p>
+</li>
+</ol>
+</div>
+<div class="paragraph">
+<p>to use <code>NONE</code> in place of <code>AUTO</code> as the index startup strategy.</p>
+</div>
 <h5 id="indexing_mode" class="discrete">Indexing mode</h5>
 <div class="paragraph">
 <p><code>indexing-mode</code> controls how cache operations are propagated to the indexes.</p>
@@ -1229,6 +1276,7 @@ <h5 id="index_sharding" class="discrete">Index sharding</h5>
 </div>
 </div>
 </div>
+</div>
 <div class="sect2">
 <h3 id="indexing-annotations_indexing-caches"><a class="anchor" href="#indexing-annotations_indexing-caches"></a>1.2. Infinispan native indexing annotations</h3>
 <div class="paragraph">
@@ -4398,7 +4446,7 @@ <h3 id="tuning-query-performance_query-monitoring-tuning"><a class="anchor" href
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2025-01-29 12:58:56 UTC
+Last updated 2025-01-30 11:00:15 UTC
 </div>
 </div>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>

diff --git a/docs/dev/titles/resp/resp-endpoint.html b/docs/dev/titles/resp/resp-endpoint.html
@@ -1377,7 +1377,7 @@ <h3 id="redis-commands_resp-endpoint"><a class="anchor" href="#redis-commands_re
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2025-01-29 12:58:56 UTC
+Last updated 2025-01-30 11:00:15 UTC
 </div>
 </div>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>

diff --git a/docs/dev/titles/rest/rest.html b/docs/dev/titles/rest/rest.html
@@ -7650,7 +7650,7 @@ <h3 id="rest_server_client_http"><a class="anchor" href="#rest_server_client_htt
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2025-01-29 12:58:56 UTC
+Last updated 2025-01-30 11:00:15 UTC
 </div>
 </div>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>

diff --git a/docs/dev/titles/security/security.html b/docs/dev/titles/security/security.html
@@ -6150,7 +6150,7 @@ <h4 id="cross_site_replication" class="discrete">Cross-site replication</h4>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2025-01-29 12:58:56 UTC
+Last updated 2025-01-30 11:00:15 UTC
 </div>
 </div>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>

diff --git a/docs/dev/titles/server/server.html b/docs/dev/titles/server/server.html
@@ -13716,7 +13716,7 @@ <h3 id="configuring-server-benchmark-cli_server"><a class="anchor" href="#config
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2025-01-29 12:58:56 UTC
+Last updated 2025-01-30 11:00:15 UTC
 </div>
 </div>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>

diff --git a/docs/dev/titles/spring/spring.html b/docs/dev/titles/spring/spring.html
@@ -1006,7 +1006,7 @@ <h3 id="externalizing-spring-session_externalizing-sessions-spring"><a class="an
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2025-01-29 12:58:56 UTC
+Last updated 2025-01-30 11:00:15 UTC
 </div>
 </div>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>

diff --git a/docs/dev/titles/spring_boot/starter.html b/docs/dev/titles/spring_boot/starter.html
@@ -1221,7 +1221,7 @@ <h2 id="spring-application-properties"><a class="anchor" href="#spring-applicati
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2025-01-29 12:58:56 UTC
+Last updated 2025-01-30 11:00:15 UTC
 </div>
 </div>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>

diff --git a/docs/dev/titles/tuning/tuning.html b/docs/dev/titles/tuning/tuning.html
@@ -2673,7 +2673,7 @@ <h4 id="use_simple_cache_for_local_caches" class="discrete">Use simple cache for
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2025-01-29 12:58:56 UTC
+Last updated 2025-01-30 11:00:15 UTC
 </div>
 </div>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>