WiredViews.Kentico.FluentCacheKeys 2.3.0-prerelease-2-1

Prefix Reserved

This is a prerelease version of WiredViews.Kentico.FluentCacheKeys.

There is a newer version of this package available.
See the version list below for details.

dotnet add package WiredViews.Kentico.FluentCacheKeys --version 2.3.0-prerelease-2-1

NuGet\Install-Package WiredViews.Kentico.FluentCacheKeys -Version 2.3.0-prerelease-2-1

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="WiredViews.Kentico.FluentCacheKeys" Version="2.3.0-prerelease-2-1" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add WiredViews.Kentico.FluentCacheKeys --version 2.3.0-prerelease-2-1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: WiredViews.Kentico.FluentCacheKeys, 2.3.0-prerelease-2-1"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

// Install WiredViews.Kentico.FluentCacheKeys as a Cake Addin
#addin nuget:?package=WiredViews.Kentico.FluentCacheKeys&version=2.3.0-prerelease-2-1&prerelease

// Install WiredViews.Kentico.FluentCacheKeys as a Cake Tool
#tool nuget:?package=WiredViews.Kentico.FluentCacheKeys&version=2.3.0-prerelease-2-1&prerelease

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Kentico Fluent Cache Keys

Utility library for generating consistent cache dependency keys for Kentico Xperience applications

Packages

How to Use?

Install the WiredViews.Kentico.FluentCacheKeys NuGet package in your project:
```
dotnet add package WiredViews.Kentico.FluentCacheKeys
```

Examples

Creating cache keys for pages / documents / nodes

FluentCacheKey.ForPage().WithDocumentId(5);

FluentCacheKey.ForPage().WithNodeId(4);

FluentCacheKey.ForPage().RelationshipsOfNodeId(4);

FluentCacheKey.ForPage().OfSite("Sandbox").WithAliasPath("/home");

FluentCacheKey.ForPage().OfSite("Sandbox").WithAliasPath("/home", "en-us");

FluentCacheKey.ForPages().OfSite("Sandbox").OfClassName(HomePage.CLASS_NAME);

FluentCacheKey.ForPages().OfSite("Sandbox").UnderAliasPath("/home");

FluentCacheKey.ForPagesNodeOrder().All();

Creating cache keys for CMS objects / custom module classes

FluentCacheKey.ForObject().OfClassName(UserInfo.OBJECT_TYPE).WithName("administrator");

FluentCacheKey.ForObject().OfClassName(UserInfo.OBJECT_TYPE).WithGuid(new Guid("9fb0c012-5d9b-4eb6-b5cd-0bb0daffaca0"));

FluentCacheKey.ForObject().OfClassName(UserInfo.OBJECT_TYPE).WithId(2);

FluentCacheKey.ForObjects().OfClassName(UserInfo.OBJECT_TYPE).All();

Creating cache keys for attachments

FluentCacheKey.ForAttachment().WithGuid(new Guid("9fb0c012-5d9b-4eb6-b5cd-0bb0daffaca0"));

FluentCacheKey.ForAttachments().OfDocumentId(4);

FluentCacheKey.ForAttachments().All();

Creating cache keys for media files

FluentCacheKey.ForMediaFile().WithGuid(new Guid("9fb0c012-5d9b-4eb6-b5cd-0bb0daffaca0"));

FluentCacheKey.ForMediaFile().PreviewWithGuid(new Guid("9fb0c012-5d9b-4eb6-b5cd-0bb0daffaca0"));

Creating cache keys for custom tables

FluentCacheKey.ForCustomTable().OfClassName("MyCustomTable").All();

FluentCacheKey.ForCustomTable().OfClassName("MyCustomTable").WithRecordId(5);

Creating cache keys for settings

FluentCacheKey.ForSetting().WithCodeName("settingKeyName");

FluentCacheKey.ForSetting().OfSiteId(1).WithCodeName("settingKeyName");

Contributions

If you discover a problem, please open an issue.

If you would like contribute to the code or documentation, please open a pull request.

References

Kentico Documentation

Setting cache dependencies for cache dependency key examples.
Caching in custom code for examples of how to use these keys.

Blog Posts

Kentico 12: Design Patterns Part 12 - Database Query Caching Patterns for best practices for caching in your application.

Product	Compatible and additional computed target framework versions.
.NET	net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed.
.NET Core	netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed.
.NET Standard	netstandard2.0 is compatible. netstandard2.1 was computed.
.NET Framework	net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed.
MonoAndroid	monoandroid was computed.
MonoMac	monomac was computed.
MonoTouch	monotouch was computed.
Tizen	tizen40 was computed. tizen60 was computed.
Xamarin.iOS	xamarinios was computed.
Xamarin.Mac	xamarinmac was computed.
Xamarin.TVOS	xamarintvos was computed.
Xamarin.WatchOS	xamarinwatchos was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

.NETStandard 2.0
- No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last updated
2.3.0	17,061	1/19/2023
2.3.0-prerelease-2-1	143	1/19/2023
2.2.0	1,057	12/2/2022
2.2.0-prerelease-1-1	159	12/2/2022
2.1.0	16,924	8/27/2020
2.0.0	7,758	9/2/2019
1.0.0	510	8/30/2019

https://github.com/wiredviews/kentico-fluent-cache-keys/releases