diff options
| author | Joe Gordon <jogo@pinterest.com> | 2016-10-31 14:04:00 -0700 |
|---|---|---|
| committer | Joe Gordon <jogo@pinterest.com> | 2016-11-03 09:52:53 -0700 |
| commit | 3613587536673154b45dbb8fe482e736f13a3a36 (patch) | |
| tree | eded78af8c6e3aa53d1f493c4d770fa36f2a4577 /docs/getting_started.rst | |
| parent | f1c939be4dbc99aa6cc9d90b24c500893d65097d (diff) | |
| download | pymemcache-3613587536673154b45dbb8fe482e736f13a3a36.tar.gz | |
Add optional support for unicode keys
memcached's ASCII protocol supports unicode keys, so lets support them
as well. Since using unicode keys for memcache is uncommon and to
preserve the previous behavior disable support by default.
Diffstat (limited to 'docs/getting_started.rst')
| -rw-r--r-- | docs/getting_started.rst | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/docs/getting_started.rst b/docs/getting_started.rst index 2a93d09..c5f5b2e 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -63,8 +63,11 @@ This client implements the ASCII protocol of memcached. This means keys should n contain any of the following illegal characters: > Keys cannot have spaces, new lines, carriage returns, or null characters. We suggest that if you have unicode characters, or long keys, you use an effective -hashing mechanism before calling this client. At Pinterest, we have found that murmur3 hash is a -great candidate for this. +hashing mechanism before calling this client. At Pinterest, we have found that +murmur3 hash is a great candidate for this. Alternatively you can +set `allow_unicode_keys` to support unicode keys, but beware of +what unicode encoding you use to make sure multiple clients can find the +same key. Best Practices |