diff options
| author | Nicholas Charriere <nicholascharriere@gmail.com> | 2016-10-28 16:23:25 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-10-28 16:23:25 -0700 |
| commit | cc918aa8eb6c9d54cb49c3a92c574f6d2175edb1 (patch) | |
| tree | 78c54b290cd3d5a016482784b335ecdff0b25b6d | |
| parent | 29a638a72e8f75b17e1c5eee67ec1ae102e03927 (diff) | |
| parent | aa2c92303aeecec2a8c0ff70c10586750b18027c (diff) | |
| download | pymemcache-cc918aa8eb6c9d54cb49c3a92c574f6d2175edb1.tar.gz | |
Merge pull request #126 from pinterest/doc-keys
Doc about keys
| -rw-r--r-- | docs/getting_started.rst | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/getting_started.rst b/docs/getting_started.rst index 10b66c1..2a93d09 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -57,6 +57,16 @@ Serialization result = client.get('key') +Key Constraints +--------------- +This client implements the ASCII protocol of memcached. This means keys should not +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. + + Best Practices --------------- |