https://github.com/wiredviews/kentico-fluent-cache-keys
Utility library for generating consistent cache dependency keys for Kentico CMS applications
https://github.com/wiredviews/kentico-fluent-cache-keys
kentico-cms-applications kentico-ems
Last synced: 2 months ago
JSON representation
Utility library for generating consistent cache dependency keys for Kentico CMS applications
- Host: GitHub
- URL: https://github.com/wiredviews/kentico-fluent-cache-keys
- Owner: wiredviews
- License: mit
- Created: 2019-08-30T03:29:00.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-03T22:17:30.000Z (about 1 year ago)
- Last Synced: 2025-07-02T23:41:13.999Z (4 months ago)
- Topics: kentico-cms-applications, kentico-ems
- Language: C#
- Size: 67.4 KB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Kentico Fluent Cache Keys
Utility library for generating consistent cache dependency keys for Kentico Xperience applications
[](https://github.com/wiredviews/kentico-fluent-cache-keys/actions/workflows/ci.yml)
[](https://github.com/wiredviews/kentico-fluent-cache-keys/actions/workflows/publish.yml)
## Packages
[](https://www.nuget.org/packages/WiredViews.Kentico.FluentCacheKeys)
## How to Use?
1. Install the `WiredViews.Kentico.FluentCacheKeys` [NuGet](https://www.nuget.org/packages/WiredViews.Kentico.FluentCacheKeys/) package in your project:
```bash
dotnet add package WiredViews.Kentico.FluentCacheKeys
```
## Examples
### Creating cache keys for pages / documents / nodes
```csharp
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
```csharp
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
```csharp
FluentCacheKey.ForAttachment().WithGuid(new Guid("9fb0c012-5d9b-4eb6-b5cd-0bb0daffaca0"));
FluentCacheKey.ForAttachments().OfDocumentId(4);
FluentCacheKey.ForAttachments().All();
```
### Creating cache keys for media files
```csharp
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
```csharp
FluentCacheKey.ForCustomTable().OfClassName("MyCustomTable").All();
FluentCacheKey.ForCustomTable().OfClassName("MyCustomTable").WithRecordId(5);
```
### Creating cache keys for settings
```csharp
FluentCacheKey.ForSetting().WithCodeName("settingKeyName");
FluentCacheKey.ForSetting().OfSiteId(1).WithCodeName("settingKeyName");
```
## Contributions
If you discover a problem, please [open an issue](https://github.com/wiredviews/kentico-fluent-cache-keys/issues/new).
If you would like contribute to the code or documentation, please [open a pull request](https://github.com/wiredviews/kentico-fluent-cache-keys/compare).
## References
### Kentico Documentation
- [Setting cache dependencies](https://docs.kentico.com/k12sp/configuring-kentico/configuring-caching/setting-cache-dependencies) for cache dependency key examples.
- [Caching in custom code](https://docs.kentico.com/k12sp/configuring-kentico/configuring-caching/caching-in-custom-code) for examples of how to use these keys.
### Blog Posts
- [Kentico 12: Design Patterns Part 12 - Database Query Caching Patterns](https://dev.to/seangwright/kentico-12-design-patterns-part-12-database-query-caching-patterns-43hc) for best practices for caching in your application.