comparison xml/en/docs/http/ngx_http_fastcgi_module.xml @ 1028:e582a10b1917

Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
author Vladimir Homutov <vl@nginx.com>
date Mon, 02 Dec 2013 15:24:51 +0400
parents af77dd40abeb
children 379cb572a7ec
comparison
equal deleted inserted replaced
1027:dd64ce140de2 1028:e582a10b1917
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
9 9
10 <module name="Module ngx_http_fastcgi_module" 10 <module name="Module ngx_http_fastcgi_module"
11 link="/en/docs/http/ngx_http_fastcgi_module.html" 11 link="/en/docs/http/ngx_http_fastcgi_module.html"
12 lang="en" 12 lang="en"
13 rev="12"> 13 rev="13">
14 14
15 <section id="summary"> 15 <section id="summary">
16 16
17 <para> 17 <para>
18 The <literal>ngx_http_fastcgi_module</literal> module allows passing 18 The <literal>ngx_http_fastcgi_module</literal> module allows passing
361 are loaded (by default, 100). 361 are loaded (by default, 100).
362 Besides, the duration of one iteration is limited by the 362 Besides, the duration of one iteration is limited by the
363 <literal>loader_threshold</literal> parameter (by default, 200 milliseconds). 363 <literal>loader_threshold</literal> parameter (by default, 200 milliseconds).
364 Between iterations, a pause configured by the <literal>loader_sleep</literal> 364 Between iterations, a pause configured by the <literal>loader_sleep</literal>
365 parameter (by default, 50 milliseconds) is made. 365 parameter (by default, 50 milliseconds) is made.
366 </para>
367
368 </directive>
369
370
371 <directive name="fastcgi_cache_purge">
372 <syntax>string ...</syntax>
373 <default/>
374 <context>http</context>
375 <context>server</context>
376 <context>location</context>
377 <appeared-in>1.5.7</appeared-in>
378
379 <para>
380 Defines conditions under which the request will be considered a cache
381 purge request.
382 If at least one value of the string parameters is not empty and is not equal
383 to “0” then the cache entry with a corresponding
384 <link id="fastcgi_cache_key">cache key</link> is removed.
385 The result of successful operation is indicated by returning
386 the <http-status code="204" text="No Content"/> response.
387 </para>
388
389 <para>
390 If the <link id="fastcgi_cache_key">cache key</link> of a purge request ends
391 with an asterisk (“<literal>*</literal>”), all cache entries matching the
392 wildcard key will be removed from the cache.
393 </para>
394
395 <para>
396 Example configuration:
397 <example>
398 fastcgi_cache_path /data/nginx/cache keys_zone=cache_zone:10m;
399
400 map $request_method $purge_method {
401 PURGE 1;
402 default 0;
403 }
404
405 server {
406 ...
407 location / {
408 fastcgi_pass backend;
409 fastcgi_cache cache_zone;
410 fastcgi_cache_key $uri;
411 fastcgi_cache_purge $purge_method;
412 }
413 }
414 </example>
415 <note>
416 This functionality is available as part of our <commercial_version/> only.
417 </note>
366 </para> 418 </para>
367 419
368 </directive> 420 </directive>
369 421
370 422