prisma-redis-extension

The prisma-redis-extension library is a comprehensive package that consolidates the functionalities of the packages: prisma-redis-cache and prisma-redis-uncache. This consolidation provides a unified solution for optimizing database access times, enhancing cache management, and offering versatile functions for efficient Redis/Dragonfly database maintenance.

🚀 If prisma-redis-extension proves helpful, consider giving it a star! ⭐ Star Me!

Installation

Using npm:

npm install @yxx4c/prisma-redis-extension

Using yarn:

yarn add @yxx4c/prisma-redis-extension

Using pnpm:

pnpm add @yxx4c/prisma-redis-extension

Using bun:

bun add @yxx4c/prisma-redis-extension

Initializtion of setup

import {PrismaClient} from '@prisma/client';
import {Redis} from 'ioredis';
import pino from 'pino';
import {
  getCacheKey,
  getCacheKeyPattern,
  PrismaRedisExtension,
} from '@yxx4c/prisma-redis-extension';

// Create a Redis client
const redis = new Redis({
  host: env.REDIS_HOST_NAME, // Specify Redis host name
  port: env.REDIS_PORT, // Specify Redis port
});

// Create a pino logger instance for logging
const logger = pino();

Auto cache config

Auto-caching can be enabled for all read operations by default. Set auto to customize behavior or exclude specific models or operations.

const auto = {
  excludedModels: ['Post'], // Models to exclude from auto-caching
  excludedOperations: ['findFirst', 'count', 'findMany'], // Operations to exclude from auto-caching
  models: [
    {
      model: 'User',
      excludedOperations: [],
      ttl: 10, // Time-to-live for caching
      stale: 5, // Stale time for caching
    },
  ], // Models-specific cache configurations
  ttl: 1, // Default time-to-live for caching
};

Cache Client Config is required to enable auto-cache.

Cache Client Config

This configuration is required for enabling auto-cache and handling caching using cache: true or cache: false per Prisma query (refer use cases).

const cache = {
  ttl: 1, // Time-to-live for caching
  stale: 1, // Stale time for caching
  storage: {
    type: 'redis',
    options: {
      client: redis,
      invalidation: {referencesTTL: 60}, // Invalidation settings
      log: logger, // Logger for cache events
    },
  }, // Storage configuration for async-cache-dedupe
};

// Create a Prisma client instance
const prisma = new PrismaClient();

// Extend Prisma with prisma-redis-extension
const extendedPrisma = prisma.$extends(
  PrismaRedisExtension({auto, cache, redis})
);

Use case 1: Default Auto-Caching Configuration

// Example: Query a user and cache the result when auto caching is enabled
extendedPrisma.user.findUnique({
  where: {id},
});

// Example: Query a user and cache the result by setting `cache: true` to toggle auto cache
extendedPrisma.user.findUnique({
  where: {id},
  cache: true, // Enable caching with default configuration
});

// Example: Exclude automatic caching for a specific operation
extendedPrisma.user.findFirst({
  where: {userId: id},
  cache: false, // Disable caching for this operation
});

Use case 2: Selective Caching with Custom Configuration

// Example: Query a user and cache the result - with custom configuration
extendedPrisma.user.findUnique({
  where: {id},
  cache: {ttl: 5, key: getCacheKey([{prisma: 'User'}, {userId: id}])},
});

Use case 3: Invalidation of Cached Data

// Example: Update a user and invalidate related cache keys
extendedPrisma.user.update({
  where: {id},
  data: {username},
  uncache: {
    uncacheKeys: [
      getCacheKey([{prisma: 'User'}, {userId: id}]),
      getCacheKeyPattern([{prisma: '*'}, {userId: id}]), // Pattern matching under a specific key, eg: prisma:*:userId:1234
      getCacheKeyPattern([{prisma: 'Post'}, {userId: id}, {glob: '*'}]), // Utilizing the key 'glob' to create a wildcard region, eg: prisma:post:userId:1234:*
    ], // Keys to be invalidated
    hasPattern: true, // Use wildcard pattern for key matching
  },
});

Custom cache invalidation is designed for custom caching (not auto-caching).

Dependencies

• ioredis

Key Features

• Automatic Query Result Caching: Easily cache Prisma query results in Redis with minimal configuration.
• Selective Cache Invalidation: Invalidate specific Prisma queries to ensure accurate and up-to-date data retrieval.
• Fine-grained Control: Configure caching and invalidation settings on a per-query basis for granular control over caching behavior.
• Cache Invalidation Strategies: Implement cache invalidation strategies to ensure that cached data remains up-to-date.
• Versatile Functions: Utilize general-purpose functions for efficient Redis/Dragonfly database maintenance.

Deprecated Packages

The following packages are planned for deprecation. We recommend considering prisma-redis-extension for combined functionality:

• ⚠️ Deprecated Package: prisma-redis-cache
• ⚠️ Deprecated Package: prisma-redis-uncache

Why use prisma-redis-extension?

• Simplified Dependencies: Instead of managing multiple packages, you now only need prisma-redis-extension for all the features.
• Enhanced Maintenance: Centralized updates and improvements for all functionalities, leading to easier maintenance.
• Streamlined Codebase: Consolidate your codebase by eliminating redundant dependencies and optimizing performance.
• Community Focus: Join the community around prisma-redis-extension for collective support and collaborative development.

Upgrade to prisma-redis-extension today to experience a more streamlined and efficient Redis caching solution.