summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicholas Charriere <nicholas@pinterest.com>2016-10-28 15:46:33 -0700
committerNicholas Charriere <nicholas@pinterest.com>2016-10-28 15:46:33 -0700
commitaa2c92303aeecec2a8c0ff70c10586750b18027c (patch)
treef9cca36aef276a58f823aa912feda0974286b698
parentbfea304918cd0b950566f0c15e6bdcc0e5741364 (diff)
downloadpymemcache-doc-keys.tar.gz
Doc about keysdoc-keys
-rw-r--r--docs/getting_started.rst10
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
---------------