diff --git a/src/docbkx/reference/introduction.xml b/src/docbkx/reference/introduction.xml new file mode 100644 index 000000000..7ef643d5a --- /dev/null +++ b/src/docbkx/reference/introduction.xml @@ -0,0 +1,9 @@ + + Document structure + + This part of the reference documentation explains the core functionality + offered by Spring Data Key Value. + + introduces the Redis module feature set. + + \ No newline at end of file diff --git a/src/docbkx/reference/redis.xml b/src/docbkx/reference/redis.xml new file mode 100644 index 000000000..feb1e718e --- /dev/null +++ b/src/docbkx/reference/redis.xml @@ -0,0 +1,58 @@ + + + + Redis support + + One of the key value stores supported by SDKV is Redis. + To quote the project home page: + + Redis is an advanced key-value store. It is similar to memcached but the dataset is not volatile, and values can be strings, + exactly like in memcached, but also lists, sets, and ordered sets. All this data types can be manipulated with atomic operations + to push/pop elements, add/remove elements, perform server side union, intersection, difference between sets, and so forth. + Redis supports different kind of sorting abilities. + + Spring Data Key Value provides easy configuration and access to Redis from Spring application. Offers both low-level and + high-level abstraction for interacting with the store, freeing the user from infrastructural concerns. + + +
+ Redis Requirements + SDKV requires Redis 2.0 or above (work is underway to support the upcoming (at the time this document was written) 2.2) and + Java SE 6.0 or above. + In terms of language bindings (or connectors), SDKV integrates with Jedis and + JRedis, two popular open source Java libraries for Redis. If you are aware of + any other connector that we should be integrating is, please send us feedback. + +
+ +
+ Redis Support High Level View + + The Redis support provides several components (in order of dependencies): + + Low-Level Abstractions - for configuring and handling communication with Redis through the various connector libraries supported as + described in . + High-Level Abstractions - providing a generified, user friendly template classes for interacting with Redis. + explains the abstraction builds on top of the low-level Connection API to handle the + infrastructural concerns and object conversion. + Support Services - that offer reusable components (built on the aforementioned abstractions) such as + java.util.Collection backed by Redis as documented in + + + For most tasks, the high-level abstractions and support services are the best choice. Note that at any point, one can move between layers - for example, it's very + easy to get a hold of the low level connection (or even the native libray) to communicate directly with Redis. +
+ +
+ Connecting to Redis +
+ +
+ Working with Objects through <classname>RedisTemplate</classname> +
+ +
+ Support Services +
+ \ No newline at end of file