Redis OM Python Search Demo

This repository contains a basic demonstration of the object modeling and search capabilities of the Redis OM Python client for Redis. Watch a video of Simon presenting this demo on YouTube at a Redis Montly Live event (check out the Redis Developer Relations team events page for our upcoming events).

The demo requires you to have RediSearch 2.2 or higher installed on your Redis server. The easiest way to try this demo is by following the GitPod instructions below - this will run the demo entirely in a free cloud environent with nothing to install. If you'd prefer to install Redis + RediSearch locally instead, use the supplied docker-compose.yml file, so you'll want to have Docker Desktop installed. This uses the Redis Stack container, which gives you Redis plus the RediSearch and other modules pre-installed.

To run locally, you'll also require a reasonably up to date version of Python 3 - 3.8 or better. I've tested this on the following version of Python on macOS Monterey 12.5.1:

$ python3 --version
Python 3.9.5

Overview

We'll take a look at how to model domain objects in Python using Redis OM. You'll find the model in adoptable.py. These objects can then be persisted to Redis Hashes by calling save() on them. By defining which fields should be indexed and how to index them, we can tell Redis OM to build and maintain a RediSearch index for us. This allows us to leverage the fluent querying API to retrieve objects matching multiple search criteria.

In this example, we'll use a small data set of dogs and cats that are available for adoption at an animal shelter. This data is in the file animal_data.csv.

Run this Demo Entirely in the Cloud with GitPod

When using Gitpod, the only things you need are:

• A modern browser (we have tested with Google Chrome).
• A GitHub account.

Click the button below to start a new cloud development environment using Gitpod:

If you're using Gitpod for the first time, you'll need to authorize it to work with your GitHub account.

Gitpod will then open a workspace in the browser for you. This contains:

• VS Code for viewing and editing the code.
• An embedded browser window with the RedisInsight database visualization tool running in it.
• A terminal session -- this is where you'll run the Python scripts to load the sample data and query it. Note that this terminal will only become available once you have agreed to the terms and conditions to use RedisInsight in the browser window.

Your environment should look something like this:

Local Setup

(Skip this section if you're using a GitPod hosted environment)

To try the code out, you'll want to clone the repo, create a Python virtual environment, install dependencies and start Redis using Docker:

$ git clone https://github.com/redis-developer/redis-om-python-search-demo.git
$ cd redis-om-python-search-demo
$ python3 -m venv venv
$ . ./venv/bin/activate
$ pip install -r requirements.txt

Then, start the Redis Stack container:

$ docker-compose up -d

Loading the Data into Redis and Indexing it

Now it's time to load the data into Redis and setup the RediSearch index:

$ python load_adoptables.py

You should see output showing the name and Redis key of each animal loaded from animal_data.csv.

Running the Code

To query the data, run query_adoptables.py:

$ python query_adoptables.py

You can change which query runs by editing the final four lines of query_adoptables.py to add/remove comments as needed.

The example queries are as follows:

• find_by_name: Find all animals whose name field is Luna
• find_male_dogs: Find all animals where sex is m and species is dog
• find_dogs_in_age_range: Find all animals where species is dog and age is 9 or 10
• find_cats_good_with_children: Final all animals where species is cat and children (good with children) is y and where the free text description field does not contain anxious or nervous but does contain words similar to play e.g. play, playful

Shutting Down (when running locally)

When you're done with the demo, shut down the Redis server:

$ cd redis-om-python-search-demo
$ docker-compose down