Latest revision as of 06:12, 6 November 2012

[edit] Synopsis

You can use this module to perform simple caching.

server {
  location / {
    set $memcached_key $uri;
    memcached_pass     name:11211;
    default_type       text/html;
    error_page         404 @fallback;
  }
 
  location @fallback {
    proxy_pass http://backend;
  }
}

[edit] Directives

[edit] memcached_pass

Syntax:	memcached_pass address
Default:
Context:	location if in location
Reference:	memcached_pass

The backend should set the data in memcached. The memcached key is "/uri?args".

Since 0.5.9 the memcached key is now in $memcached_key.

[edit] memcached_connect_timeout

Syntax:	memcached_connect_timeout time
Default:	60s
Context:	http server location
Reference:	memcached_connect_timeout

The timeout for connecting to memcached.

[edit] memcached_read_timeout

Syntax:	memcached_read_timeout time
Default:	60s
Context:	http server location
Reference:	memcached_read_timeout

The timeout for reading from memcached.

[edit] memcached_send_timeout

Syntax:	memcached_send_timeout time
Default:	60s
Context:	http server location
Reference:	memcached_send_timeout

The timeout for sending to memcached.

[edit] memcached_buffer_size

Syntax:	memcached_buffer_size size
Default:	4k\|8k
Context:	http server location
Reference:	memcached_buffer_size

The recv/send buffer size, in bytes.

[edit] memcached_next_upstream

Syntax:	memcached_next_upstream `error` \| `timeout` \| `invalid_response` \| `not_found` \| `off` ...
Default:	error timeout
Context:	http server location
Reference:	memcached_next_upstream

Which failure conditions should cause the request to be forwarded to another upstream server? Applies only when the value in memcached_pass is an upstream with two or more servers.

[edit] Variables

[edit] $memcached_key

The value of the memcached key.

[edit] References

Original Documentation

[1] Speeding up your nginx server with memcached

[edit] See Also

The 3rd-party memc module that supports almost the whole memcached TCP protocol.
The 3rd-party Enhanced Memcached Module add some features : custom HTTP headers, hash keys, flush memcached and so on.

@@ Line 14: / Line 14: @@
    location @fallback {
-     proxy_pass backend;
+     proxy_pass http://backend;
    }
 }
@@ Line 21: / Line 21: @@
 = Directives =
 == memcached_pass ==
-'''syntax:''' ''memcached_pass [ name:port ] ''
+<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_memcached_module/memcached_pass.txt" />
-'''default:''' ''none''
-'''context:''' ''http, server, location''
 The backend should set the data in memcached.  The memcached key is "/uri?args".
@@ Line 32: / Line 28: @@
 == memcached_connect_timeout ==
-'''syntax:''' ''memcached_connect_timeout [ time ] ''
+<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_memcached_module/memcached_connect_timeout.txt" />
-'''default:''' ''60s''
-'''context:''' ''http, server, location''
 The timeout for connecting to memcached.
 == memcached_read_timeout ==
-'''syntax:''' ''memcached_read_timeout [ time ] ''
+<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_memcached_module/memcached_read_timeout.txt" />
-'''default:''' ''60s''
-'''context:''' ''http, server, location''
 The timeout for reading from memcached.
 == memcached_send_timeout ==
-'''syntax:''' ''memcached_send_timeout [ time ] ''
+<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_memcached_module/memcached_send_timeout.txt" />
-'''default:''' ''60s''
-'''context:''' ''http, server, location''
 The timeout for sending to memcached.
 == memcached_buffer_size ==
-'''syntax:''' ''memcached_buffer_size [ size ] ''
+<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_memcached_module/memcached_buffer_size.txt" />
-'''default:''' see ''getpagesize(2)''
-'''context:''' ''http, server, location''
 The recv/send buffer size, in bytes.
 == memcached_next_upstream ==
-'''syntax:''' ''memcached_next_upstream [ error | timeout | invalid_response | not_found | off ] ''
+<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_memcached_module/memcached_next_upstream.txt" />
-'''default:''' ''error timeout''
-'''context:''' ''http, server, location''
 Which failure conditions should cause the request to be forwarded to another upstream server? Applies only when the value in memcached_pass is an upstream with two or more servers.

HttpMemcachedModule