Skip to content

Latest commit

 

History

History
79 lines (57 loc) · 3.22 KB

SQLAsyncOutputCacheProvider.md

File metadata and controls

79 lines (57 loc) · 3.22 KB

Microsoft.AspNet.OutputCache.SQLAsyncOutputCacheProvider

Overview

SQLAsyncOutputCacheProvider is an asynchronous SQL Server-based output cache provider for ASP.NET. It enables storing ASP.NET output cache data in a SQL Server database, allowing for distributed caching across web farm scenarios.

Features

  • Asynchronous database operations for improved scalability via integration with OutputCacheModuleAsync
  • Traditional or In-Memory OLTP tables for cache storage

Requirements

  • .NET Framework 4.6.2 or later (Full framework - not .NET Core)
  • SQL Server 2014 (12.0) or later for In-Memory OLTP support

Usage

  1. Target your application to .NET Framework 4.6.2 or later

    The OutputCacheProviderAsync interface was introduced in .NET Framework 4.6.2, therefore you need to target your application to .NET Framework 4.6.2 or above in order to use the Async OutputCache Module. Download the .NET Framework 4.6.2 Developer Pack if you do not have it installed yet and update your application's web.config targetFramework attributes as demonstrated below:

    <system.web>
  <compilation debug="true" targetFramework="4.6.2"/>
  <httpRuntime targetFramework="4.6.2"/>
</system.web>

  2. Add NuGet packages

    Use the NuGet package manager to install:

    This will add a reference to the necessary assemblies and configuration similar to the following into the web.config file.

    <system.web>
  <caching>
    <outputCache defaultProvider="SQLAsyncOutputCacheProvider">
      <providers>
        <add name="SQLAsyncOutputCacheProvider" connectionStringName="DefaultConnection" UseInMemoryTable="[true|false]"
             type="Microsoft.AspNet.OutputCache.SQLAsyncOutputCacheProvider.SQLAsyncOutputCacheProvider, Microsoft.AspNet.OutputCache.SQLAsyncOutputCacheProvider, Version=1.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35"/>
      </providers>
    </outputCache>
  </caching>
</system.web>

  3. Further Configuration

    Be sure that web.config includes both the connection string and the OutputCacheModuleAsync configuration:

    <configuration>
  <connectionStrings>
    <add name="SQLOutputCache" 
         connectionString="Data Source=<myserver>;Initial Catalog=OutputCache;Integrated Security=True" 
         providerName="System.Data.SqlClient" />
  </connectionStrings>

  <system.webServer>
    <modules>
      <remove name="OutputCache" />
      <add name="OutputCache" 
           type="Microsoft.AspNet.OutputCache.OutputCacheModuleAsync, Microsoft.AspNet.OutputCache.OutputCacheModuleAsync" 
           preCondition="integratedMode" />
    </modules>
  </system.webServer>
</configuration>

Updates

v1.0.1

  • Initial release.