Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
ScaRed is a minimal Object-KeyValue Mapping library for Redis.
Scala Java
Branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
src
.gitignore
.travis.yml
README.md
pom.xml

README.md

ScaRed

Build Status

ScaRed is a minimal Object-KeyValue Mapping library for Redis.

All it needs to work is a annotation on the class, as the following example:

@Persist(name = "server",
  customIndexes = Array(
    new Index(fields = Array("enviroment")),
    new Index(fields = Array("enviroment", "group"), orderField = "load"),
    new Index(fields = Array("roles"))
  )
)
case class Server(id: Long, load: Double, name: String, ip: String, enviroment: String, group: String, roles: List[String])

All entities must have a id attribute, the library will look first for one with the annotation @Id, if not fould will use the one with name id.

Indexes are automatically handled at save/update/delete.

Serialization is done by default using Kryo, but can be changed easily, look at src/example folder.

Usage

Save

val model = Server(100l, 1.2d, "server1", "127.0.0.1", "dev", "hbase_slave", List("redis-srv", "hbase"))
context.save(model)

Update

val updated: Option[Server] = context.update[Server](100l, m => m.copy(name = "server02", enviroment="production"))

Delete

context.delete[Server](100l)

Load

val server: Option[Server] = context.load[Server](100l)

Auto generate Id

val generatedId = context.nextIdFor[Server]
val model = Server(generatedId, 1.2d, "server1", "127.0.0.1", "dev", "hbase_slave", List("redis-srv", "hbase"))
context.save(model)
                                                          ;
// Or if the attribute id is nullable long(java.lang.Long)
val model = Server(null, 1.2d, "server1", "127.0.0.1", "dev", "hbase_slave", List("redis-srv", "hbase"))
val generatedId = context.save(model)

Querying(Simple)

val servers: Iterator[Server] = context.query[Server](new Where{ 'enviroment === "dev" }).execute()

Querying(Paginating)

val servers: Iterator[Server] = context
    .query[Server](new Where{ 'enviroment === "dev" })
    .paginate(FixedInterval(0, 10))
    .execute()

Can also paginate through score(look at ScorePagination)

Querying(Join)

val servers: Iterator[Server] = context
    .query[Server](new Where{ 'enviroment === "dev" })
    .and(new Where{ 'role = "hbase" })
    .joinMethod(JoinMethod.INTERSECTION)
    .execute()

For more examples look at src/example/ and src/test/scala folders.

TODO

  • Support auto Reference/Relationship
  • Support inherited fields
  • Better configuration (only localhost:6379 right now)
  • Support sharding(index join would be disable)
  • Better error handling(using only RuntimeExceltion right now)

License

This software is licensed under the Apache 2 license, quoted below.

Licensed under the Apache License, Version 2.0 (the ?License?); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an ?AS IS? BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Something went wrong with that request. Please try again.