L

Locking redis

Name: Locking redis
Author: Medusa

Redis Lock for Medusa

Included in @medusajs/medusa, no separate install needed

@medusajs/locking-redis

Documentation | Website

Building blocks for digital commerce

Redis Locking Module Provider for Medusa: implements the Locking Module's locks in Redis, so locks are shared across all Medusa instances. It's the recommended locking provider for production. It ships with and is registered through the path.

At a glance


Package
Type	Module Provider (Locking Module)
Provider ID
Registered by default	No (on Medusa Cloud, registered as the default when is set)
Import from

Installation

No installation needed. The provider is a dependency of . You need a running Redis server.

Usage

Register the provider in the Locking Module's array in :

1import { defineConfig } from "@medusajs/framework/utils"
2
3module.exports = defineConfig({
// ...
modules: [
  {
    resolve: "@medusajs/medusa/locking",
    options: {
      providers: [
        {
          resolve: "@medusajs/medusa/locking-redis",
          id: "locking-redis",
          // makes this the default locking provider
          is_default: true,
          options: {
            redisUrl: process.env.LOCKING_REDIS_URL,
          },
        },
      ],
    },
  },
],
23})

Configuration

Option	Type	Description	Default
		Required. The Redis connection URL.	-
		Options passed to the client.	-
		Prefix for lock keys.
		Default time to wait to acquire a lock, in seconds.
		Initial interval between lock attempts, in milliseconds.
		Maximum interval between lock attempts, in milliseconds.
		Multiplier applied to the retry interval after each attempt.