Mercurial > hg > nginx-site
comparison xml/en/docs/stream/ngx_stream_keyval_module.xml @ 2230:283b1e67eaa6
Updated docs for the upcoming NGINX Plus release.
author | Ruslan Ermilov <ru@nginx.com> |
---|---|
date | Thu, 30 Aug 2018 22:53:18 +0300 |
parents | e1337bf9f63b |
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_stream_keyval_module" | 9 <module name="Module ngx_stream_keyval_module" |
10 link="/en/docs/stream/ngx_stream_keyval_module.html" | 10 link="/en/docs/stream/ngx_stream_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_stream_keyval_module</literal> module (1.13.7) creates variables | 17 The <literal>ngx_stream_keyval_module</literal> module (1.13.7) creates variables |
83 | 83 |
84 | 84 |
85 <directive name="keyval_zone"> | 85 <directive name="keyval_zone"> |
86 <syntax> | 86 <syntax> |
87 <literal>zone</literal>=<value>name</value>:<value>size</value> | 87 <literal>zone</literal>=<value>name</value>:<value>size</value> |
88 [<literal>state</literal>=<value>file</value>]</syntax> | 88 [<literal>state</literal>=<value>file</value>] |
89 [<literal>timeout</literal>=<value>time</value>] | |
90 [<literal>sync</literal>]</syntax> | |
89 <default/> | 91 <default/> |
90 <context>stream</context> | 92 <context>stream</context> |
91 | 93 |
92 <para> | 94 <para> |
93 Sets the <value>name</value> and <value>size</value> of the shared memory zone | 95 Sets the <value>name</value> and <value>size</value> of the shared memory zone |
94 that keeps the key-value database. | 96 that keeps the key-value database. |
95 Key-value pairs are managed by the | 97 Key-value pairs are managed by the |
96 <link doc="../http/ngx_http_api_module.xml" id="stream_keyvals_">API</link>. | 98 <link doc="../http/ngx_http_api_module.xml" id="stream_keyvals_">API</link>. |
97 </para> | 99 </para> |
98 | 100 |
99 <para> | 101 <para id="keyval_state"> |
100 The optional <literal>state</literal> parameter specifies a <value>file</value> | 102 The optional <literal>state</literal> parameter specifies a <value>file</value> |
101 that keeps the current state of the key-value database in the JSON format | 103 that keeps the current state of the key-value database in the JSON format |
102 and makes it persistent across nginx restarts. | 104 and makes it persistent across nginx restarts. |
105 </para> | |
106 | |
107 <para id="keyval_timeout"> | |
108 The optional <literal>timeout</literal> parameter (1.15.0) sets | |
109 the time after which key-value pairs are removed from the zone. | |
110 </para> | |
111 | |
112 <para id="keyval_sync"> | |
113 The optional <literal>sync</literal> parameter (1.15.0) enables | |
114 <link doc="ngx_stream_zone_sync_module.xml" id="zone_sync">synchronization</link> | |
115 of the shared memory zone. | |
116 The synchronization requires the | |
117 <link id="keyval_timeout">timeout</link> parameter to be set. | |
103 </para> | 118 </para> |
104 | 119 |
105 </directive> | 120 </directive> |
106 | 121 |
107 </section> | 122 </section> |