What is the difference between Regular and Full-Data Client Cache?

A Regular Client Cache (L1) works on a cache-aside basis, loading data from the remote cluster (L2) only on-demand. A Full-Data Client Cache maintains a background-synchronized local copy of specific data types, enabling near-instant local reads and SQL queries without crossing the network to the L2 cluster.

When should I use InProc vs OutProc for a Client Cache?

Use InProc (In-process) for maximum performance in single-application scenarios; it resides in the application heap with zero serialization overhead. Use OutProc (Out-of-process) when you need to share the local cache across multiple application instances on the same node or to ensure cache survival during application recycles.

Why must the cache be stopped to create a Full-Data Client Cache?

The clustered cache must be stopped during Full-Data configuration to ensure a consistent point-in-time snapshot for synchronization and to prevent runtime 'Assembly Not Found' errors during the initial background pre-fetching of reference data types.

Create Regular Client Cache

This cache exists on the client node (L1) in close proximity to your application, delivering low latency by minimizing or eliminating network trips to the clustered cache (L2). You can create a Client Cache by using the NCache Management Center or the appropriate PowerShell cmdlets. The Client Cache is created using the Optimistic synchronization mode. Depending on your requirements, you can run it in InProc or OutProc mode. If you are using NuGet packages without any NCache client installation, refer to Create Client Cache with NuGet Package Installation.

Important

Ensure that you have an existing client node to create a Client Cache. To add a client node, please refer to the Add Client Node section.

Warning

You cannot create a Client Cache on a Pub/Sub Messaging store.

Using the NCache Management Center

Launch the NCache Management Center by browsing to http://localhost:8251 or <server-ip>:8251.
In the left navigation bar, click on Clustered Caches. Against the Cache Name, click on View Details.

NCache Management Center showing the Clustered Caches list with the "View Details" option highlighted for a selected cache.

This opens the detailed configuration page for the cache.
In the Client Cache tab, click on the New button.

Client Cache tab in the cache details page with the "New" button selected to create a new Client Cache.

At this point, the New Client Cache page opens.
Specify the Client Cache name and click Next.

New Client Cache wizard screen prompting for Client Cache name and synchronization mode.

Next, you can either create a Regular or a Full-Data Client Cache.
To create a Regular Client Cache, specify the type as Regular, choose the Maximum Size and Isolation Level for the Client Cache. The InProc cache lives inside the application process, whereas the OutProc cache lives in a separate service process. Click Next.

Regular Client Cache configuration screen showing options for cache type, maximum size, and isolation level (InProc or OutProc).

In the Advanced Options dialog box, you can configure the following:
- You can change the Eviction Policy and Eviction Percentage; items will be evicted from the cache using the selected policy and percentage value, if eviction is enabled.
- You can change the Clean Interval value. Its default value is 15 sec.
- You can make the cache start automatically after a service restart by selecting the checkbox "Auto start this cache on service startup".

Advanced options dialog for Regular Client Cache showing eviction policy, eviction percentage, clean interval, and auto-start setting.

Click Finish.

Once completed, a Regular Client Cache will be created. This will prompt a success notification and the Client Cache tab will now show options to configure Client Cache settings.

Using PowerShell

You can also create the Client Cache using the PowerShell cmdlets. The following are the PowerShell cmdlets to create the Regular Client Cache respectively.

The New-ClientCache tool enables the user to create a new Client Cache.

This command creates a Regular Client Cache named democlientCache on client node 20.200.20.12 for an already registered clustered cache on server 20.200.20.11.

Note

If the Type parameter is not specified, a Regular Client Cache will be created by default.

New-ClientCache -CacheName demoCache -ClientCacheName democlientCache \
                -Type Regular -Server 20.200.20.11 \
                -ClientNode 20.200.20.12

This command also creates a Regular Client Cache named demoClientCache on the 20.200.20.12 client node for an already registered clustered cache on the 20.200.20.11 server. However, the Path parameter specifies the path at which the existing exported cache configuration file is placed.

New-ClientCache -CacheName demoCache -ClientCacheName demoClientCache \
                -Type Regular -Server 20.200.20.11 \
                -ClientNode 20.200.20.12 -Path C:\config.xml

This command creates a Regular Client Cache named demoClientCache on client node 20.200.20.12 for an already registered clustered cache on server 20.200.20.11 having size 1024 MB for simple case using security credentials.

New-ClientCache -CacheName demoCache -ClientCacheName demoClientCache \
                -Server 20.200.20.11 -Size 1024 \
                -ClientNode 20.200.20.12 -Credentials (Get-Credential john_smith)