changeset 2328:9aa6f3f76055

Described synchronization of delete operations in keyval module.
author Vladimir Homutov <vl@nginx.com>
date Wed, 09 Jan 2019 12:12:33 +0300
parents 5ecdddc3851e
children c058e44b4111
files xml/en/docs/http/ngx_http_keyval_module.xml xml/en/docs/stream/ngx_stream_keyval_module.xml
diffstat 2 files changed, 22 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_keyval_module.xml
+++ b/xml/en/docs/http/ngx_http_keyval_module.xml
@@ -9,7 +9,7 @@
 <module name="Module ngx_http_keyval_module"
         link="/en/docs/http/ngx_http_keyval_module.html"
         lang="en"
-        rev="3">
+        rev="4">
 
 <section id="summary">
 
@@ -108,7 +108,16 @@ The optional <literal>sync</literal> par
 <link doc="../stream/ngx_stream_zone_sync_module.xml" id="zone_sync">synchronization</link>
 of the shared memory zone.
 The synchronization requires the
-<link id="keyval_timeout">timeout</link> parameter to be set.
+<literal>timeout</literal> parameter to be set.
+<note>
+If the synchronization is enabled, removal of key-value pairs (no matter
+<link doc="ngx_http_api_module.xml" id="patchHttpKeyvalZoneKeyValue">one</link>
+or
+<link doc="ngx_http_api_module.xml" id="deleteHttpKeyvalZoneData">all</link>)
+will be performed only on a target cluster node.
+The same key-value pairs on other cluster nodes
+will be removed upon <literal>timeout</literal>.
+</note>
 </para>
 
 </directive>
--- a/xml/en/docs/stream/ngx_stream_keyval_module.xml
+++ b/xml/en/docs/stream/ngx_stream_keyval_module.xml
@@ -9,7 +9,7 @@
 <module name="Module ngx_stream_keyval_module"
         link="/en/docs/stream/ngx_stream_keyval_module.html"
         lang="en"
-        rev="3">
+        rev="4">
 
 <section id="summary">
 
@@ -114,7 +114,16 @@ The optional <literal>sync</literal> par
 <link doc="ngx_stream_zone_sync_module.xml" id="zone_sync">synchronization</link>
 of the shared memory zone.
 The synchronization requires the
-<link id="keyval_timeout">timeout</link> parameter to be set.
+<literal>timeout</literal> parameter to be set.
+<note>
+If the synchronization is enabled, removal of key-value pairs (no matter
+<link doc="../http/ngx_http_api_module.xml" id="patchStreamKeyvalZoneKeyValue">one</link>
+or
+<link doc="../http/ngx_http_api_module.xml" id="deleteStreamKeyvalZoneData">all</link>)
+will be performed only on a target cluster node.
+The same key-value pairs on other cluster nodes
+will be removed upon <literal>timeout</literal>.
+</note>
 </para>
 
 </directive>