redis-rs guide (Rust) on Docs

Connect to Azure Managed Redis

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

The entra-id feature lets you authenticate your app to Azure Managed Redis (AMR) using Microsoft Entra ID. You can authenticate using a system-assigned or user-assigned managed identity or a service principal, letting the redis-rs connection fetch and renew the authentication tokens for you automatically.

Install

Add the entra-id feature to your Cargo.toml file:

Work with JSON documents

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

This example shows how to work with a JSON document from Rust using redis-rs. It uses one bike:1 document to demonstrate a simple workflow: create the document, read nested fields, update part of the document, and append data to an array.

Unlike some of the other client examples in this section, this page focuses on Redis JSON commands directly rather than on Redis Search.

Install

Add serde_json and enable the json feature for redis. If you want to use the async API, also enable a runtime integration such as tokio-comp.

Probabilistic data types

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

Redis supports several probabilistic data types that let you calculate values approximately rather than exactly. The redis-rs high-level command traits include support for HyperLogLog cardinality estimation.

Note:

This page covers HyperLogLog because redis-rs provides high-level pfadd, pfcount, and pfmerge methods. Other probabilistic data types, such as Bloom filters, Count-min sketch, t-digest, and Top-K, can still be called with low-level Redis commands, but they don't currently have dedicated high-level redis-rs methods.

Set cardinality

A HyperLogLog object calculates the approximate cardinality of a set. As you add items, the HyperLogLog tracks the number of distinct set members, but it doesn't let you retrieve those members or test whether a specific item was added.

Error handling

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

redis-rs uses Result types following Rust's idiomatic error handling pattern. Code examples in the documentation often omit error handling for brevity, but it is essential in production code. This page explains how error handling works in redis-rs and how to apply some common error handling patterns. For an overview of error types and handling strategies, see Error handling.

Error handling in Rust

In Rust, functions return errors using the Result<T, E> type. You can check for errors explicitly with code like the following:

Pipelines and transactions

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

Redis lets you send a sequence of commands to the server together in a batch. There are two types of batch that you can use:

Pipelines avoid network and processing overhead by sending several commands to the server together in a single communication. The server then sends back a single communication with all the responses. See the Pipelining page for more information.
Transactions guarantee that all the included commands will execute to completion without being interrupted by commands from other clients. See the Transactions page for more information.

Execute a pipeline

To execute commands in a pipeline, you first create a pipeline object and then add commands to it using methods that resemble the standard command methods (for example, set() and get()). The commands are buffered in the pipeline and only execute when you call the exec() method on the pipeline object. If you need the results from the commands, use the query() method, which returns the results from all the commands in order.