Skip to main content

.NET Core Distributed SQL Server Cache


A caching that can be shared or consumed by the multiple apps servers can be called a Distributed Cache. Distributed Cache is an external service, which increases the performance and scalability of applications. The advantages of Distributed Cache are like:
  • No effect on the cache server on an application crash.
  • No need to use local memory.
  • Consistency in serving cached data around multiple applications.
In General, Distributed Cache can be achieved by using Redi's Cache, SQL Cache, Third Party Cache Libraries. Here we will learn about .NET Core Distributed SQL Server Cache.

Create A .NET Core WebAPI Project:

Create a sample .NET Core Web API application to test the Distributed Cache. You can use either Visual Studio 2019 or Visual Studio Code editor, here I'm using Visual Studio Code. Click here to know basics steps to use Visual Studio Code for .NET Core applications

SQL Table For Cache:

To store the cache data we need a table. So .NET Core has defined a structure of the table like how the table should be and what the table should store data, in simple words a templated predefined cache table.

To create a SQL cache table .NET Core provided CLI command as follows.
dotnet sql-cache create "your_database_connection_string" dbo your_cache_table_name
If having any issue to create the SQL cache table using the above CLI command, we can create the cache table manually, but the column names and column type should match as .NET core prescribed by default. So run the following SQL script query to create a cache table.
CREATE TABLE [dbo].[MyCache]
    [SlidingExpirationInSeconds] BIGINT NULL, 
    [AbsoluteExpiration] DATETIMEOFFSET NULL
'Id' Column - is a primary column of type String. In this column, we need to store a 'key' value which helps query the table.
'Value' Column - its type is Binary. In these columns, we need to store data to be cached and stores the data in binary format.
'SlidingExpirationInSeconds' Column - its type is BigInt. In this column, we need to store time in seconds. If the record is not consumed by any application or client which means the record is idle for specified seconds in the 'SlidingExpirationInSeconds' then the record will be in expired state. Which means no client can consume this record.
'ExpiresAtTime' Column - its type is DateTime. In this column, we need to store the idle expiration DateTime. This means its value will be created by adding the total number of seconds in the 'SlidingExpirationInSeconds' column to the current DateTime.
'AbsoluteExpiration' Column - its type is DateTime. In this column, we need to store the absolute expiration of DateTime means a max lifetime of the record. 'ExpiresAtTime' column must be within the limit of the 'AbsoluteExpiration' column value.

Install SQL Server Cache NuGet:

Microsft provided an extended NuGet package for SQL Server Cache. Use the below command to install the package.
Package Manager:
Install-Package Microsoft.Extensions.Caching.SqlServer -Version 3.1.3
dotnet add package Microsoft.Extensions.Caching.SqlServer --version 3.1.3

Configure AddDistributedSqlServerCache Service:

Configure the cache database connection string to the app.setting.json file.
Configure AddDistributedSqlServerCache Service provider in Startup.cs file.
services.AddDistributedSqlServerCache(options => {
 options.ConnectionString = Configuration.GetConnectionString("MyWorldDbConnection");
 options.SchemaName = "dbo";
 options.TableName = "MyCache";
  • ConnectionString mapped to the value in the app.setting.json file. 
  • "dbo" is a SQL database schema. 
  • TableName mapped to the cache table which we created at the initial step.

IDistributedCache Interface:

IDistributedCache Interface is implemented from 'Microsoft.Extensions.Caching.Distributed' library. IDistributeCache is not specific to SQL Server Cache, but it was implemented like generic which supports all kinds of Distributed Cache like Redis, SQL Server Cache, etc. IDistributeCache supports the default dependency inject of .NET Core, so it can be easily injected in the application where ever needed. IDistributedCache Interface holds a set of methods that helps to work with cache, some of the methods like as below.
  • Get, GetAsync - fetches the cached data by the key passed to the method.
  • Set, SetAsync - saves the data to the cache table with a specific key.
  • Remove, RemoveAsync - removes the cached data with specific to key passed.
Create an API controller and inject the IDistributedCache interface into its constructor as below.
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Caching.Distributed;
namespace SqlDistributedCache.API.Controllers
    public class TestController: ControllerBase
        private readonly IDistributedCache _distributedCache;
        public TestController(IDistributedCache distributedCache)
            _distributedCache = distributedCache;

Save Data To SQL Cache Table:

IDistributedCache interface provided a method like SetAsync, SetStringAsync to store cache data.

SetAsync - this method expects data to be stored as Byte[]. So on using SetAsync overloaded methods we need explicitly convert the data to Byte[].

SetStringAsync - this is an extended method implemented by 'Microsoft.Extensions.Caching.Distributed'. So on using this method it simply expects the stored data to be String format. Internally it will convert that String data to Byte[] while saving to cache table.
IDistributedCache interface also provides non async methods like Set, SetString , but async methods recomended.
Here in the sample, we explore using SetStringAsync. let's look more about the SetStringAsync overloaded methods as below.

  • SetStringAsync(string key,string value, DistributedCacheEntryOptions options, CancellationToken token = default) in this overloaded method we pass 'key', 'value'(data to be catches), 'DistributeCacheEntryOptions' provides an explicit way of defining the expiration Date Time into our cache table
  • SetStringAsync(string key, string value, CancellationToken token = default) in this overload method we simply pass 'key' and data as string format to 'value' variable. Here we don't have an option to specify DateTime explicitly. So on using this method expiration Date Time will be assigned with default values that are implicitly or explicitly configured in 'AddDistributedSqlServerCache' service.
Let test cache saving using SetStringAsync method without 'DistributedCacheEntryOptions' parameter as follow
public async Task<IActionResult> AddCacheNoTimeOptions()
 string key = "test1";
 string value = "naveen";
 await _distributedCache.SetStringAsync(key, value);
 return Ok("success");
Now test this API route and check record added in the cache table.

  • In the 'Value' column the data to be cached is stored in Binary format.
  • In the 'Id' column stores key value.
  • Since we didn't specify any expiration options explicitly, then the default options set by the 'AddDistributedSqlServerCache' service will be stored in 'ExpiresAtTime', 'SlidingExpirationInSeconds' columns.
  • The default value for 'SlidingExpirationInSeconds' 20 minutes which will be saved as seconds(1200 seconds).
  • The default value for 'ExpiresAtTime' is the addition of current date time value with 'SlidingExpirationInSeconds' column.
Let's test the cache saving using the SetStringAsync method with the 'DistributedCacheEntryOptions' parameter which means specifying expiration values explicitly as follows.
public async Task<IActionResult> AddCache()
 string key = "test2";
 string value = "Naveen Bommindi";
 DistributedCacheEntryOptions options = new DistributedCacheEntryOptions
  SlidingExpiration = TimeSpan.FromMinutes(1),
  AbsoluteExpirationRelativeToNow = TimeSpan.FromHours(1)
 await _distributedCache.SetStringAsync(key, value, options);
 return Ok("success");
  • 'DistributedCacheEntryOptions' type helps to explicitly specify the expiration time values. 
  • Here property like 'SlidingExpiration' to 1 minute, this explains after being idle for 1 minute this record state will be expired. This 'SlidingExpiration' property value will be saved to the 'SlidingExpirationInSeconds' column in the cache table. 
  • Based on 'SlidingExpirationInSeconds' value, the column  'ExpireAtTime' value will be assigned(current date-time plus 'SlidingExpirationInSeconds' column value). 
  • Here property like 'AbsoluteExpirationRelativeToNow' is like the main expiration date-time, it will save the value in the 'AbsoluteExpiration' column. So the value in 'ExpireAtTime' value should be within the limits of the 'AbsoluteExpiration' column. 
  • By any chance the value in 'ExpireAtTime' is greater than 'AbsoluteExpiration' value then the record will be an expired state because 'AbsoluteExpiration' value takes priority.
Run application and access this new endpoint where expirations specified explicitly and then check the cache table as below.

Fetch Cached Data From SQL Cache Table:

IDistributedCache interface provided methods like GetAsync, GetStringAsync to fetch data.

GetAsync - this method expects an input parameter, which is 'key' to query the cache database. This GetAsync method return Byte[] array of data where we need to explicitly convert that result to a string before serving the results to API clients.

GetStringAsync - this method expects an input parameter, which is 'key' to query the cache database. This GetStringAsync method returns the string directly to the API clients. Basically, cache data is in Byte[] format while retrieving from the database but this method implicitly converts those Byte[] of data to the string.
IDistributedCache interface also provides non async methods like Get, GetString , but async methods recomended.
Let's implement an endpoint to fetch the cached data as follow.
public async Task<IActionResult> GetCache()
 string name = await _distributedCache.GetStringAsync("test2");
 return Ok(name);
Run the application and access the endpoint then look the result as follows.

Delete Cached Data:

IDistributedCache interface provided a method like RemoveAsync to delete the cached record from the cache table.

RemoveAsync - this method expects a 'key' as the input parameter, based on the 'key' value removes the record from the cache table.
IDistributedCache interface also provides non async method like Remove, but async methods recomended.
To test, create a sample endpoint to delete the cache data as below
public async Task<IActionResult> DeleteCache(string key)
 await _distributedCache.RemoveAsync(key);
 return Ok();

Configure SlidingExpriation Time Globally:

'AddDistributedSqlServerCache' service by default will configure SlidingExpiration time to 20 minutes. This time will get overridden if we use 'DistributedCacheEntryOptions' parameter in SetStringAsync or SetAsync methods.

To configure SlidingExpiration time globally and explicitly do as below.
services.AddDistributedSqlServerCache(options => {
 options.DefaultSlidingExpiration = TimeSpan.FromMinutes(10);
Here global default SlidingExpiration changed to 10 minutes.

Deleting Expired Items From Cache Table: 

'AddDistributedSqlServerCache' service by default configure with the option of deleting the expired cache records. It has an option like 'ExpiredItemsDeletionInterval' where it value by default assigned with 30 minutes. So if you want we can change it explicitly by assigning our own interval time.

If we are creating a cache item by using the SetStringAsync method without the 'DistributedCacheEntryOptions' parameter in this in our table 'AbsoluteExpiratin' column will be null.
So in this case after expiration on the 'ExpireAtTime' column, it will wait for 30  minutes and then deletes the record from the cache table.

If we are creating a cache item by using the SetStringAsync method with the 'DistributedCacheEntryOptions' parameter, in this case, we will 'AbsoluteExpriation' column with value. So after expiration on the 'AbsoluteExpiration' column, it will wait for 30 minutes and then deletes the record from the cache table.

Set 'ExpiredItemsDeletionInterval' as below
services.AddDistributedSqlServerCache(options => {
 options.ExpiredItemsDeletionInterval = TimeSpan.FromMinutes(6);
Here set deletion takes place after 6 minutes.

For 'ExpiredItemsDeletionInterval' there is constraint like its time should not be less than 5 minutes. If you try to set less the 5minutes application gives an error below.

Sample Code Caching Real Data:

For understanding purpose, created an endpoint for each IDistributedCache interface method. In real-time all methods mostly used inside of single endpoint based on its functionality.
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Caching.Distributed;
using SqlDistributedCache.API.Data;
using System.Threading.Tasks;
using Newtonsoft.Json;
using System.Linq;
using System.Collections.Generic;
using SqlDistributedCache.API.Entities;
using Microsoft.EntityFrameworkCore;
using System;

namespace SqlDistributedCache.API.Controllers
    public class GadgetController : ControllerBase
        private readonly IDistributedCache _distributedCache;
        private readonly MyWorldDbContext _myWorldDbContext;
        public GadgetController(
            IDistributedCache distributedCache,
            MyWorldDbContext myWorldDbContext)
            _distributedCache = distributedCache;
            _myWorldDbContext = myWorldDbContext;

        public async Task<IActionResult> Get()
            var cachedGadgets = await _distributedCache.GetStringAsync("myGadgets");
            if (!string.IsNullOrEmpty(cachedGadgets))
                List<Gadgets> result = JsonConvert.DeserializeObject<List<Gadgets>>(cachedGadgets);
                return Ok(new {IsCache = true,result});
                List<Gadgets> result = await _myWorldDbContext.Gadgets.ToListAsync();
                cachedGadgets = JsonConvert.SerializeObject(result);
                await _distributedCache.SetStringAsync("myGadgets", cachedGadgets, new DistributedCacheEntryOptions
                    SlidingExpiration = TimeSpan.FromMinutes(30),
                    AbsoluteExpirationRelativeToNow = TimeSpan.FromMinutes(30)
                return Ok(new {IsCache = false,result});

For complete implementation check the below GitHub link.
It is recomended to use seperate database to have cache tables.

Wrapping Up:

Hopefully, this article will help to understand the .NET Core Distributed SQL Server Cache. I love to have your feedback, suggestions, and better techniques in the comment section.


Follow Me:


Popular posts from this blog

.NET6 Web API CRUD Operation With Entity Framework Core

In this article, we are going to do a small demo on AspNetCore 6 Web API CRUD operations. What Is Web API: Web API is a framework for building HTTP services that can be accessed from any client like browser, mobile devices, desktop apps. In simple terminology API(Application Programming Interface) means an interface module that contains a programming function that can be requested via HTTP calls to save or fetch the data for their respective clients. Some of the key characteristics of API: Supports HTTP verbs like 'GET', 'POST', 'PUT', 'DELETE', etc. Supports default responses like 'XML' and 'JSON'. Also can define custom responses. Supports self-hosting or individual hosting, so that all different kinds of apps can consume it. Authentication and Authorization are easy to implement. The ideal platform to build REST full services. Create A .NET6 Web API Application: Let's create a .Net6 Web API sample application to accomplish our

Angular 14 Reactive Forms Example

In this article, we will explore the Angular(14) reactive forms with an example. Reactive Forms: Angular reactive forms support model-driven techniques to handle the form's input values. The reactive forms state is immutable, any form filed change creates a new state for the form. Reactive forms are built around observable streams, where form inputs and values are provided as streams of input values, which can be accessed synchronously. Some key notations that involve in reactive forms are like: FormControl - each input element in the form is 'FormControl'. The 'FormControl' tracks the value and validation status of form fields. FormGroup - Track the value and validate the state of the group of 'FormControl'. FormBuilder - Angular service which can be used to create the 'FormGroup' or FormControl instance quickly. Form Array - That can hold infinite form control, this helps to create dynamic forms. Create An Angular(14) Application: Let'

Part-1 Angular JWT Authentication Using HTTP Only Cookie[Angular V13]

In this article, we are going to implement a sample angular application authentication using HTTP only cookie that contains a JWT token. HTTP Only JWT Cookie: In a SPA(Single Page Application) Authentication JWT token either can be stored in browser 'LocalStorage' or in 'Cookie'. Storing JWT token inside of the cookie then the cookie should be HTTP Only. The HTTP-Only cookie nature is that it will be only accessible by the server application. Client apps like javascript-based apps can't access the HTTP-Only cookie. So if we use authentication with HTTP only JWT cookie then we no need to implement custom logic like adding authorization header or storing token data, etc at our client application. Because once the user authenticated cookie will be automatically sent to the server by the browser on every API call. Authentication API: To implement JWT cookie authentication we need to set up an API. For that, I had created a mock authentication API(Using the NestJS Se

Unit Testing Asp.NetCore Web API Using xUnit[.NET6]

In this article, we are going to write test cases to an Asp.NetCore Web API(.NET6) application using the xUnit. xUnit For .NET: The xUnit for .Net is a free, open-source, community-focused unit testing tool for .NET applications. By default .Net also provides a xUnit project template to implement test cases. Unit test cases build upon the 'AAA' formula that means 'Arrange', 'Act' and 'Assert' Arrange - Declaring variables, objects, instantiating mocks, etc. Act - Calling or invoking the method that needs to be tested. Assert - The assert ensures that code behaves as expected means yielding expected output. Create An API And Unit Test Projects: Let's create a .Net6 Web API and xUnit sample applications to accomplish our demo. We can use either Visual Studio 2022 or Visual Studio Code(using .NET CLI commands) to create any.Net6 application. For this demo, I'm using the 'Visual Studio Code'(using the .NET CLI command) editor. Create a fo

A Small Guide On NestJS Queues

NestJS Application Queues helps to deal with application scaling and performance challenges. When To Use Queues?: API request that mostly involves in time taking operations like CPU bound operation, doing them synchronously which will result in thread blocking. So to avoid these issues, it is an appropriate way to make the CPU-bound operation separate background job.  In nestjs one of the best solutions for these kinds of tasks is to implement the Queues. For queueing mechanism in the nestjs application most recommended library is '@nestjs/bull'(Bull is nodejs queue library). The 'Bull' depends on Redis cache for data storage like a job. So in this queueing technique, we will create services like 'Producer' and 'Consumer'. The 'Producer' is used to push our jobs into the Redis stores. The consumer will read those jobs(eg: CPU Bound Operations) and process them. So by using this queues technique user requests processed very fastly because actually

Usage Of CancellationToken In Asp.Net Core Applications

When To Use CancellationToken?: In a web application request abortion or orphan, requests are quite common. On users disconnected by network interruption or navigating between multiple pages before proper response or closing of the browser, tabs make the request aborted or orphan. An orphan request can't deliver a response to the client, but it will execute all steps(like database calls, HTTP calls, etc) at the server. Complete execution of an orphan request at the server might not be a problem generally if at all requests need to work on time taking a job at the server in those cases might be nice to terminate the execution immediately. So CancellationToken can be used to terminate a request execution at the server immediately once the request is aborted or orphan. Here we are going to see some sample code snippets about implementing a CancellationToken for Entity FrameworkCore, Dapper ORM, and HttpClient calls in Asp.NetCore MVC application. Note: The sample codes I will show in

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

Angular 14 State Management CRUD Example With NgRx(14)

In this article, we are going to implement the Angular(14) state management CRUD example with NgRx(14) NgRx Store For State Management: In an angular application to share consistent data between multiple components, we use NgRx state management. Using NgRx state helps to avoid unwanted API calls, easy to maintain consistent data, etc. The main building blocks for the NgRx store are: Actions - NgRx actions represents event to trigger the reducers to save the data into the stores. Reducer - Reducer's pure function, which is used to create a new state on data change. Store - The store is the model or entity that holds the data. Selector - Selector to fetch the slices of data from the store to angular components. Effects - Effects deals with external network calls like API. The effect gets executed based the action performed Ngrx State Management flow: The angular component needs data for binding.  So angular component calls an action that is responsible for invoking the API call.  Aft

Angular 14 Crud Example

In this article, we will implement CRUD operation in the Angular 14 application. Angular: Angular is a framework that can be used to build a single-page application. Angular applications are built with components that make our code simple and clean. Angular components compose of 3 files like TypeScript File(*.ts), Html File(*.html), CSS File(*.cs) Components typescript file and HTML file support 2-way binding which means data flow is bi-directional Component typescript file listens for all HTML events from the HTML file. Create Angular(14) Application: Let's create an Angular(14) application to begin our sample. Make sure to install the Angular CLI tool into our local machine because it provides easy CLI commands to play with the angular application. Command To Install Angular CLI npm install -g @angular/cli Run the below command to create the angular application. Command To Create Angular Application ng new name_of_your_app Note: While creating the app, you will see a noti