Create Regular Client Cache

A Regular Client Cache is an L1 cache that resides on the client and keeps frequently accessed data close to the application, reducing network trips to the clustered cache (L2). The Client Cache configuration is maintained with the clustered cache, and connecting client applications use the configured Client Cache.

You can create a Client Cache using the NCache Management Center or the appropriate PowerShell cmdlets. The Client Cache uses Optimistic synchronization and can run as InProc or OutProc. If you are using NuGet packages without an NCache client installation, refer to Create Client Cache with NuGet Package Installation.

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:9801 or <server-ip>:9801.

  • 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.

  • The New Client Cache page opens. The Client Cache name is automatically derived from the clustered cache name and cannot be modified. For example, the Client Cache for defaultCache is named defaultCache_cc.

  • Select Regular as the Client Cache type and configure the following settings:

    • Maximum Size: Specifies the maximum size of the Client Cache in MB.

    • Isolation Level: Select InProc or OutProc. An InProc Client Cache runs within the application process, whereas an OutProc Client Cache runs in a separate host process.

    • Enable Eviction: Specifies whether items can be evicted when the Client Cache reaches its maximum size. The eviction policy, eviction percentage, and default priority are inherited from the clustered cache.

Note

An OutProc Client Cache requires NCache Client to be installed on the client node.

Regular Client Cache configuration screen showing the automatically derived cache name, Regular cache type, maximum size, isolation level, and eviction setting.

  • Click Finish to create the Regular Client Cache.
Note

Creating a Client Cache does not initialize it in application processes that are already connected without Client Cache. Restart those application processes to use the newly configured Client Cache.

Once created, the Client Cache tab displays the configuration of the Regular Client Cache. You can configure its supported settings from this page.

Using PowerShell

You can also configure a Regular Client Cache using the New-ClientCache PowerShell cmdlet.

Note

If the Type parameter is not specified, a Regular Client Cache is configured by default.

  • The following command configures a Regular Client Cache for defaultCache on server 20.200.20.11. The Client Cache name is automatically derived from the clustered cache name.
New-ClientCache -CacheName defaultCache -Server 20.200.20.11 `
                -Type Regular
  • The following command configures a Regular Client Cache with a maximum size of 1024 MB.
New-ClientCache -CacheName defaultCache -Server 20.200.20.11 `
                -Type Regular -Size 1024
  • The following command configures an InProc Regular Client Cache with a maximum size of 1024 MB. If -InProc is not specified, the Client Cache is configured as OutProc by default.
New-ClientCache -CacheName defaultCache -Server 20.200.20.11 `
                -Type Regular -Size 1024 -InProc
  • The following command configures a Regular Client Cache for defaultCache on server 20.200.20.11 having size 1024 MB for simple case using security credentials.
New-ClientCache -CacheName defaultCache -Server 20.200.20.11 `
                -Type Regular -Size 1024 `
                -Credentials(Get-Credential john_smith)
  • This command configures a Regular Client Cache for defaultCache on server 20.200.20.11 using a client PEM certificate and password for mutual TLS (mTLS) authentication.
New-ClientCache -CacheName defaultCache -Server 20.200.20.11 `
                -Size 1024 -TlsCertPath "C:\certs\client.pem" `
                -TlsCertPassword "clientKeyPassword"

See Also

Client Cache Architecture
Full-Data Client Cache
Caching Topologies