Modules API

Valkey Modules extend Valkey’s core commands and functionality. Starting in GLIDE 1.2, commonly used modules, like JSON and Vector Search, are supported through a dedicated wrapper interface.

Custom Modules

Unsupported or custom modules can still be accessed by directly making commands through the Custom Commands API.

General Concept

The Modules API provides convenient wrapper methods for commonly used Valkey modules. These wrappers are built on top of the Custom Command API, automatically constructing and executing the appropriate module commands. This allows for type-safe methods, parameter validation, and IDE autocomplete support. Under the hood, each wrapper method translates your call into the corresponding module command and executes it via the Custom Commands API.

Currently, GLIDE supports dedicated API for JSON and Search modules.

Requirements

Before using a module, including the supported modules, it will need to be loaded into Valkey. See Modules Introduction on how to load modules into your Valkey service.

Tip

Use INFO MODULES or MODULE LIST command to see the status of all loaded modules.

GLIDE Version Requirements

Below are the supported Valkey Modules and their minimum required GLIDE client versions:

Module	Python	Node	Java	Go	C#	PHP
JSON	0.3+	1.2+	1.2+	2.4+	1.1+	N/A
SEARCH	1.2+	1.2+	1.2+	2.4+	1.1+	N/A

What’s Next

For examples on how to use the support modules, check out the following pages:

• Working with JSON Data
• Working with Valkey Search