Connect with Redis client API libraries on Docs

Redis vector library guide (Python)

Mon, 01 Jan 0001 00:00:00 +0000

See the RedisVL Guide for more information.

Client-side caching introduction

Mon, 01 Jan 0001 00:00:00 +0000

Client-side caching reduces network traffic between a Redis client and the server, which generally improves performance.

By default, an application server (which sits between the user app and the database) contacts the Redis database server through the client library for every read request. The diagram below shows the flow of communication from the user app, through the application server to the database and back again:

When you use client-side caching, the client library maintains a local cache of data items as it retrieves them from the database. When the same items are needed again, the client can satisfy the read requests from the cache instead of the database:

Connection pools and multiplexing

Mon, 01 Jan 0001 00:00:00 +0000

Redis example code generally opens a connection, demonstrates a command or feature, and then closes. Real-world code typically has short bursts of communication with the server and periods of inactivity in between. Opening and closing connections involves some overhead and leads to inefficiency if you do it frequently. This means that you can improve the performance of production code by making as few separate connections as possible.

Managing connections in your own code can be tricky, so the Redis client libraries give you some help. The two basic approaches to connection management are called connection pooling and multiplexing. The redis-py, jedis, and go-redis clients support connection pooling, while NRedisStack supports multiplexing. Lettuce supports both approaches.

Error handling

Mon, 01 Jan 0001 00:00:00 +0000

When working with Redis, errors can occur for various reasons, including network issues, invalid commands, or resource constraints. This guide explains the types of errors you might encounter and how to handle them effectively.

Categories of errors

Redis errors fall into four main categories. The table below provides a quick overview of each type. Click on any error type to jump to its detailed section, which includes common causes, examples, handling strategies, and code examples.

Client-side geographic failover

Mon, 01 Jan 0001 00:00:00 +0000

Some Redis client libraries support Client-side geographic failover to improve the availability of connections to Redis databases. Use this page to get a general overview of the concepts and then see the documentation for your client library to learn how to configure it for failover and failback:

Jedis
redis-py (preview)

Concepts

You may have several Active-Active databases or independent Redis servers that are all suitable to serve your app. Typically, you would prefer to use some database endpoints over others for a particular instance of your app (perhaps the ones that are closest geographically to the app server to reduce network latency). However, if the best endpoint is not available due to a failure, it is generally better to switch to another, suboptimal endpoint than to let the app fail completely.

Smart client handoffs

Mon, 01 Jan 0001 00:00:00 +0000

Smart client handoffs (SCH) is a feature of Redis Cloud and Redis Enterprise servers that lets them actively notify clients about planned server maintenance shortly before it happens. This lets a client reconnect or otherwise respond gracefully without significant interruptions in service.

SCH is primarily useful when server software or hardware upgrades are required. It provides two main features to help the client avoid disruptions in service during the maintenance period: