Skip to content

Latest commit

 

History

History
108 lines (75 loc) · 3.4 KB

README.md

File metadata and controls

108 lines (75 loc) · 3.4 KB
Raw

Jedis

Jedis is a blazingly small and sane Redis java client.

Jedis was conceived to be EASY to use.

Jedis is fully compatible with redis 2.0.0.

Is there a Groovy client?

Yes. You can use Jedis if you want, but I recommend Gedis, which is Jedis but with a nicer groovy-like interface :)

Community

Meet us on IRC: ##jedis on freenode.net

Join the mailing-list at http://groups.google.com/group/jedis_redis

What will be available soon?

  • Sharding with connection pooling and with pipelining
  • More examples and documentation
  • More and more code and performance improvements

Stay close because things are going fast!

Ok.. so what can I do with Jedis?

All of the following redis features are supported:

  • Sorting
  • Connection handling
  • Commands operating on all the kind of values
  • Commands operating on string values
  • Commands operating on hashes
  • Commands operating on lists
  • Commands operating on sets
  • Commands operating on sorted sets
  • Transactions
  • Pipelining
  • Publish/Subscribe
  • Persistence control commands
  • Remote server control commands
  • Connection pooling
  • Sharding (MD5, MurmureHash)
  • Key-tags for sharding

How do I use it?

You can download the latests build at: https://github.com/xetorthio/jedis/downloads

Or use it as a maven dependency:

<dependency>
    <groupId>redis.clients</groupId>
    <artifactId>jedis</artifactId>
    <version>1.3.0</version>
    <type>jar</type>
    <scope>compile</scope>
</dependency>

To use it just:

Jedis jedis = new Jedis("localhost");
jedis.set("foo", "bar");
String value = jedis.get("foo");

For more usage examples check the tests. Soon I will add a nice wiki with everything you should know.

And you are done!

I want to contribute!

That is great! Just fork the project in github. Create a topic branch, write some tests and the feature that you wish to contribute.

To run the tests:

  • Use the latest redis master branch.

  • Run 2 instances of redis using conf files in conf folder. For the tests we use 2 redis servers, one on default port (6379) and the other one on (6380). Both have authentication enabled with default password (foobared). This way we can test both sharding and auth command.

Thanks for helping!

License

Copyright (c) 2010 Jonathan Leibiusky

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.