Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_keyval_module.xml @ 2769:16f6fa718be2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated TLSv1.3 support notes. Previous notes described some early development snapshot of OpenSSL 1.1.1 with disabled TLSv1.3 by default. It was then enabled in the first alpha. Further, the updated text covers later major releases such as OpenSSL 3.0.
author Sergey Kandaurov <pluknet@nginx.com>
date Thu, 30 Sep 2021 16:29:20 +0300
parents bde7cd9a1173
children 8831b3d9f332
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2028
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1 <?xml version="1.0"?>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
2
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
3 <!--
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
4 Copyright (C) Nginx, Inc.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
5 -->
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
6
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
8
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
9 <module name="Module ngx_http_keyval_module"
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
10 link="/en/docs/http/ngx_http_keyval_module.html"
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
11 lang="en"
2542
bde7cd9a1173 Added examples of state path to keyval.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2472
diff changeset
12 rev="10">
2028
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
13
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
14 <section id="summary">
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
15
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
16 <para>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
17 The <literal>ngx_http_keyval_module</literal> module (1.13.3) creates variables
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
18 with values taken from key-value pairs managed by the
2454
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2443
diff changeset
19 <link doc="ngx_http_api_module.xml" id="http_keyvals_">API</link>
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2443
diff changeset
20 or a variable (1.15.10) that can also be set with
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2443
diff changeset
21 <link doc="../njs/examples.xml" id="requests">njs</link>.
2028
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
22 </para>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
23
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
24 <para>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
25 <note>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
26 This module is available as part of our
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
27 <commercial_version>commercial subscription</commercial_version>.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
28 </note>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
29 </para>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
30
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
31 </section>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
32
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
33
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
34 <section id="example" name="Example Configuration">
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
35
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
36 <para>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
37 <example>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
38 http {
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
39
2542
bde7cd9a1173 Added examples of state path to keyval.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2472
diff changeset
40 keyval_zone zone=one:32k state=/var/lib/nginx/state/one.keyval;
2028
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
41 keyval $arg_text $text zone=one;
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
42 ...
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
43 server {
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
44 ...
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
45 location / {
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
46 return 200 $text;
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
47 }
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
48
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
49 location /api {
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
50 api write=on;
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
51 }
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
52 }
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
53 }
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
54 </example>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
55 </para>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
56
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
57 </section>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
58
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
59
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
60 <section id="directives" name="Directives">
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
61
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
62 <directive name="keyval">
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
63 <syntax>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
64 <value>key</value>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
65 <value>$variable</value>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
66 <literal>zone</literal>=<value>name</value></syntax>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
67 <default/>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
68 <context>http</context>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
69
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
70 <para>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
71 Creates a new <value>$variable</value> whose value
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
72 is looked up by the <value>key</value> in the key-value database.
2443
9d4b00f3ad2b Improved description of keyval types.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2424
diff changeset
73 Matching rules are defined by the
9d4b00f3ad2b Improved description of keyval types.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2424
diff changeset
74 <link id="keyval_type"><literal>type</literal></link> parameter of the
9d4b00f3ad2b Improved description of keyval types.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2424
diff changeset
75 <link id="keyval_zone"><literal>keyval_zone</literal></link> directive.
2028
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
76 The database is stored in a shared memory zone
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
77 specified by the <literal>zone</literal> parameter.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
78 </para>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
79
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
80 </directive>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
81
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
82
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
83 <directive name="keyval_zone">
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
84 <syntax>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
85 <literal>zone</literal>=<value>name</value>:<value>size</value>
2230
283b1e67eaa6 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 2030
diff changeset
86 [<literal>state</literal>=<value>file</value>]
283b1e67eaa6 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 2030
diff changeset
87 [<literal>timeout</literal>=<value>time</value>]
2469
98fd810c13e0 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 2454
diff changeset
88 [<literal>type</literal>=<literal>string</literal>|<literal>ip</literal>|<literal>prefix</literal>]
2230
283b1e67eaa6 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 2030
diff changeset
89 [<literal>sync</literal>]</syntax>
2028
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
90 <default/>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
91 <context>http</context>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
92
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
93 <para>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
94 Sets the <value>name</value> and <value>size</value> of the shared memory zone
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
95 that keeps the key-value database.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
96 Key-value pairs are managed by the
2030
5382bfa8a770 Corrected link in the keyval module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2028
diff changeset
97 <link doc="ngx_http_api_module.xml" id="http_keyvals_">API</link>.
2028
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
98 </para>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
99
2230
283b1e67eaa6 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 2030
diff changeset
100 <para id="keyval_state">
2028
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
101 The optional <literal>state</literal> parameter specifies a <value>file</value>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
102 that keeps the current state of the key-value database in the JSON format
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
103 and makes it persistent across nginx restarts.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
104 </para>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
105
2542
bde7cd9a1173 Added examples of state path to keyval.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2472
diff changeset
106 <para>
bde7cd9a1173 Added examples of state path to keyval.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2472
diff changeset
107 Examples:
bde7cd9a1173 Added examples of state path to keyval.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2472
diff changeset
108 <example>
bde7cd9a1173 Added examples of state path to keyval.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2472
diff changeset
109 keyval_zone zone=one:32k state=/var/lib/nginx/state/one.keyval; # path for Linux
bde7cd9a1173 Added examples of state path to keyval.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2472
diff changeset
110 keyval_zone zone=one:32k state=/var/db/nginx/state/one.keyval; # path for FreeBSD
bde7cd9a1173 Added examples of state path to keyval.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2472
diff changeset
111 </example>
bde7cd9a1173 Added examples of state path to keyval.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2472
diff changeset
112 </para>
bde7cd9a1173 Added examples of state path to keyval.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2472
diff changeset
113
2230
283b1e67eaa6 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 2030
diff changeset
114 <para id="keyval_timeout">
283b1e67eaa6 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 2030
diff changeset
115 The optional <literal>timeout</literal> parameter (1.15.0) sets
283b1e67eaa6 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 2030
diff changeset
116 the time after which key-value pairs are removed from the zone.
283b1e67eaa6 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 2030
diff changeset
117 </para>
283b1e67eaa6 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 2030
diff changeset
118
2424
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 2328
diff changeset
119 <para id="keyval_type">
2443
9d4b00f3ad2b Improved description of keyval types.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2424
diff changeset
120 The optional <literal>type</literal> parameter (1.17.1) activates
9d4b00f3ad2b Improved description of keyval types.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2424
diff changeset
121 an extra index optimized for matching the key of a certain type
9d4b00f3ad2b Improved description of keyval types.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2424
diff changeset
122 and defines matching rules when evaluating
9d4b00f3ad2b Improved description of keyval types.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2424
diff changeset
123 a <link id="keyval">keyval</link> <literal>$variable</literal>.
9d4b00f3ad2b Improved description of keyval types.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2424
diff changeset
124 <note>
9d4b00f3ad2b Improved description of keyval types.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2424
diff changeset
125 The index is stored in the same shared memory zone
9d4b00f3ad2b Improved description of keyval types.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2424
diff changeset
126 and thus requires additional storage.
9d4b00f3ad2b Improved description of keyval types.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2424
diff changeset
127 </note>
9d4b00f3ad2b Improved description of keyval types.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2424
diff changeset
128
9d4b00f3ad2b Improved description of keyval types.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2424
diff changeset
129 <list type="tag">
9d4b00f3ad2b Improved description of keyval types.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2424
diff changeset
130
9d4b00f3ad2b Improved description of keyval types.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2424
diff changeset
131 <tag-name id="keyval_type_string"><literal>type=string</literal></tag-name>
9d4b00f3ad2b Improved description of keyval types.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2424
diff changeset
132 <tag-desc>
9d4b00f3ad2b Improved description of keyval types.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2424
diff changeset
133 default, no index is enabled;
9d4b00f3ad2b Improved description of keyval types.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2424
diff changeset
134 variable lookup is performed using exact match
9d4b00f3ad2b Improved description of keyval types.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2424
diff changeset
135 of the record key and a search key
9d4b00f3ad2b Improved description of keyval types.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2424
diff changeset
136 </tag-desc>
9d4b00f3ad2b Improved description of keyval types.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2424
diff changeset
137
9d4b00f3ad2b Improved description of keyval types.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2424
diff changeset
138 <tag-name id="keyval_type_ip"><literal>type=ip</literal></tag-name>
9d4b00f3ad2b Improved description of keyval types.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2424
diff changeset
139 <tag-desc>
9d4b00f3ad2b Improved description of keyval types.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2424
diff changeset
140 the search key is the textual representation of IPv4 or IPv6 address
9d4b00f3ad2b Improved description of keyval types.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2424
diff changeset
141 or CIDR range;
9d4b00f3ad2b Improved description of keyval types.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2424
diff changeset
142 to match a record key, the search key must belong to a subnet
9d4b00f3ad2b Improved description of keyval types.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2424
diff changeset
143 specified by a record key or exactly match an IP address
9d4b00f3ad2b Improved description of keyval types.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2424
diff changeset
144 </tag-desc>
9d4b00f3ad2b Improved description of keyval types.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2424
diff changeset
145
2469
98fd810c13e0 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 2454
diff changeset
146 <tag-name id="keyval_type_prefix"><literal>type=prefix</literal></tag-name>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 2454
diff changeset
147 <tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 2454
diff changeset
148 variable lookup is performed using prefix match
98fd810c13e0 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 2454
diff changeset
149 of a record key and a search key (1.17.5);
98fd810c13e0 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 2454
diff changeset
150 to match a record key, the record key must be a prefix of the search key
98fd810c13e0 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 2454
diff changeset
151 </tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 2454
diff changeset
152
2443
9d4b00f3ad2b Improved description of keyval types.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2424
diff changeset
153 </list>
2424
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 2328
diff changeset
154 </para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 2328
diff changeset
155
2230
283b1e67eaa6 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 2030
diff changeset
156 <para id="keyval_sync">
283b1e67eaa6 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 2030
diff changeset
157 The optional <literal>sync</literal> parameter (1.15.0) enables
283b1e67eaa6 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 2030
diff changeset
158 <link doc="../stream/ngx_stream_zone_sync_module.xml" id="zone_sync">synchronization</link>
283b1e67eaa6 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 2030
diff changeset
159 of the shared memory zone.
283b1e67eaa6 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 2030
diff changeset
160 The synchronization requires the
2328
9aa6f3f76055 Described synchronization of delete operations in keyval module.
Vladimir Homutov <vl@nginx.com>
parents: 2230
diff changeset
161 <literal>timeout</literal> parameter to be set.
9aa6f3f76055 Described synchronization of delete operations in keyval module.
Vladimir Homutov <vl@nginx.com>
parents: 2230
diff changeset
162 <note>
9aa6f3f76055 Described synchronization of delete operations in keyval module.
Vladimir Homutov <vl@nginx.com>
parents: 2230
diff changeset
163 If the synchronization is enabled, removal of key-value pairs (no matter
9aa6f3f76055 Described synchronization of delete operations in keyval module.
Vladimir Homutov <vl@nginx.com>
parents: 2230
diff changeset
164 <link doc="ngx_http_api_module.xml" id="patchHttpKeyvalZoneKeyValue">one</link>
9aa6f3f76055 Described synchronization of delete operations in keyval module.
Vladimir Homutov <vl@nginx.com>
parents: 2230
diff changeset
165 or
9aa6f3f76055 Described synchronization of delete operations in keyval module.
Vladimir Homutov <vl@nginx.com>
parents: 2230
diff changeset
166 <link doc="ngx_http_api_module.xml" id="deleteHttpKeyvalZoneData">all</link>)
9aa6f3f76055 Described synchronization of delete operations in keyval module.
Vladimir Homutov <vl@nginx.com>
parents: 2230
diff changeset
167 will be performed only on a target cluster node.
9aa6f3f76055 Described synchronization of delete operations in keyval module.
Vladimir Homutov <vl@nginx.com>
parents: 2230
diff changeset
168 The same key-value pairs on other cluster nodes
9aa6f3f76055 Described synchronization of delete operations in keyval module.
Vladimir Homutov <vl@nginx.com>
parents: 2230
diff changeset
169 will be removed upon <literal>timeout</literal>.
9aa6f3f76055 Described synchronization of delete operations in keyval module.
Vladimir Homutov <vl@nginx.com>
parents: 2230
diff changeset
170 </note>
2230
283b1e67eaa6 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 2030
diff changeset
171 </para>
283b1e67eaa6 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 2030
diff changeset
172
2028
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
173 </directive>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
174
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
175 </section>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
176
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
177 </module>