File: SqlServerCacheOptions.cs
Web Access
Project: src\src\Caching\SqlServer\src\Microsoft.Extensions.Caching.SqlServer.csproj (Microsoft.Extensions.Caching.SqlServer)
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
using System;
using Microsoft.Extensions.Internal;
using Microsoft.Extensions.Options;
 
namespace Microsoft.Extensions.Caching.SqlServer;
 
/// <summary>
/// Configuration options for <see cref="SqlServerCache"/>.
/// </summary>
public class SqlServerCacheOptions : IOptions<SqlServerCacheOptions>
{
    /// <summary>
    /// An abstraction to represent the clock of a machine in order to enable unit testing.
    /// </summary>
    public ISystemClock SystemClock { get; set; } = new SystemClock();
 
    /// <summary>
    /// The periodic interval to scan and delete expired items in the cache. Default is 30 minutes.
    /// </summary>
    public TimeSpan? ExpiredItemsDeletionInterval { get; set; }
 
    /// <summary>
    /// The connection string to the database.
    /// </summary>
    public string? ConnectionString { get; set; }
 
    /// <summary>
    /// The schema name of the table.
    /// </summary>
    public string? SchemaName { get; set; }
 
    /// <summary>
    /// Name of the table where the cache items are stored.
    /// </summary>
    public string? TableName { get; set; }
 
    /// <summary>
    /// The default sliding expiration set for a cache entry if neither Absolute or SlidingExpiration has been set explicitly.
    /// By default, its 20 minutes.
    /// </summary>
    public TimeSpan DefaultSlidingExpiration { get; set; } = TimeSpan.FromMinutes(20);
 
    SqlServerCacheOptions IOptions<SqlServerCacheOptions>.Value
    {
        get
        {
            return this;
        }
    }
}