diff xml/en/docs/stream/ngx_stream_keyval_module.xml @ 2424:dd3ac7eefeed

Updated docs for the upcoming NGINX Plus release.
author Ruslan Ermilov <ru@nginx.com>
date Mon, 02 Sep 2019 14:12:20 +0300
parents 9aa6f3f76055
children d58fc33a0830
line wrap: on
line diff
--- a/xml/en/docs/stream/ngx_stream_keyval_module.xml	Thu Aug 22 23:00:31 2019 +0300
+++ b/xml/en/docs/stream/ngx_stream_keyval_module.xml	Mon Sep 02 14:12:20 2019 +0300
@@ -9,7 +9,7 @@
 <module name="Module ngx_stream_keyval_module"
         link="/en/docs/stream/ngx_stream_keyval_module.html"
         lang="en"
-        rev="4">
+        rev="5">
 
 <section id="summary">
 
@@ -87,6 +87,7 @@
     <literal>zone</literal>=<value>name</value>:<value>size</value>
     [<literal>state</literal>=<value>file</value>]
     [<literal>timeout</literal>=<value>time</value>]
+    [<literal>type</literal>=<literal>string</literal>|<literal>ip</literal>]
     [<literal>sync</literal>]</syntax>
 <default/>
 <context>stream</context>
@@ -109,6 +110,18 @@
 the time after which key-value pairs are removed from the zone.
 </para>
 
+<para id="keyval_type">
+The optional <literal>type</literal> parameter (1.17.1) specifies
+the type of the key:
+a <literal>string</literal> (default) or <literal>ip</literal>.
+For the <literal>ip</literal> type,
+the key must be the textual representation of an IP address
+specified in CIDR notation.
+In this case,
+an additional index optimized for matching IP addresses and networks is used
+in evaluating a variable.
+</para>
+
 <para id="keyval_sync">
 The optional <literal>sync</literal> parameter (1.15.0) enables
 <link doc="ngx_stream_zone_sync_module.xml" id="zone_sync">synchronization</link>