From aa2c92303aeecec2a8c0ff70c10586750b18027c Mon Sep 17 00:00:00 2001 From: Nicholas Charriere Date: Fri, 28 Oct 2016 15:46:33 -0700 Subject: Doc about keys --- docs/getting_started.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) 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 --------------- -- cgit v1.2.1