Skip to content

Commit 60467eb

Browse files
christophstroblchristophstrobl
committed
DATAREDIS-279 - Update documentation
Added RedisTemplate command reference.
1 parent cd7ef5f commit 60467eb

File tree

2 files changed

+182
-15
lines changed

2 files changed

+182
-15
lines changed

‎docs/src/reference/docbook/appendix/appendix-command-reference.xml

Lines changed: 180 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,180 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<appendix xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="appendix-command-reference" xmlns:xi="http://www.w3.org/2001/XInclude">
3+
<title>Spring Data Redis Supported Commands</title>
4+
5+
<table>
6+
<title>Redis commands supported by <classname>RedisTemplate</classname>.</title>
7+
<tgroup cols="2">
8+
<colspec colwidth="2*"/>
9+
<colspec colwidth="1*"/>
10+
<thead>
11+
<row>
12+
<entry>Command</entry>
13+
<entry>Template Support</entry>
14+
</row>
15+
</thead>
16+
<tbody>
17+
<row><entry><code>APPEND</code></entry><entry>X</entry></row>
18+
<row><entry><code>AUTH</code></entry><entry>X</entry></row>
19+
<row><entry><code>BGREWRITEAOF</code></entry><entry>X</entry></row>
20+
<row><entry><code>BGSAVE</code></entry><entry>X</entry></row>
21+
<row><entry><code>BITCOUNT</code></entry><entry>X</entry></row>
22+
<row><entry><code>BITOP</code></entry><entry>X</entry></row>
23+
<row><entry><code>BLPOP</code></entry><entry>X</entry></row>
24+
<row><entry><code>BRPOP</code></entry><entry>X</entry></row>
25+
<row><entry><code>BRPOPLPUSH</code></entry><entry>X</entry></row>
26+
<row><entry><code>CLIENT GETNAME</code></entry><entry>-</entry></row>
27+
<row><entry><code>CLIENT KILL</code></entry><entry>-</entry></row>
28+
<row><entry><code>CLIENT LIST</code></entry><entry>-</entry></row>
29+
<row><entry><code>CLIENT SETNAME</code></entry><entry>-</entry></row>
30+
<row><entry><code>CONFIG GET</code></entry><entry>X</entry></row>
31+
<row><entry><code>CONFIG RESETSTAT</code></entry><entry>X</entry></row>
32+
<row><entry><code>CONFIG REWRITE</code></entry><entry>-</entry></row>
33+
<row><entry><code>CONFIG SET</code></entry><entry>X</entry></row>
34+
<row><entry><code>DBSIZE</code></entry><entry>X</entry></row>
35+
<row><entry><code>DEBUG OBJECT</code></entry><entry>-</entry></row>
36+
<row><entry><code>DEBUG SEGFAULT</code></entry><entry>-</entry></row>
37+
<row><entry><code>DECR</code></entry><entry>X</entry></row>
38+
<row><entry><code>DECRBY</code></entry><entry>X</entry></row>
39+
<row><entry><code>DEL</code></entry><entry>X</entry></row>
40+
<row><entry><code>DISCARD</code></entry><entry>X</entry></row>
41+
<row><entry><code>DUMP</code></entry><entry>X</entry></row>
42+
<row><entry><code>ECHO</code></entry><entry>X</entry></row>
43+
<row><entry><code>EVAL</code></entry><entry>X</entry></row>
44+
<row><entry><code>EVALSHA</code></entry><entry>X</entry></row>
45+
<row><entry><code>EXEC</code></entry><entry>X</entry></row>
46+
<row><entry><code>EXISTS</code></entry><entry>X</entry></row>
47+
<row><entry><code>EXPIRE</code></entry><entry>X</entry></row>
48+
<row><entry><code>EXPIREAT</code></entry><entry>X</entry></row>
49+
<row><entry><code>FLUSHALL</code></entry><entry>X</entry></row>
50+
<row><entry><code>FLUSHDB</code></entry><entry>X</entry></row>
51+
<row><entry><code>GET</code></entry><entry>X</entry></row>
52+
<row><entry><code>GETBIT</code></entry><entry>X</entry></row>
53+
<row><entry><code>GETRANGE</code></entry><entry>X</entry></row>
54+
<row><entry><code>GETSET</code></entry><entry>X</entry></row>
55+
<row><entry><code>HDEL</code></entry><entry>X</entry></row>
56+
<row><entry><code>HEXISTS</code></entry><entry>X</entry></row>
57+
<row><entry><code>HGET</code></entry><entry>X</entry></row>
58+
<row><entry><code>HGETALL</code></entry><entry>X</entry></row>
59+
<row><entry><code>HINCRBY</code></entry><entry>X</entry></row>
60+
<row><entry><code>HINCRBYFLOAT</code></entry><entry>X</entry></row>
61+
<row><entry><code>HKEYS</code></entry><entry>X</entry></row>
62+
<row><entry><code>HLEN</code></entry><entry>X</entry></row>
63+
<row><entry><code>HMGET</code></entry><entry>X</entry></row>
64+
<row><entry><code>HMSET</code></entry><entry>X</entry></row>
65+
<row><entry><code>HSCAN</code></entry><entry>-</entry></row>
66+
<row><entry><code>HSET</code></entry><entry>X</entry></row>
67+
<row><entry><code>HSETNX</code></entry><entry>X</entry></row>
68+
<row><entry><code>HVALS</code></entry><entry>X</entry></row>
69+
<row><entry><code>INCR</code></entry><entry>X</entry></row>
70+
<row><entry><code>INCRBY</code></entry><entry>X</entry></row>
71+
<row><entry><code>INCRBYFLOAT</code></entry><entry>X</entry></row>
72+
<row><entry><code>INFO</code></entry><entry>X</entry></row>
73+
<row><entry><code>KEYS</code></entry><entry>X</entry></row>
74+
<row><entry><code>LASTSAVE</code></entry><entry>X</entry></row>
75+
<row><entry><code>LINDEX</code></entry><entry>X</entry></row>
76+
<row><entry><code>LINSERT</code></entry><entry>X</entry></row>
77+
<row><entry><code>LLEN</code></entry><entry>X</entry></row>
78+
<row><entry><code>LPOP</code></entry><entry>X</entry></row>
79+
<row><entry><code>LPUSH</code></entry><entry>X</entry></row>
80+
<row><entry><code>LPUSHX</code></entry><entry>X</entry></row>
81+
<row><entry><code>LRANGE</code></entry><entry>X</entry></row>
82+
<row><entry><code>LREM</code></entry><entry>X</entry></row>
83+
<row><entry><code>LSET</code></entry><entry>X</entry></row>
84+
<row><entry><code>LTRIM</code></entry><entry>X</entry></row>
85+
<row><entry><code>MGET</code></entry><entry>X</entry></row>
86+
<row><entry><code>MIGRATE</code></entry><entry>-</entry></row>
87+
<row><entry><code>MONITOR</code></entry><entry>-</entry></row>
88+
<row><entry><code>MOVE</code></entry><entry>X</entry></row>
89+
<row><entry><code>MSET</code></entry><entry>X</entry></row>
90+
<row><entry><code>MSETNX</code></entry><entry>X</entry></row>
91+
<row><entry><code>MULTI</code></entry><entry>X</entry></row>
92+
<row><entry><code>OBJECT</code></entry><entry>-</entry></row>
93+
<row><entry><code>PERSIST</code></entry><entry>X</entry></row>
94+
<row><entry><code>PEXIPRE</code></entry><entry>X</entry></row>
95+
<row><entry><code>PEXPIREAT</code></entry><entry>X</entry></row>
96+
<row><entry><code>PING</code></entry><entry>X</entry></row>
97+
<row><entry><code>PSETEX</code></entry><entry>-</entry></row>
98+
<row><entry><code>PSUBSCRIBE</code></entry><entry>X</entry></row>
99+
<row><entry><code>PTTL</code></entry><entry>X</entry></row>
100+
<row><entry><code>PUBLISH</code></entry><entry>X</entry></row>
101+
<row><entry><code>PUBSUB</code></entry><entry>-</entry></row>
102+
<row><entry><code>PUBSUBSCRIBE</code></entry><entry>-</entry></row>
103+
<row><entry><code>QUIT</code></entry><entry>X</entry></row>
104+
<row><entry><code>RANDOMKEY</code></entry><entry>X</entry></row>
105+
<row><entry><code>RENAME</code></entry><entry>X</entry></row>
106+
<row><entry><code>RENAMENX</code></entry><entry>X</entry></row>
107+
<row><entry><code>RESTORE</code></entry><entry>X</entry></row>
108+
<row><entry><code>RPOP</code></entry><entry>X</entry></row>
109+
<row><entry><code>RPOPLPUSH</code></entry><entry>X</entry></row>
110+
<row><entry><code>RPUSH</code></entry><entry>X</entry></row>
111+
<row><entry><code>RPUSHX</code></entry><entry>X</entry></row>
112+
<row><entry><code>SADD</code></entry><entry>X</entry></row>
113+
<row><entry><code>SAVE</code></entry><entry>X</entry></row>
114+
<row><entry><code>SCAN</code></entry><entry>-</entry></row>
115+
<row><entry><code>SCARD</code></entry><entry>X</entry></row>
116+
<row><entry><code>SCRIPT EXITS</code></entry><entry>X</entry></row>
117+
<row><entry><code>SCRIPT FLUSH</code></entry><entry>X</entry></row>
118+
<row><entry><code>SCRIPT KILL</code></entry><entry>X</entry></row>
119+
<row><entry><code>SCRIPT LOAD</code></entry><entry>X</entry></row>
120+
<row><entry><code>SDIFF</code></entry><entry>X</entry></row>
121+
<row><entry><code>SDIFFSTORE</code></entry><entry>X</entry></row>
122+
<row><entry><code>SELECT</code></entry><entry>X</entry></row>
123+
<row><entry><code>SENTINEL FAILOVER</code></entry><entry>-</entry></row>
124+
<row><entry><code>SENTINEL GET-MASTER-ADD-BY-NAME</code></entry><entry>-</entry></row>
125+
<row><entry><code>SENTINEL MASTER</code></entry><entry>-</entry></row>
126+
<row><entry><code>SENTINEL MASTERS</code></entry><entry>-</entry></row>
127+
<row><entry><code>SENTINEL MONITOR</code></entry><entry>-</entry></row>
128+
<row><entry><code>SENTINEL REMOVE</code></entry><entry>-</entry></row>
129+
<row><entry><code>SENTINEL RESET</code></entry><entry>-</entry></row>
130+
<row><entry><code>SENTINEL SET</code></entry><entry>-</entry></row>
131+
<row><entry><code>SENTINEL SLAVES</code></entry><entry>-</entry></row>
132+
<row><entry><code>SET</code></entry><entry>X</entry></row>
133+
<row><entry><code>SETBIT</code></entry><entry>X</entry></row>
134+
<row><entry><code>SETEX</code></entry><entry>X</entry></row>
135+
<row><entry><code>SETNX</code></entry><entry>X</entry></row>
136+
<row><entry><code>SETRANGE</code></entry><entry>X</entry></row>
137+
<row><entry><code>SHUTDOWN</code></entry><entry>X</entry></row>
138+
<row><entry><code>SINTER</code></entry><entry>X</entry></row>
139+
<row><entry><code>SINTERSTORE</code></entry><entry>X</entry></row>
140+
<row><entry><code>SISMEMBER</code></entry><entry>X</entry></row>
141+
<row><entry><code>SLAVEOF</code></entry><entry>-</entry></row>
142+
<row><entry><code>SLOWLOG</code></entry><entry>-</entry></row>
143+
<row><entry><code>SMEMBERS</code></entry><entry>X</entry></row>
144+
<row><entry><code>SMOVE</code></entry><entry>X</entry></row>
145+
<row><entry><code>SORT</code></entry><entry>X</entry></row>
146+
<row><entry><code>SPOP</code></entry><entry>X</entry></row>
147+
<row><entry><code>SRANDMEMBER</code></entry><entry>X</entry></row>
148+
<row><entry><code>SREM</code></entry><entry>X</entry></row>
149+
<row><entry><code>SSCAN</code></entry><entry>-</entry></row>
150+
<row><entry><code>STRLEN</code></entry><entry>X</entry></row>
151+
<row><entry><code>SUBSCRIBE</code></entry><entry>X</entry></row>
152+
<row><entry><code>SUNION</code></entry><entry>X</entry></row>
153+
<row><entry><code>SUNIONSTORE</code></entry><entry>X</entry></row>
154+
<row><entry><code>SYNC</code></entry><entry>-</entry></row>
155+
<row><entry><code>TIME</code></entry><entry>X</entry></row>
156+
<row><entry><code>TTL</code></entry><entry>X</entry></row>
157+
<row><entry><code>TYPE</code></entry><entry>X</entry></row>
158+
<row><entry><code>UNSUBSCRIBE</code></entry><entry>X</entry></row>
159+
<row><entry><code>UNWATCH</code></entry><entry>X</entry></row>
160+
<row><entry><code>WATCH</code></entry><entry>X</entry></row>
161+
<row><entry><code>ZADD</code></entry><entry>X</entry></row>
162+
<row><entry><code>ZCARD</code></entry><entry>X</entry></row>
163+
<row><entry><code>ZCOUNT</code></entry><entry>X</entry></row>
164+
<row><entry><code>ZINCRBY</code></entry><entry>X</entry></row>
165+
<row><entry><code>ZINTERSTORE</code></entry><entry>X</entry></row>
166+
<row><entry><code>ZRANGE</code></entry><entry>X</entry></row>
167+
<row><entry><code>ZRANGEBYSCORE</code></entry><entry>X</entry></row>
168+
<row><entry><code>ZRANK</code></entry><entry>X</entry></row>
169+
<row><entry><code>ZREM</code></entry><entry>X</entry></row>
170+
<row><entry><code>ZREMRANGEBYRANK</code></entry><entry>X</entry></row>
171+
<row><entry><code>ZREVRANGE</code></entry><entry>X</entry></row>
172+
<row><entry><code>ZREVRANGEBYSCORE</code></entry><entry>X</entry></row>
173+
<row><entry><code>ZREVRANK</code></entry><entry>X</entry></row>
174+
<row><entry><code>ZSCAN</code></entry><entry>-</entry></row>
175+
<row><entry><code>ZSCORE</code></entry><entry>X</entry></row>
176+
<row><entry><code>ZUNINONSTORE</code></entry><entry>X</entry></row>
177+
</tbody>
178+
</tgroup>
179+
</table>
180+
</appendix>

‎docs/src/reference/docbook/index.xml

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -67,20 +67,7 @@
6767

6868
<xi:include href="appendix/introduction.xml"/>
6969
<xi:include href="appendix/appendix-schema.xml"/>
70+
<xi:include href="appendix/appendix-command-reference.xml"/>
7071
</part>
71-
<!--
72-
<part id="resources">
73-
<title>Other Documentation</title>
74-
75-
<partintro>
76-
<para>
77-
In addition to this reference documentation, there are a number of
78-
other resources that may help you learn how to use the various key value
79-
stores and Spring Data. These additional, third-party resources are
80-
enumerated in this section.
81-
</para>
82-
</partintro>
83-
<xi:include href="links.xml"/>
84-
</part>
85-
-->
72+
8673
</book>

0 commit comments

Comments
 (0)