Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Provides support to increase developer productivity in Java when using Redis, a key-value store. Uses familiar Spring concepts such as a template classes for core API usage and lightweight repository style data access.

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
.settings
spring-data-keyvalue-core
spring-data-keyvalue-parent
spring-data-redis
spring-data-riak
src
.gitignore
README.md
pom.xml

README.md

Spring Data - Key Value

The primary goal of the Spring Data project is to make it easier to build Spring-powered applications that use new data access technologies such as non-relational databases, map-reduce frameworks, and cloud based data services. As the name implies, the Key Value modules provides integration with key value stores such as Redis and Riak.

Getting Help

Read the main project website and the User Guide. Look at the source code and the JavaDocs. For more detailed questions, use the forum. If you are new to Spring as well as to Spring Data, look for information about Spring projects.

Quick Start

Redis

For those in a hurry:

  • Download the jar through Maven:

    org.springframework.data spring-data-redis 1.0.0-BUILD-SNAPSHOT

    spring-maven-snapshot true Springframework Maven SNAPSHOT Repository http://maven.springframework.org/snapshot

  • Configure the Redis connector to use (here jedis):

    <bean id="jedisFactory" class="org.springframework.data.keyvalue.redis.connection.jedis.JedisConnectionFactory"/>
    
    <bean id="redisTemplate" class="org.springframework.data.keyvalue.redis.core.RedisTemplate"
        p:connection-factory="jedisFactory"/>
    

  • Use RedisTemplate to interact with the Redis store:

    String random = template.randomKey(); template.set(random, new Person("John", "Smith"));

  • Use Redis 'views' to execute specific operations based on the underlying Redis type:

    ListOperations listOps = template.listOps(); listOps.rightPush(random, new Person("Jane", "Smith")); List peopleOnSecondFloor = listOps.range("users:floor:2", 0, -1);

Riak

  • Download the jar through Maven:

    org.springframework.data spring-data-riak 1.0.0-BUILD-SNAPSHOT

    spring-maven-snapshot true Springframework Maven SNAPSHOT Repository http://maven.springframework.org/snapshot

  • Configure the RiakTemplate in your Spring ApplicationContext:

    <bean id="riakTemplate" class="org.springframework.data.keyvalue.riak.core.RiakTemplate"
        p:defaultUri="http://localhost:8098/riak/{bucket}/{key}"
        p:mapReduceUri="http://localhost:8098/mapred"/>
    

  • Use the RiakTemplate in your code:

    Java:


    MyObject obj = new MyObject("value1", "value2"); riakTemplate.set("mybucket", "mykey", obj);

    Map returnObj = riakTemplate.getAsType("mybucket", "mykey", Map.class);

    Groovy:


    def obj = [first: "value1", second: "value2"] riakTemplate.set("mybucket", "mykey", obj)

Contributing to Spring Data

Here are some ways for you to get involved in the community:

  • Get involved with the Spring community on the Spring Community Forums. Please help out on the forum by responding to questions and joining the debate.
  • Create JIRA tickets for bugs and new features and comment and vote on the ones that you are interested in.
  • Github is for social coding: if you want to write code, we encourage contributions through pull requests from forks of this repository. If you want to contribute code this way, please reference a JIRA ticket as well covering the specific issue you are addressing.
  • Watch for upcoming articles on Spring by subscribing to springframework.org

Before we accept a non-trivial patch or pull request we will need you to sign the contributor's agreement. Signing the contributor's agreement does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do. Active contributors might be asked to join the core team, and given the ability to merge pull requests.

Something went wrong with that request. Please try again.