RedisBloom Quick Start

RedisBloom adds Bloom filter, Cuckoo filter, Count-Min Sketch, and Top-K capabilities to Redis.

Step 1: Add modules

Step 2: Connect

Download the “Redis Insight” desktop
tool to connect and interact

Mac | Windows | Linux
 

Quick start: Follow the steps below to get started in 10 minutes! 🚀

1. 🏎️ Register and subscribe

Getting started with Redis Cloud Essentials

To get started with Redis Enterprise Cloud Essentials, visit https://redislabs.com/try-redis-modules-for-free and fill out the form:

Fill out form

Once you click “Get Started,” we will send you an email with a link to activate your account and complete your signup process.


Adding your Redis Enterprise Cloud Essentials subscription

  1. In the Redis Enterprise Cloud menu, click Subscriptions
  2. At the bottom of the page, click the “+” sign, as shown below:Click the + sign
  3. Select your subscription configuration as shown here:

For the cloud provider, select Amazon AWS

Select Amazon AWS
The (1) arrow indicates where to choose AWS as your cloud provider for Redis Enterprise Cloud Essentials.

Select a region
The (2) arrow shows where to choose the ap-south-1 cloud region.

In the Redis Enterprise Cloud service levels, select the Redis Enterprise Cloud Essentials 30MB/1 Database level and click Create:

Select the Redis Enterprise Cloud Essentials 30MB/1 Database level and click Create
The (3) arrow shows how to create your first free database with the name “demotest”.

2. 🚃 Create a Database with Modules

Once you create a subscription, you are ready to create a database with modules enabled. As shown below, enter a name for the database you want to create:

Enter the database name
The (4) arrow shows where to enter the database name. The (5) arrow indicates where to enable modules on Redis Enterprise Cloud Essentials.

Move the toggle to select the module you want. You can choose one module at a time under Redis Enterprise Cloud Essentials. Please note that multiple modules capabilities are currently available only in Redis Cloud Pro.

Select the RediSearch module
The (6) arrow shows where to select the RediSearch module in Redis Enterprise Cloud Essentials.

Let’s go ahead and choose “RediSearch” as our first module. Click “Activate”:

Activate your new database
The (7) arrows shows where to Activate your new database.

The database will remain in “Pending” status until the process of configuring your new Redis database is completed. When the database is created, you will be able to see all the database settings, including:

  • Endpoint: The address you use to connect to the database.
  • Redis password: The password you must use in your application to connect to the database.

Copy the database endpoint
The (8) arrows shows where to copy the database endpoint (redis-16333.c212.ap-south-1.1.ec2.cloud.redislabs.com:16333) for future reference.

3. 🔌 Connect to the Database

Using RedisInsight

RedisInsight is an intuitive and efficient GUI for Redis, allowing you to interact with your databases and manage your data—with built-in support for most popular Redis modules. The free non-commercial add-on provides tools to analyze the memory, profile the performance of your database, and guide you toward better Redis usage.

Learn more about RedisInsight here!

RedisInsight provides built-in support for the RedisJSON, RediSearch, RedisGraph, Redis Streams, and RedisTimeSeries modules to make it even easier to query, visualize, and interactively manipulate search indexes, graphs, streams, and time-series data. Used properly, RedisInsight can make the experience of using modules with Redis Enterprise Cloud Essentials even smoother.

A full-featured desktop GUI client, RedisInsight is available for Windows, macOS, and Linux and is fully compatible with Redis Enterprise. It works with any cloud provider as long as you run it on a host with network access to your cloud-based Redis server. RedisInsight makes it easy to discover cloud databases and configure connection details with a single click. It allows you to automatically add Redis Enterprise Software and Redis Enterprise Cloud databases.

Local installation of RedisInsight:

To use RedisInsight on a local machine, download it for Windows, Mac, or Linux from the RedisInsight page on the RedisLabs website:

Click “Download” to open up a form that allows you to select the operating system of your choice. For example, let’s assume that you want to install RedisInsight on your macOS machine. Choose “Mac OS” as a platform as shown here:

 

Mac OS    Windows    Linux

 

Fill out the rest of the form and click “Download.” Please note that the package name is the combination of the platform and version as shown here:

redisinsight-<platform>-<version>

Running RedisInsight

Click on the RedisInsight executable and install it in your system.

Click on the RedisInsight executable

Head over to your web browser and go to http://localhost:8001


Using RedisInsight with Docker

You can also run RedisInsight inside Docker containers. Visit https://hub.docker.com/r/redislabs/redisinsight/tags to find the latest Docker image available over DockerHub.

$ docker run -v redisinsight:/db -p 8001:8001 redislabs/redisinsight:latest

Head over to your web browser and go to http://localhost:8001

Congratulations! You have successfully installed RedisInsight and are now ready to inspect your Redis data, monitor database health, and perform runtime server configuration with this browser-based management interface for your Redis deployment.

Once you accept the EULA and click “Confirm,” you are ready to add Redis databases, as shown here:

Accept the EULA and click Confirm

Select “ADD REDIS DATABASE” and then “Add Database”:

Select ADD REDIS DATABASE and then Add Dadtabase

Enter the requested details, including Name, Host (endpoint), Port, and Password in the form, as shown below. You can skip username for now. Then click “ADD REDIS DATABASE”:

Enter the requested details

Click on the pop-up box to see the RedisInsight dashboard:

Click on the pop-up box

How to use RedisInsight to run the Redis CLI

Finally, although RedisInsight is a great GUI, sometimes you want to work directly in the command-line interface (CLI). To do so, click “CLI” in the  menu on the left side of the RedisInsight UI:

 

The arrow highlights CLI option on RedisInsight

Then paste the appropriate Redis commands in the command section, marked with “>>” as shown below, and press Enter.

The (2) arrow points to where to set the string value of a key.

You can see the output displayed at the top of the screen. If it says “OK,” the command was executed successfully.

Now that RedisInsight is installed, we’re ready to look at individual Redis modules and see how they work with Redis Enterprise Cloud Essentials.

4. 🚀 RedisBloom

In the next steps you will use some basic RedisBloom commands. You can run them from the Redis command-line interface (redis-cli) or use the CLI available in RedisInsight. (See part 2 of this tutorial to learn more about using the RedisInsight CLI.) To interact with RedisBloom, you use the BF.ADD and BF.EXISTS commands.

Let’s go ahead and test drive some RedisBloom-specific operations. We will create a basic dataset based on unique visitors’ IP addresses, and you will see how to:

  1. Create a Bloom filter
  2. Determine whether or not an item exists in the Bloom filter
  3. Add one or more items to the Bloom filter
  4. Determine whether or not a unique visitor’s IP address exists

Let’s walk through the process step-by-step:

  1. Create a Bloom filter

Use the BF.ADD command to add a unique visitor IP address to the Bloom filter as shown here:

>> BF.ADD unique_visitors 10.94.214.120
(integer) 1
(1.75s)
  1. Determine whether or not an item exists

Use the BF.EXISTS command to determine whether or not an item may exist in the Bloom filter:

>> BF.EXISTS unique_visitors 10.94.214.120
(integer) 1

>> BF.EXISTS unique_visitors 10.94.214.121
(integer) 0
(1.46s)

In the above example, the first command shows the result as “1”, indicating that the item may exist, whereas the second command displays “0”, indicating that the item certainly may not exist.

  1. Add one or more items to the Bloom filter

Use the BF.MADD command to add one or more items to the Bloom filter, creating the filter if it does not yet exist. This command operates identically to BF.ADD, except it allows multiple inputs and returns multiple values:

>> BF.MADD unique_visitors 10.94.214.100 10.94.214.200 10.94.214.210 10.94.214.212
1) (integer) 1
2) (integer) 1
3) (integer) 1
4) (integer) 1

As shown above, the BF.MADD allows you to add one or more visitors’ IP addresses to the Bloom filter.

  1. Determine whether or not a unique visitor’s IP address exists

Use BF.MEXISTS to determine if one or more items may exist in the filter or not:

>> BF.MEXISTS unique_visitors 10.94.214.200 10.94.214.212
1) (integer) 1
2) (integer) 1

 >> BF.MEXISTS unique_visitors 10.94.214.200 10.94.214.213
1) (integer) 1
2) (integer) 0

In the above example, the first command shows the result as “1” for both the visitors’ IP addresses, indicating that these items do exist. The second command displays “0” for one of the visitor’s IP addresses, indicating that the item certainly does not exist.

Learn more about RedisBloom in the Quick Start tutorial.


See what others are building