AspNetCore.ResponseCache.NCache 5.3.7

AspNetCore.ResponseCache.NCache

This package provides assemblies for using NCache as a distributed response caching provider. It lets MVC view/action output (HTML) be stored in NCache instead of an in-memory response cache, reducing database load and improving performance in multi-server environments. It also supports SQL Server dependency notifications (SqlDependency), so a cached response tied to a specific table is automatically invalidated when the underlying data changes.

Installation

Install-Package AspNetCore.ResponseCache.NCache

or, using the .NET CLI:

dotnet add package AspNetCore.ResponseCache.NCache

What is Installed

Installing this package adds the following NCache configuration files to your project:

• client.ncconf — Contains information about the cache servers of each cache the application needs to access.
• config.ncconf — Used for local inproc cache and inproc client caches. For a client cache, this file must also contain the name of the clustered cache that the client cache is a part of.
• tls.ncconf — Contains TLS/SSL settings used to secure communication between the client and the NCache cluster, if enabled.

NCache tries to read cache information from these local config files first. If the required information isn't found locally, it falls back to the configs inside the NCache installation directory. If NCache is not installed on the machine running the application, make sure all required information is present in the local configs.

Prerequisites

• ASP.NET Core application on .NET 6.0+
• NCache SDK 5.3.7.1 or later.
• An NCache server up and running, with the target cache already created/registered on it.
• SQL Server with Service Broker enabled — only required if EnableSqlDependency is turned on for automatic cache invalidation.(Optional)

Getting Started

Setting up NCache

Update client.ncconf so the client knows which cache to connect to and where to find it:

1. Open client.ncconf.
2. Locate the cache entry named demoCache and rename it to the name of your actual cache (the cache you created/registered on the NCache server).
3. Under the server settings, update the server address to point to one of the nodes in the cluster where that cache is running.

Setting up Package

Register NCache response caching in Program.cs:

using Alachisoft.NCache.ResponseCaching;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddControllersWithViews();

// Bind NCache-specific settings from appsettings.json
builder.Services.AddOptions()
    .Configure<NCacheConfiguration>(builder.Configuration.GetSection("NCacheSettings"));

// Register NCache as the response caching provider
builder.Services.AddNCacheResponseCachingServices();

var app = builder.Build();
// ... standard middleware (UseHttpsRedirection, UseStaticFiles, UseRouting, UseAuthorization, etc.)
app.Run();

Configuration

ASP.NET Core (appsettings.json):

{
  "NCacheSettings": {
    "CacheName": "demoCache",
    "DefaultConnectionStringName": "DemoDBServer",
    "EnableSqlDependency": true,
    "SqlDependencySettings": {
      "DatabaseName": "Northwind",
      "TableName": "dbo.Products"
    }
  },
  "ConnectionStrings": {
    "DemoDBServer": "Server=<host>,1433;Database=<database-name>;User Id=<user>;Password=<password>;TrustServerCertificate=True;"
  }
}

• CacheName — the NCache cache to use for storing responses.
• DefaultConnectionStringName — must match a key under ConnectionStrings; used for the SQL dependency connection.
• EnableSqlDependency — turn on/off automatic invalidation via SQL Server query notifications.
• SqlDependencySettings — scopes the dependency to a specific DatabaseName/TableName; when a row in that table changes, cached responses built from it are invalidated.

Resources

• NCache Integration Docs
• Client SDK Docs
• Sample Code on GitHub
• Programmer's Guide

Technical Support

Alachisoft provides various technical support resources. Visit the Alachisoft Support Center to select a support resource appropriate for your issue. To request additional features or report a documentation discrepancy, contact support@alachisoft.com.

License

Copyright © 2026 Alachisoft. All rights reserved.