Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs improvements #228

Merged
merged 3 commits into from
Jan 26, 2024
Merged

Docs improvements #228

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d1e4ff4
Remove references to Redis where it doesn't apply
petermorlion Jan 26, 2024
f278db8
Correct title levels
petermorlion Jan 26, 2024
f3401df
Add an overview of the possible cache providers
petermorlion Jan 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 26 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@ You can also view the [package page](http://www.nuget.org/packages/EFCoreSecondL

### 1- [Register a preferred cache provider](/src/Tests/EFCoreSecondLevelCacheInterceptor.AspNetCoreSample/Startup.cs):

You can use the following cache providers:

- [Memory provider built in this library](#using-the-built-in-In-Memory-cache-provider)
- [EasyCaching.Core memory provider](#Using-EasyCaching.Core-as-the-cache-provider)
- [EasyCaching.Core dynamic cache provider](#Using-EasyCaching.Core-as-a-dynamic-cache-provider)
- [CacheManager.Core cache provider](#Using-CacheManager.Core-as-the-cache-provider-\[It's-not-actively-maintained\])
- [A custom cache provider](#Using-a-custom-cache-provider)]

#### Using the built-in In-Memory cache provider

![performance](/src/Tests/EFCoreSecondLevelCacheInterceptor.PerformanceTests/int-pref.png)
Expand All @@ -47,7 +55,7 @@ namespace EFCoreSecondLevelCacheInterceptor.AspNetCoreSample
{
services.AddEFSecondLevelCache(options =>
options.UseMemoryCacheProvider().DisableLogging(true).UseCacheKeyPrefix("EF_")
// Fallback on db if the caching provider (redis) is down.
// Fallback on db if the caching provider fails.
.UseDbCallsIfCachingProviderIsDown(TimeSpan.FromMinutes(1))

// Please use the `CacheManager.Core` or `EasyCaching.Redis` for the Redis cache provider.
Expand All @@ -66,7 +74,7 @@ namespace EFCoreSecondLevelCacheInterceptor.AspNetCoreSample
}
```

### Using EasyCaching.Core as the cache provider
#### Using EasyCaching.Core as the cache provider

Here you can use the [EasyCaching.Core](https://github.com/dotnetcore/EasyCaching), as a highly configurable cache manager too.
To use its in-memory caching mechanism, add this entry to the `.csproj` file:
Expand All @@ -89,7 +97,7 @@ namespace EFSecondLevelCache.Core.AspNetCoreSample
const string providerName1 = "InMemory1";
services.AddEFSecondLevelCache(options =>
options.UseEasyCachingCoreProvider(providerName1, isHybridCache: false).DisableLogging(true).UseCacheKeyPrefix("EF_")
// Fallback on db if the caching provider (redis) is down.
// Fallback on db if the caching provider fails.
.UseDbCallsIfCachingProviderIsDown(TimeSpan.FromMinutes(1))
);

Expand Down Expand Up @@ -148,7 +156,7 @@ namespace EFSecondLevelCache.Core.AspNetCoreSample
const string providerName1 = "Redis1";
services.AddEFSecondLevelCache(options =>
options.UseEasyCachingCoreProvider(providerName1, isHybridCache: false).DisableLogging(true).UseCacheKeyPrefix("EF_")
// Fallback on db if the caching provider (redis) is down.
// Fallback on db if the caching provider fails (for example, if Redis is down).
.UseDbCallsIfCachingProviderIsDown(TimeSpan.FromMinutes(1))
);

Expand Down Expand Up @@ -190,7 +198,7 @@ namespace EFSecondLevelCache.Core.AspNetCoreSample
[Here is a sample about it](/src/Tests/Issues/Issue123WithMessagePack/EFServiceProvider.cs).


### Using EasyCaching.Core as a dynamic cache provider
#### Using EasyCaching.Core as a dynamic cache provider

If you want to support multitenancy in your application and have a different Redis database per each tenant, first register multiple pre-configured providers with known `providerName`s and then select these `providerName`s based on the current tenant this way dynamically:

Expand All @@ -203,13 +211,13 @@ services.AddEFSecondLevelCache(options =>
.UseCacheKeyPrefix(serviceProvider => "EF_" + serviceProvider.GetRequiredService<IHttpContextAccesor>().HttpContext.Request.Headers["tenant-id"])
.DisableLogging(true)
.UseCacheKeyPrefix("EF_")
// Fallback on db if the caching provider (redis) is down.
// Fallback on db if the caching provider fails.
.UseDbCallsIfCachingProviderIsDown(TimeSpan.FromMinutes(1))
);
```


### Using CacheManager.Core as the cache provider [It's not actively maintained]
#### Using CacheManager.Core as the cache provider [It's not actively maintained]

Also here you can use the [CacheManager.Core](https://github.com/MichaCo/CacheManager), as a highly configurable cache manager too.
To use its in-memory caching mechanism, add these entries to the `.csproj` file:
Expand All @@ -233,7 +241,7 @@ namespace EFSecondLevelCache.Core.AspNetCoreSample
{
services.AddEFSecondLevelCache(options =>
options.UseCacheManagerCoreProvider().DisableLogging(true).UseCacheKeyPrefix("EF_")
// Fallback on db if the caching provider (redis) is down.
// Fallback on db if the caching provider fails.
.UseDbCallsIfCachingProviderIsDown(TimeSpan.FromMinutes(1))
);

Expand Down Expand Up @@ -285,14 +293,14 @@ services.AddSingleton(typeof(ICacheManager<>), typeof(BaseCacheManager<>));

services.AddEFSecondLevelCache(options =>
options.UseCacheManagerCoreProvider().DisableLogging(true).UseCacheKeyPrefix("EF_")
// Fallback on db if the caching provider (redis) is down.
// Fallback on db if the caching provider fails.
.UseDbCallsIfCachingProviderIsDown(TimeSpan.FromMinutes(1))
);
```

[Here is](/src/Tests/EFCoreSecondLevelCacheInterceptor.Tests/Settings/EFServiceProvider.cs#L21) the definition of the SpecialTypesConverter.

### Using a custom cache provider
#### Using a custom cache provider

If you don't want to use the above cache providers, implement your custom `IEFCacheServiceProvider` and then introduce it using the `options.UseCustomCacheProvider<T>()` method.

Expand Down Expand Up @@ -363,7 +371,7 @@ Also it's possible to set the `Cacheable()` method's settings globally:
```csharp
services.AddEFSecondLevelCache(options => options.UseMemoryCacheProvider(CacheExpirationMode.Absolute, TimeSpan.FromMinutes(5)).DisableLogging(true)
.UseCacheKeyPrefix("EF_")
// Fallback on db if the caching provider (redis) is down.
// Fallback on db if the caching provider fails.
.UseDbCallsIfCachingProviderIsDown(TimeSpan.FromMinutes(1))
);
```
Expand Down Expand Up @@ -395,7 +403,7 @@ namespace EFCoreSecondLevelCacheInterceptor.AspNetCoreSample
{
options.UseMemoryCacheProvider().DisableLogging(true).UseCacheKeyPrefix("EF_");
options.CacheAllQueries(CacheExpirationMode.Absolute, TimeSpan.FromMinutes(30));
// Fallback on db if the caching provider (redis) is down.
// Fallback on db if the caching provider fails.
options.UseDbCallsIfCachingProviderIsDown(TimeSpan.FromMinutes(1));
});

Expand All @@ -418,7 +426,7 @@ namespace EFCoreSecondLevelCacheInterceptor.AspNetCoreSample
services.AddEFSecondLevelCache(options =>
{
options.UseMemoryCacheProvider().DisableLogging(true).UseCacheKeyPrefix("EF_")
// Fallback on db if the caching provider (redis) is down.
// Fallback on db if the caching provider fails.
.UseDbCallsIfCachingProviderIsDown(TimeSpan.FromMinutes(1))
/*.CacheQueriesContainingTypes(
CacheExpirationMode.Absolute, TimeSpan.FromMinutes(30), TableTypeComparison.Contains,
Expand Down Expand Up @@ -449,7 +457,7 @@ namespace EFCoreSecondLevelCacheInterceptor.AspNetCoreSample
services.AddEFSecondLevelCache(options =>
{
options.UseMemoryCacheProvider().DisableLogging(true).UseCacheKeyPrefix("EF_")
// Fallback on db if the caching provider (redis) is down.
// Fallback on db if the caching provider fails.
.UseDbCallsIfCachingProviderIsDown(TimeSpan.FromMinutes(1))
// How to skip caching specific commands
.SkipCachingCommands(commandText =>
Expand All @@ -472,7 +480,7 @@ namespace EFCoreSecondLevelCacheInterceptor.AspNetCoreSample
services.AddEFSecondLevelCache(options =>
{
options.UseMemoryCacheProvider().DisableLogging(true).UseCacheKeyPrefix("EF_")
// Fallback on db if the caching provider (redis) is down.
// Fallback on db if the caching provider fails.
.UseDbCallsIfCachingProviderIsDown(TimeSpan.FromMinutes(1))
// Don't cache null values. Remove this optional setting if it's not necessary.
.SkipCachingResults(result =>
Expand All @@ -495,7 +503,7 @@ namespace EFCoreSecondLevelCacheInterceptor.AspNetCoreSample
services.AddEFSecondLevelCache(options =>
{
options.UseMemoryCacheProvider().DisableLogging(true).UseCacheKeyPrefix("EF_")
// Fallback on db if the caching provider (redis) is down.
// Fallback on db if the caching provider fails.
.UseDbCallsIfCachingProviderIsDown(TimeSpan.FromMinutes(1))
/*.CacheAllQueriesExceptContainingTypes(
CacheExpirationMode.Absolute, TimeSpan.FromMinutes(30),
Expand Down Expand Up @@ -526,7 +534,7 @@ namespace EFCoreSecondLevelCacheInterceptor.AspNetCoreSample
services.AddEFSecondLevelCache(options =>
{
options.UseMemoryCacheProvider().DisableLogging(true).UseCacheKeyPrefix("EF_")
// Fallback on db if the caching provider (redis) is down.
// Fallback on db if the caching provider fails.
.UseDbCallsIfCachingProviderIsDown(TimeSpan.FromMinutes(1))
.SkipCacheInvalidationCommands(commandText =>
// How to skip invalidating the related cache entries of this query
Expand Down Expand Up @@ -564,7 +572,7 @@ First set the `DisableLogging(false)`:
```c#
services.AddEFSecondLevelCache(options =>
options.UseMemoryCacheProvider().DisableLogging(false).UseCacheKeyPrefix("EF_")
// Fallback on db if the caching provider (redis) is down.
// Fallback on db if the caching provider fails.
.UseDbCallsIfCachingProviderIsDown(TimeSpan.FromMinutes(1))
```

Expand Down
Loading