[redis.git] / client-libraries / scala / README.md

# Redis Scala client

## Key features of the library

- Native Scala types Set and List responses.
- Consisten Hashing on the client.
- Support for Clustering of Redis nodes.

## Information about redis

Redis is a key-value database. It is similar to memcached but the dataset is not volatile, and values can be strings, exactly like in memcached, but also lists and sets with atomic operations to push/pop elements.

http://code.google.com/p/redis/

### Key features of Redis

- Fast in-memory store with asynchronous save to disk.
- Key value get, set, delete, etc.
- Atomic operations on sets and lists, union, intersection, trim, etc.

## Requirements

- sbt (get it at http://code.google.com/p/simple-build-tool/)

## Usage

Start your redis instance (usually redis-server will do it)

    $ cd scala-redis
    $ sbt
    > update
    > test (optional to run the tests)
    > console

And you are ready to start issuing commands to the server(s)

let's connect and get a key:

    scala> import com.redis._
    scala> val r = new Redis("localhost", 6379)
    scala> val r.set("key", "some value")
    scala> val r.get("key")


Alejandro Crosa <<alejandrocrosa@gmail.com>>
Commit	Line	Data
7c44bbb1	1	# Redis Scala client
	2
	3	## Key features of the library
	4
	5	- Native Scala types Set and List responses.
	6	- Consisten Hashing on the client.
	7	- Support for Clustering of Redis nodes.
	8
	9	## Information about redis
	10
	11	Redis is a key-value database. It is similar to memcached but the dataset is not volatile, and values can be strings, exactly like in memcached, but also lists and sets with atomic operations to push/pop elements.
	12
	13	http://code.google.com/p/redis/
	14
	15	### Key features of Redis
	16
	17	- Fast in-memory store with asynchronous save to disk.
	18	- Key value get, set, delete, etc.
	19	- Atomic operations on sets and lists, union, intersection, trim, etc.
	20
	21	## Requirements
	22
	23	- sbt (get it at http://code.google.com/p/simple-build-tool/)
	24
	25	## Usage
	26
	27	Start your redis instance (usually redis-server will do it)
	28
	29	$ cd scala-redis
	30	$ sbt
	31	> update
	32	> test (optional to run the tests)
	33	> console
	34
	35	And you are ready to start issuing commands to the server(s)
	36
	37	let's connect and get a key:
	38
	39	scala> import com.redis._
	40	scala> val r = new Redis("localhost", 6379)
	41	scala> val r.set("key", "some value")
	42	scala> val r.get("key")
	43
	44
	45	Alejandro Crosa <<alejandrocrosa@gmail.com>>
	46