kafka-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bbej...@apache.org
Subject [kafka] branch trunk updated: Fixed docs regarding caching default (#6375)
Date Wed, 06 Mar 2019 18:54:47 GMT
This is an automated email from the ASF dual-hosted git repository.

bbejeck pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/kafka.git


The following commit(s) were added to refs/heads/trunk by this push:
     new e62e230  Fixed docs regarding caching default (#6375)
e62e230 is described below

commit e62e23099b8de2414b2961e7d87be311e06db4e1
Author: A. Sophie Blee-Goldman <ableegoldman@gmail.com>
AuthorDate: Wed Mar 6 10:54:36 2019 -0800

    Fixed docs regarding caching default (#6375)
    
    The current docs are out of date regarding the default caching state.
    
    Reviewers: Guozhang Wang <wangguoz@gmail.com>,  Bill Bejeck <bbejeck@gmail.com>
---
 docs/streams/developer-guide/memory-mgmt.html | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/docs/streams/developer-guide/memory-mgmt.html b/docs/streams/developer-guide/memory-mgmt.html
index 7ae2060..f21ed34 100644
--- a/docs/streams/developer-guide/memory-mgmt.html
+++ b/docs/streams/developer-guide/memory-mgmt.html
@@ -155,10 +155,9 @@
         This means that all downstream processor nodes can see all records, whereas the state
stores see a reduced number of records.
         This does not impact correctness of the system, but is a performance optimization
for the state stores. For example, with the
         Processor API you can store a record in a state store while forwarding a different
value downstream.</p>
-      <p>Following from the example first shown in section <a class="reference internal"
href="processor-api.html#streams-developer-guide-state-store"><span class="std std-ref">State
Stores</span></a>, to enable caching, you can
-        add the <code class="docutils literal"><span class="pre">withCachingEnabled</span></code>
call (note that caches are disabled by default and there is no explicit <code class="docutils
literal"><span class="pre">withDisableCaching</span></code>
+      <p>Following from the example first shown in section <a class="reference internal"
href="processor-api.html#streams-developer-guide-state-store"><span class="std std-ref">State
Stores</span></a>, to disable caching, you can
+        add the <code class="docutils literal"><span class="pre">withCachingDisabled</span></code>
call (note that caches are enabled by default, however there is an explicit <code class="docutils
literal"><span class="pre">withCachingEnabled</span></code>
         call).</p>
-      <p><strong>Tip:</strong> Caches are disabled by default and there
is no explicit <code class="docutils literal"><span class="pre">disableCaching</span></code>
call).</p>
       <div class="highlight-java"><div class="highlight"><pre><span></span><span
class="n">StoreBuilder</span> <span class="n">countStoreBuilder</span>
<span class="o">=</span>
   <span class="n">Stores</span><span class="o">.</span><span class="na">keyValueStoreBuilder</span><span
class="o">(</span>
     <span class="n">Stores</span><span class="o">.</span><span
class="na">persistentKeyValueStore</span><span class="o">(</span><span
class="s">&quot;Counts&quot;</span><span class="o">),</span>


Mime
View raw message