summaryrefslogtreecommitdiff
path: root/docs/commands.rst
diff options
context:
space:
mode:
authorChayim <chayim@users.noreply.github.com>2021-12-30 12:52:11 +0200
committerGitHub <noreply@github.com>2021-12-30 12:52:11 +0200
commitbc3dbb45d7236f96d614c33684a94f3e0fd9ac4a (patch)
tree5da61d39c34e3ad558be7c78c9f54c185084968e /docs/commands.rst
parentdeaaa536568e50b6ce958de0dd6306392e98f13e (diff)
downloadredis-py-bc3dbb45d7236f96d614c33684a94f3e0fd9ac4a.tar.gz
Documentation cleanup (#1841)
Diffstat (limited to 'docs/commands.rst')
-rw-r--r--docs/commands.rst30
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/commands.rst b/docs/commands.rst
new file mode 100644
index 0000000..d35f290
--- /dev/null
+++ b/docs/commands.rst
@@ -0,0 +1,30 @@
+Redis Commands
+##############
+
+Core Commands
+*************
+
+The following functions can be used to replicate their equivalent `Redis command <https://redis.io/commands>`_. Generally they can be used as functions on your redis connection. For the simplest example, see below:
+
+Getting and settings data in redis::
+
+ import redis
+ r = redis.Redis(decode_responses=True)
+ r.set('mykey', 'thevalueofmykey')
+ r.get('mykey')
+
+.. autoclass:: redis.commands.core.CoreCommands
+ :inherited-members:
+
+Sentinel Commands
+*****************
+.. autoclass:: redis.commands.sentinel.SentinelCommands
+ :inherited-members:
+
+Redis Cluster Commands
+**********************
+
+The following `Redis commands <https://redis.io/commands>`_ are available within a `Redis Cluster <https://redis.io/topics/cluster-tutorial>`_. Generally they can be used as functions on your redis connection.
+
+.. autoclass:: redis.commands.cluster.RedisClusterCommands
+ :inherited-members: