Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_keyval_module.xml @ 2424:dd3ac7eefeed

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 9d4b00f3ad2b
comparison
equal deleted inserted replaced
2423:21f1376238b0 2424:dd3ac7eefeed
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
8 8
9 <module name="Module ngx_http_keyval_module" 9 <module name="Module ngx_http_keyval_module"
10 link="/en/docs/http/ngx_http_keyval_module.html" 10 link="/en/docs/http/ngx_http_keyval_module.html"
11 lang="en" 11 lang="en"
12 rev="4"> 12 rev="5">
13 13
14 <section id="summary"> 14 <section id="summary">
15 15
16 <para> 16 <para>
17 The <literal>ngx_http_keyval_module</literal> module (1.13.3) creates variables 17 The <literal>ngx_http_keyval_module</literal> module (1.13.3) creates variables
79 <directive name="keyval_zone"> 79 <directive name="keyval_zone">
80 <syntax> 80 <syntax>
81 <literal>zone</literal>=<value>name</value>:<value>size</value> 81 <literal>zone</literal>=<value>name</value>:<value>size</value>
82 [<literal>state</literal>=<value>file</value>] 82 [<literal>state</literal>=<value>file</value>]
83 [<literal>timeout</literal>=<value>time</value>] 83 [<literal>timeout</literal>=<value>time</value>]
84 [<literal>type</literal>=<literal>string</literal>|<literal>ip</literal>]
84 [<literal>sync</literal>]</syntax> 85 [<literal>sync</literal>]</syntax>
85 <default/> 86 <default/>
86 <context>http</context> 87 <context>http</context>
87 88
88 <para> 89 <para>
99 </para> 100 </para>
100 101
101 <para id="keyval_timeout"> 102 <para id="keyval_timeout">
102 The optional <literal>timeout</literal> parameter (1.15.0) sets 103 The optional <literal>timeout</literal> parameter (1.15.0) sets
103 the time after which key-value pairs are removed from the zone. 104 the time after which key-value pairs are removed from the zone.
105 </para>
106
107 <para id="keyval_type">
108 The optional <literal>type</literal> parameter (1.17.1) specifies
109 the type of the key:
110 a <literal>string</literal> (default) or <literal>ip</literal>.
111 For the <literal>ip</literal> type,
112 the key must be the textual representation of an IP address
113 specified in CIDR notation.
114 In this case,
115 an additional index optimized for matching IP addresses and networks is used
116 in evaluating a variable.
104 </para> 117 </para>
105 118
106 <para id="keyval_sync"> 119 <para id="keyval_sync">
107 The optional <literal>sync</literal> parameter (1.15.0) enables 120 The optional <literal>sync</literal> parameter (1.15.0) enables
108 <link doc="../stream/ngx_stream_zone_sync_module.xml" id="zone_sync">synchronization</link> 121 <link doc="../stream/ngx_stream_zone_sync_module.xml" id="zone_sync">synchronization</link>