Please note that version 9 is still in beta. For documentation on the latest stable release, please change to version 8.
Contribute to Docs Contribute to Docs

Caching

For production scenarios we recommend a cache level of at least Basic to acheive maximum performance. This cache level will hold all meta-data in cache and avoid unneccesary roundtrips to the database.

All of the core services have built in support for caching. If enabled, all models are stored in cache after model transformation and invalidated from cache when the model is updated or deleted. The models are stored both as their CLR type and as a lighter info object (PageInfo, PostInfo) that can be used for listings. Please note that dynamic models are not cached and is therefor not suited for usage in high performance scenarios.

How To Enable Cache

To enable the repository cache, simply register a cache service that implements Piranha.ICache in your Startup.cs. The following cache enables the standard memory cache:

using Piranha;

public void ConfigureServices(IServiceCollection services)
{
    ...

    services.AddPiranhaMemoryCache();

    ...
}

This will cause the cache to be injected to all services when they are created. Most cache services should be registered as Singletons as it is desirable that all instances reference the same cache object.

Setting The Cache Level

By default Piranha caches everything when a Cache Service is registered, but you can configure the cache level by setting the property Piranha.App.CacheLevel. You can choose between the following levels:

CacheLevel.None
Piranha.App.CacheLevel = Piranha.Caching.CacheLevel.None;

Nothing is cached even if a cache service is registered.

CacheLevel.Minimal
Piranha.App.CacheLevel = Piranha.Caching.CacheLevel.Minimal;

The following data is kept in cache:

  • Sites
  • Params
CacheLevel.Basic
Piranha.App.CacheLevel = Piranha.Caching.CacheLevel.Basic;

The following data is kept in cache:

  • Sites
  • Params
  • PageTypes
  • PostTypes
CacheLevel.Full
Piranha.App.CacheLevel = Piranha.Caching.CacheLevel.Full;

Everything is kept in cache, including all Blocks and Fields for Content Types. This is the default cache level.