Skip to content

Latest commit

 

History

History
88 lines (48 loc) · 2.38 KB

File metadata and controls

88 lines (48 loc) · 2.38 KB

Black Rook Redis

Copyright (c) 2019 Black Rook Software.
https://github.com/BlackRookSoftware/Redis

Latest Release

Required Libraries

NONE

Required Java Modules

java.base

Where to Get

Introduction

This library contains classes for Redis Server functions, for both client and administrative use.

Currently compatible with Redis 2.6+

Why?

Some other Redis-interfacing libraries do the bare minimum for supporting commands, and they don't separate them categorically into meaningful ways suitable for DAOs or other drivers, nor do they contain ways to create/store object data, reflection-wise.

This one does.

Library

Contained in this release is a series of classes that are used for Redis server functions, plus object conversion utilities. Supports pipelining series of commands and raw writes/reads from a Redis connection, as well as Redis cursors.

The javadocs contain basic outlines of each package's contents.

Compiling with Maven

To install/compile this library and make all artifacts with Apache Maven, type:

mvn install

To compile this library, type:

mvn compile

To make Maven-compatible JARs of this library, type:

mvn jar:jar

To make Javadocs:

mvn javadoc:javadoc

To run tests, type:

mvn test

To generate a coverage report, type:

mvn test jacoco:report

To clean up everything:

mvn clean

Javadocs

Online Javadocs can be found at: https://blackrooksoftware.github.io/Redis/javadoc

Other

This program and the accompanying materials are made available under the terms of the LGPL v2.1 License which accompanies this distribution.

A copy of the LGPL v2.1 License should have been included in this release (LICENSE.txt). If it was not, please contact us for a copy, or to notify us of a distribution that has not included it.

This contains code copied from Black Rook Base, under the terms of the MIT License (docs/LICENSE-BlackRookBase.txt).