https://github.com/redisbloom/jredisbloom

Java Client for RedisBloom probabilistic module
https://github.com/redisbloom/jredisbloom

bloom-filter java-client redis redis-client redisbloom

Last synced: about 1 month ago
JSON representation

Java Client for RedisBloom probabilistic module

• Host: GitHub
• URL: https://github.com/redisbloom/jredisbloom
• Owner: RedisBloom
• License: bsd-2-clause
• Created: 2017-08-25T18:19:36.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-05-30T18:20:53.000Z (over 1 year ago)
• Last Synced: 2024-04-17T16:22:49.223Z (8 months ago)
• Topics: bloom-filter, java-client, redis, redis-client, redisbloom
• Language: Java
• Homepage: https://redisbloom.io
• Size: 1.1 MB
• Stars: 153
• Watchers: 10
• Forks: 33
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![license](https://img.shields.io/github/license/RedisBloom/JRedisBloom.svg)](https://github.com/RedisBloom/JRedisBloom)

[![GitHub issues](https://img.shields.io/github/release/RedisBloom/JRedisBloom.svg)](https://github.com/RedisBloom/JRedisBloom/releases/latest)

[![CircleCI](https://circleci.com/gh/RedisBloom/JRedisBloom/tree/master.svg?style=svg)](https://circleci.com/gh/RedisBloom/JRedisBloom/tree/master)

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.redislabs/jrebloom/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.redislabs/jrebloom)

[![Javadocs](https://www.javadoc.io/badge/com.redislabs/jrebloom.svg)](https://www.javadoc.io/doc/com.redislabs/jrebloom)

[![Codecov](https://codecov.io/gh/RedisBloom/JRedisBloom/branch/master/graph/badge.svg)](https://codecov.io/gh/RedisBloom/JRedisBloom)

[![Known Vulnerabilities](https://snyk.io/test/github/RedisBloom/JRedisBloom/badge.svg?targetFile=pom.xml)](https://snyk.io/test/github/RedisBloom/JRedisBloom?targetFile=pom.xml)

# JRedisBloom

[![Forum](https://img.shields.io/badge/Forum-RedisBloom-blue)](https://forum.redislabs.com/c/modules/redisbloom)

[![Discord](https://img.shields.io/discord/697882427875393627?style=flat-square)](https://discord.gg/wXhwjCQ)

A Java Client Library for [RedisBloom](https://redisbloom.io)

## Deprecation notice

As of [Jedis](https://github.com/redis/jedis) version 4.2.0, this library is deprecated. Its features have been merged into Jedis. Please either install it from [maven](https://mvnrepository.com/artifact/redis.clients/jedis) or [the repo](https://github.com/redis/jedis)

## Overview

This project contains a Java library abstracting the API of the RedisBloom Redis module, that implements a high

performance bloom filter with an easy-to-use API

See [http://redisbloom.io](http://redisbloom.io) for installation instructions of the module.

### Official Releases

```xml

  

    

      com.redislabs

      jrebloom

      2.1.0

    

  

```

### Snapshots

```xml

  

    

      snapshots-repo

      https://oss.sonatype.org/content/repositories/snapshots

    

  

```

and

```xml

  

    

      com.redislabs

      jrebloom

      2.2.0-SNAPSHOT

    

  

```

## Usage example

Initializing the client:

```java

import io.rebloom.client.Client

Client client = new Client("localhost", 6379);

```

Adding items to a bloom filter (created using default settings):

```java

client.add("simpleBloom", "Mark");

// Does "Mark" now exist?

client.exists("simpleBloom", "Mark"); // true

client.exists("simpleBloom", "Farnsworth"); // False

```

Use multi-methods to add/check multiple items at once:

```java

client.addMulti("simpleBloom", "foo", "bar", "baz", "bat", "bag");

// Check if they exist:

boolean[] rv = client.existsMulti("simpleBloom", "foo", "bar", "baz", "bat", "mark", "nonexist");

```

Reserve a customized bloom filter:

```java

client.createFilter("specialBloom", 10000, 0.0001);

client.add("specialBloom", "foo");

```

Use cluster client to call redis cluster

Initializing the cluster client:

```java

Set jedisClusterNodes = new HashSet<>();

jedisClusterNodes.add(new HostAndPort("localhost", 7000));

ClusterClient cclient = new ClusterClient(jedisClusterNodes);

```

Adding items to a bloom filter (created using default settings):

```java

cclient.add("simpleBloom", "Mark");

// Does "Mark" now exist?

cclient.exists("simpleBloom", "Mark"); // true

cclient.exists("simpleBloom", "Farnsworth"); // False

```

all method of ClusterClient is same to Client.