Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_keyval_module.xml @ 2230:283b1e67eaa6

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 Thu, 30 Aug 2018 22:53:18 +0300
parents 5382bfa8a770
children 9aa6f3f76055
comparison
equal deleted inserted replaced
2229:f134633cff5c 2230:283b1e67eaa6
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="2"> 12 rev="3">
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
77 77
78 78
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>]</syntax> 82 [<literal>state</literal>=<value>file</value>]
83 [<literal>timeout</literal>=<value>time</value>]
84 [<literal>sync</literal>]</syntax>
83 <default/> 85 <default/>
84 <context>http</context> 86 <context>http</context>
85 87
86 <para> 88 <para>
87 Sets the <value>name</value> and <value>size</value> of the shared memory zone 89 Sets the <value>name</value> and <value>size</value> of the shared memory zone
88 that keeps the key-value database. 90 that keeps the key-value database.
89 Key-value pairs are managed by the 91 Key-value pairs are managed by the
90 <link doc="ngx_http_api_module.xml" id="http_keyvals_">API</link>. 92 <link doc="ngx_http_api_module.xml" id="http_keyvals_">API</link>.
91 </para> 93 </para>
92 94
93 <para> 95 <para id="keyval_state">
94 The optional <literal>state</literal> parameter specifies a <value>file</value> 96 The optional <literal>state</literal> parameter specifies a <value>file</value>
95 that keeps the current state of the key-value database in the JSON format 97 that keeps the current state of the key-value database in the JSON format
96 and makes it persistent across nginx restarts. 98 and makes it persistent across nginx restarts.
99 </para>
100
101 <para id="keyval_timeout">
102 The optional <literal>timeout</literal> parameter (1.15.0) sets
103 the time after which key-value pairs are removed from the zone.
104 </para>
105
106 <para id="keyval_sync">
107 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>
109 of the shared memory zone.
110 The synchronization requires the
111 <link id="keyval_timeout">timeout</link> parameter to be set.
97 </para> 112 </para>
98 113
99 </directive> 114 </directive>
100 115
101 </section> 116 </section>