Skip to main content

Use Azure Cache For Redis In NestJS Application

In this article, we are going to do a small demo on the integration of Azure Redis Cache into the NestJS application.

Redis Cache:

Redis is an open-source in-memory data structure store, used as a database, cache. It supports data structures such as strings, hashes, lists, sets, stored sets with range queries, etc.
Let's understand the flow of Redis cache in a web application:
  • Users request a page from the web application.
  • Web application queries the Redis store, if the data exists, then fetches the data and returns the response directly to the user.
  • If no data is in the Redis store, the application queries the database and fetches the data, next save the same data into the Redis store so that subsequent user request can consume the data from the Redis store directly, finally returns the response to the users.

Create A Azure Redis Cache:

Create and sign-in into the Azure portal(

On the Azure portal home page click on 'Create a resource'.
On the 'Create a resource' page select the 'Databases' and then select 'Azure Cache for Redis'.
(1)On the 'New Redis Cache' page, enter the project details.
  • Subscription- Choose your subscription plan from the dropdown.
  • Resource group - Either create a new resource group or select an existing group from the drop-down.
  • DNS name- Enter the name of your Redis instance subdomain name.
  • Location- Choose your server location from the dropdown.
  • Cache type- Select pricing plans for Redis usage. no free plans on it.
(2)Choose your type of 'Network Connectivity'.
(3)In the 'Advanced' tab you can choose the version of the Redis instance.
(4)The 'Tags', name/value pairs is an optional section.
(5)Finally, select 'Review+ Create', on successful validation, select 'create', on success in a few minutes our Redis instance will be ready.

Create A NestJS Sample Application:

Let's create a sample NestJS application to accomplish our demo.
Command To Install NestJS CLI
npm i -g @nestjs/cli

Command To Create NestJS App
nest new your_project_name

Install Cache Npm Packages:

NestJS Cache NPM Packages:
npm install cache-manager
npm install -D @types/cache-manager
npm install cache-manager-redis-store --save

Azure Redis ConnectionString:

(1)On the Azure portal home page click on 'Resource groups'.
(2) On the 'Resource groups' page, select the resource group that has our Azure cache for Redis.
(3) Now click 'Azure Cache for Redis' instance.
(4) Now under 'Settings' select 'Access Keys', then copy the connection string either primary or secondary connection string.

In the connection string, we have to identify like 'Host Name', 'Port Number', 'Password'.

Redis Store Configuration:

Now let's register the CacheModule with the Redis Store configuration in AppModule.
import { Module, CacheModule } from '@nestjs/common';
import * as redisStore from 'cache-manager-redis-store';

// existing code hidden for display purpose

  imports: [CacheModule.register({
    store: redisStore,
export class AppModule {}
  • (Line: 1) The 'CacheModule' loads from the '@nestjs/common'.
  • (Line: 2) Importing the 'cache-manager-redis-store' library.
  • (Line: 7-16) Registered the 'CahceModule' with Redis configurations. The 'store' define type of cache, 'port' is our Azure Redis cache running port number, 'auth_pass' is our Azure Redis cache password, 'host' is our Azure Redis hostname, 'tls' means Transport Layer Security that is by default enabled by the Azure Redis cache so it is mandatory to define the 'tls' configuration and inside of it we have to specify our Redis hostname again.

Inject CacheManager:

Now in our controllers to communicate with the Azure Redis store we need to inject the CacheManager.
import { Controller, Get, CACHE_MANAGER, Inject, CacheTTL } from '@nestjs/common';
import { Cache } from 'cache-manager';

export class AppController {
  constructor(@Inject(CACHE_MANAGER) private cacheManager: Cache) {}
  • The 'Cache' type is generic and works with any cache-store and provides default methods for cache communication. The 'CACHE_MANAGER' is a lookup for the provider to be injected which means it will inject the cache-store that is registered by the CacheModule, in our sample, it will inject Redis cache-store.

Create A Sample Response Model:

Now let's create a sample API response model like 'car.ts'.
export interface Car {
  id: number;
  manufacturer: string;
  model: string;
  year: number;
Now in 'app.controller.ts' for demo purposes let's add a variable that contains mock data or test data of type 'Car'. In a real application, data need to be fetched from the database, for demo purposes just storing in a variable.
// existing code hidden for display purpose
export class AppController {
  fakeDatabase: Car[] = [
      id: 1,
      manufacturer: 'Honda',
      model: 'Civic',
      year: 2021,
      id: 2,
      manufacturer: 'Hundyi',
      model: 'Venue',
      year: 2022,

Get And Set Methods:

The 'Set' method is to store our data in the Redis Store. The 'Get' method to fetch data from the Redis store.

Let's store a sample string and fetch it from the Redis store by creating a sample endpoint.
async getCars() {
	var carsFromRedis = await this.cacheManager.get<Car[]>('cars-store');

	if (carsFromRedis && carsFromRedis.length > 0) {
	  return { loadedFromRedis: true, data: carsFromRedis };

	await this.cacheManager.set<Car[]>("cars-store", this.fakeDatabase)
	return { loadedFromRedis: false, data: this.fakeDatabase };
  • (Line: 3) Using 'get<Car[]>()' method of cache manager trying to fetch data from the Redis store.
  • (Line: 5-7) If Redis store returns the property data then we will return it as a response to our endpoint. Here for understanding, I have added property like 'loadedFromRedis' to the response(don't add a property like this for real applications).
  • (Line: 9) If the Redis store doesn't have data then this gets executed. Here using the 'set<Car[]>()' method we are saving the data to the Redis store with an appropriate key.
Now run the application, for the first request we can observe no data in Redis.
Now from the 2nd request data gets loads from the Redis server.

Cache Expiration:

It is always recommended to specify the expiration value for the cache. So we have to approach to define cache values like 'Global Level', 'Endpoint Level'.

Defining Global level expiration sets the same expiration value for all the data that we stored in the Redis store.
    store: redisStore,
    ttl: 300 // define time in seconds
  • Here the 'ttl' property contains time seconds for expiration. So here I define expiration like all Redis cache store data will be expired after 300 seconds.
Defining Endpoint level expiration sets individual expiration values for each endpoint. This can be done by using a decorator like '@CacheTTL(specify_expiration_in_seconds)'. The '@CacheTTL()' overrides the Global expiration that we defined above.
async getCars() {
	var carsFromRedis = await this.cacheManager.get<Car[]>('cars-store');
	if (carsFromRedis && carsFromRedis.length > 0) {
	  return { loadedFromRedis: true, data: carsFromRedis };

	await this.cacheManager.set<Car[]>("cars-store", this.fakeDatabase)
	return { loadedFromRedis: false, data: this.fakeDatabase };
  • (Line: 2) Used endpoint level expiration on a method by decorating with '@CacheTTL()'

Del And Reset Methods:

The cache store provides the method 'del('key')' used to delete the record from the cache.
await this.cacheManager.del('your_key_to_delte');
The cache store provides the method 'reset()' used to clear the entire Redis store cache.
await this.cacheManager.reset()

Support Me!
Buy Me A Coffee PayPal Me

Wrapping Up:

Hopefully, I think this article delivered some useful information on Use Azure Cache For Redis in the NestJS application. using I love to have your feedback, suggestions, and better techniques in the comment section below.

Follow Me:


Popular posts from this blog

Blazor WebAssembly Custom Authentication From Scratch

In this article, we are going to explore and implement custom authentication from the scratch. In this sample, we will use JWT authentication for user authentication. Main Building Blocks Of Blazor WebAssembly Authentication: The core concepts of blazor webassembly authentication are: AuthenticationStateProvider Service AuthorizeView Component Task<AuthenticationState> Cascading Property CascadingAuthenticationState Component AuthorizeRouteView Component AuthenticationStateProvider Service - this provider holds the authentication information about the login user. The 'GetAuthenticationStateAsync()' method in the Authentication state provider returns user AuthenticationState. The 'NotifyAuthenticationStateChaged()' to notify the latest user information within the components which using this AuthenticationStateProvider. AuthorizeView Component - displays different content depending on the user authorization state. This component uses the AuthenticationStateProvider

How Response Caching Works In Asp.Net Core

What Is Response Caching?: Response Caching means storing of response output and using stored response until it's under it's the expiration time. Response Caching approach cuts down some requests to the server and also reduces some workload on the server. Response Caching Headers: Response Caching carried out by the few Http based headers information between client and server. Main Response Caching Headers are like below Cache-Control Pragma Vary Cache-Control Header: Cache-Control header is the main header type for the response caching. Cache-Control will be decorated with the following directives. public - this directive indicates any cache may store the response. private - this directive allows to store response with respect to a single user and can't be stored with shared cache stores. max-age - this directive represents a time to hold a response in the cache. no-cache - this directive represents no storing of response and always fetch the fr

.Net5 Web API Managing Files Using Azure Blob Storage

In this article, we are going to understand the different file operations like uploading, reading, downloading, and deleting in .Net5 Web API application using Azure Blob Storage. Azure Blob Storage: Azure blob storage is Microsoft cloud storage. Blob storage can store a massive amount of file data as unstructured data. The unstructured data means not belong to any specific type, which means text or binary data. So something like images or pdf or videos to store in the cloud, then the most recommended is to use the blob store. The key component to creating azure blob storage resource: Storage Account:- A Storage account gives a unique namespace in Azure for all the data we will save. Every object that we store in Azure Storage has an address. The address is nothing but the unique name of our Storage Account name. The combination of the account name and the Azure Storage blob endpoint forms the base address for each object in our Storage account. For example, if our Storage Account is n

.Net5 Web API Redis Cache Using StackExchange.Redis.Extensions.AspNetCore Library

In this article, we are going to explore the integration of Redis cache in .Net5 Web API application using the 'StackExchange.Redis.Exntensions' library. Note:- Microsoft has introduced an 'IDistributedCache' interface in dotnet core which supports different cache stores like In-Memory, Redis, NCache, etc. It is simple and easy to work with  'IDistributedCache', for the Redis store with limited features but if we want more features of the Redis store we can choose to use 'StackExchange.Redis.Extensions'.  Click here for Redis Cache Integration Using IDistributedCache Interface . Overview On StackExchange.Redis.Extnesions Library: The 'StackExchange.Redis.Extension' library extended from the main library 'StackExchange.Redis'. Some of the key features of this library like: Default serialization and deserialization. Easy to save and fetch complex objects. Search key. Multiple Database Access Setup Redis Docker Instance: For this sampl

Endpoint Routing In Asp.Net Core

How Routing Works In  Core 2.1 And Below Versions?: In Asp.Net Core routing is configured using app.UseRouter() or app.UseMvc() middleware. app.UseMvc(routes => { routes.MapRoute( name: "default", template: "{controller=Home}/{action=Index}/{id?}"); }); Here in Dotnet Core version 2.1 or below versions on the execution of route middleware request will be navigated appropriate controller matched to the route. An operation or functionality which is dependent on route URL or route values and that need to be implemented before the execution of route middleware can be done by accessing the route path from the current request context as below app.Use(async (context, next) => { if(context.Request.Path.Value.IndexOf("oldvehicle") != -1) { context.Response.Redirect("vehicle"); } else { await next(); } }); app.UseMvc(routes => { routes.MapRoute( name: "vehicleRoute", template: "vehicle", defaul

Asp.Net Core MVC Form Validation Techniques

Introduction: Form validations in any applications are like assures that a valid data is storing on servers. All programing frameworks have their own individual implementations for form validations. In Dotnet Core MVC application server-side validations carried on by the models with the help of Data Annotations and the client-side validations carried by the plugin jQuery Unobtrusive Validation. jQuery Unobtrusive Validation is a custom library developed by Microsoft based on the popular library  jQuery Validate . In this article, we are going to learn how the model validation and client-side validation works in Asp.Net Core MVC Application with sample examples. Getting Started: Let's create an Asp.Net Core MVC application project using preferred editors like Microsoft Visual Studio or Microsoft Visual Studio Code. Here I'm using Visual Studio. Let's create an MVC controller and name it as 'PersonController.cs' and add an action method as bel

NestJS File Upload

In this article, we are going to understand the steps to create a file uploading endpoint in the NestJS application. Key Features In NestJS File Upload: Let us know some key features of NestJS file upload before implementing a sample application. FileInterceptor: The 'FileInterceptor' will be decorated on top of the file upload endpoint. This interceptor will read single file data from the form posted to the endpoint. export declare function FilesInterceptor(fieldName: string, localOptions?: MulterOptions): Type<NestInterceptor>; Here we can observe the 'fieldName' first input parameter this value should be a match with our 'name' attribute value on the form file input field. So our interceptor read our files that are attached to the file input field. Another input parameter of 'MulterOptions' that provides configuration like file destination path, customizing file name, etc. FilesInterceptor: The 'FilesInterceptor' will be decorated on t

.NET Core MVC Application File Upload To Physical Location With Buffered Technique

Buffering Technique In File Upload: The server will use its Memory(RAM) or Disk Storage to save the files on receiving a file upload request from the client.  Usage of Memory(RAM) or Disk depends on the number of file requests and the size of the file.  Any single buffered file exceeding 64KB is moved from Memory to a temp file on disk.  If an application receives heavy traffic of uploading files there might be a chance of out of Disk or RAM memory which leads to crash application. So this Buffer technique used for small files uploading. In the following article, we create a sample for the file uploading using .NET Core MVC application. Create The .NET Core MVC Project: Let's create a .NET Core MVC project, here for this sample I'm using Visual Studio Code as below.   Check the link to use the Visual Studio Code for .NET Core Application . IFormFile: Microsoft.AspNetCore.Http.IFormFile used for file upload with buffered technique. On uploading files f

Ionic Picker Sample Code In Angular

Introduction: Ionic Picker(ion-picker) is a popup slides up from the bottom of the device screen, which contains rows with selectable column separated items. The main building block of ion-picker as follows: PickerController PickerOptions PickerController: PickerController object helps in creating an ion-picker overlay. create(opts?: Opts): Promise<Overlay> PickerController create method helps in create the picker overlay with the picker options PickerOptions: PickerOptions is a configuration object used by PickerController to display ion-picker. Single Column Ionic Picker: single.item.picker.ts: import { Component } from "@angular/core"; import { PickerController } from "@ionic/angular"; import { PickerOptions } from "@ionic/core"; @Component({ selector: "single-column-picker", templateUrl:"single.item.picker.html" }) export class SingleItemPicker { animals: string[] = ["Tiger&quo

.Net Core HttpClient JSON Extension Methods Using System.Net.Http.Json Package

.Net Core 3.0 onwards Microsoft brought up a new package called System.Net.Http.Json. This new package provides JSON extension methods for HttpClient. These JSON extension methods will have a prebuild mechanism for serializing or deserializing response data or payload of HttpClient call. System.Net.Http.Json extension methods that are provided to HttpClient, few of them are mentioned below. GetFromJsonAsync PostAsJsonAsync PutAsJsonAsync ReadFromJsonAsync In this article, we understand System.Net.Http.Json package by implementing the HttpClient samples by with and without JSON extension methods and compare them. Create A .Net Core Web API Sample Application: Let's create a .Net Core sample Web API application, from this application we will consume another Web API by implementing HttpClient calls. We can create a Web API sample application using IDE like Visual Studio 2019(Supports .Net Core 3.0 plus) or  Visual Studio Code . Create A Typed Client: In .Net Core using the Http