Clear Cache Data

NCache allows clients to empty the cache in one call completely, without relying on data invalidation strategies like expiration and eviction. Emptying the cache results in the cache going into a "fresh" state, as all keys and associated items and metadata are removed from the cache. In case of client cache configured, NCache provides separate methods to clear the client cache, irrespective of the remote cache.

Prerequisites

Install either of the following NuGet packages in your application based on your NCahce edition:
- Enterprise: Alachisoft.NCache.SDK
- Professional: Alachisoft.NCache.Professional.SDK
Include the following namespaces in your application:
- Alachisoft.NCache.Client
- Alachisoft.NCache.Runtime.Exceptions
Cache must be running.
The application must be connected to cache before performing the operation.
For API details refer to: ICache, Clear(), ClearClientCache()
To ensure the operation is fail safe, it is recommended to handle any potential exceptions within your application, as explained in Handling Failures.
To handle any unseen exceptions, refer to the Troubleshooting section.

Add the following Maven dependencies in your pom.xml file:

<dependency>
    <groupId>com.alachisoft.ncache</groupId>
    <!--for NCache Enterprise Edition--> 
    <artifactId>ncache-client</artifactId>
    <!--for NCache Professional Edition-->
    <artifactId>ncache-professional-client</artifactId>
    <version>x.x.x</version>
</dependency>

Import the following packages in your application:
- import com.alachisoft.ncache.client.*;
- import com.alachisoft.ncache.runtime.exceptions.*;
Cache must be running.
The application must be connected to cache before performing the operation.
Make sure that the data being added is serializable.
For API details refer to: Cache, clear(), clearClientCache()
To ensure the operation is fail safe, it is recommended to handle any potential exceptions within your application, as explained in Handling Failures.
To handle any unseen exceptions, refer to the Troubleshooting section.

Install and include either of the following modules in your application based on your NCache edition:
- Enterprise: const ncache = require('ncache-client')
- Professional: const ncache = require('ncache-professional-client')
Cache must be running.
The application must be connected to cache before performing the operation.
For API details refer to: Cache, clear(), clearClientCache()
To ensure the operation is fail safe, it is recommended to handle any potential exceptions within your application, as explained in Handling Failures.
To handle any unseen exceptions, refer to the Troubleshooting section.

Remote Cache

The following example initializes a remote cache myPartitionedCache, performs some operations and uses the Clear() method to empty the cache synchronously. For Java, use the clear() method to clear the cache contents.

try
{
    ICache cache = CacheManager.GetCache("myPartitionedCache");

    // clear the cache
    cache.Clear();
}
catch (Exception e) 
{
    // Any generic exception like ArgumentNullException or ArgumentException
}

try 
{
    Cache cache = CacheManager.getCache("myPartitionedCache");

    // clear the cache
    cache.clear();
}
catch (Exception e) 
{
  // Any generic exception like NullPointerException or IllegalArgumentException
}

try
{
    var mycache = await ncache.CacheManager.getCache("myPartitionedCache");

    // clear the cache
    this.cache.clear();

}
catch (error) 
{
    // Handle errors
}

Client Cache

A client cache is a local cache synchronized with the remote clustered cache. All operations on the remote cache are synchronized with the client cache. However, you can independently clear the client cache, which will then synchronize itself with the current state of the remote cache.

The following example initializes an existing client cache myClientCache, performs some operations and uses the ClearClientCache() method to empty the client cache synchronously. For Java, NCache provides the clearClientCache() method for this purpose.

try
{
    ICache cache = CacheManager.GetCache("myClientCache");

    // clear the client cache
    cache.ClearClientCache();
}
catch (Exception e) 
{
    // Any generic exception like ArgumentNullException or ArgumentException
}

try 
{
    Cache cache = CacheManager.getCache("myClientCache");

    // clear the client cache
    cache.clearClientCache();

}
catch (Exception e) 
{
  // Any generic exception like NullPointerException or IllegalArgumentException
}

try
{
    var mycache = await ncache.CacheManager.getCache("myClientCache");

    // clear the client cache
    this.cache.clearClientCache();

}
catch (error) 
{
   // Handle errors
}

Additional Resources

NCache provides sample application for Basic Operations on GitHub.

Clear Cache Data

Prerequisites

Remote Cache

Client Cache

Additional Resources

See Also