Remove Existing Data Structure from Cache

Note

This feature is only available in NCache Enterprise Edition.

An existing datatype can be removed from cache using the Remove method of DataTypeManager or through cache.Remove() method as well. If the key does not exist, nothing is returned.

Pre-requisites

Install the following NuGet packages:
- Alachisoft.NCache.SDK.
Include the following namespaces in your application:
- Alachisoft.NCache.Client.DataTypes
- Alachisoft.NCache.Client
- Alachisoft.NCache.Runtime.Exceptions
The application must be connected to cache before performing the operation.
Cache must be running.
For API details, refer to: ICache, Contains, Count, DataTypeManager, Remove, cache.Remove.
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>
    <artifactId>ncache-client</artifactId>
    <version>5.2.0</version>
</dependency>

Import the following packages in your application:
- import com.alachisoft.ncache.client.*;
- import com.alachisoft.ncache.runtime.exceptions.*;
- import com.alachisoft.ncache.client.*;
- import com.alachisoft.ncache.client.datastructures.*;
The application must be connected to cache before performing the operation.
Cache must be running.
For API details, refer to: Cache, contains, getCount, DataStructureManager, remove, cache.remove.
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.

Include the following modules in your application.
- const ncache = require('ncache-client')
The application must be connected to cache before performing the operation.
Cache must be running.
For API details, refer to: Cache, contains, getCount, DataStructureManager, remove, cache.remove.
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.

Tip

One quick way to verify whether datatype has been removed is to use either properties of the Cache class:

Contains verifies if the specified key of the hashset exists in the cache.
Count returns the number of items present in the cache.

The following example assumes the key exists against a data type in cache.

try
{
    // Pre-condition: Cache is connected
    // Key exists in cache
    string key = "ProductIDList";

    // Remove List from Cache
    cache.DataTypeManager.Remove(key);
}
catch (OperationFailedException ex)
{
    // NCache specific exception
    // Exception can occur due to:
    // Connection Failures
    // Operation Timeout
    // Operation performed during state transfer
}
catch (Exception ex)
{
    // Any generic exception like ArgumentException or ArgumentNullException
}

try
{
    // Pre-condition: Cache is connected
    // Key exists in cache
    String key = "ProductIDList";

    // Remove List from Cache
    cache.getDataStructuresManager().remove(key);
}
catch (OperationFailedException ex)
{
    // NCache specific exception
    // Exception can occur due to:
    // Connection Failures
    // Operation Timeout
    // Operation performed during state transfer
}
catch (Exception ex)
{
    // Any generic exception like IllegalArgumentException or NullPointerException

}

// This is an async method
try
{
    // Pre-condition: Cache is connected
    // Key exists in cache
    var key = "ProductIDList";

    // Remove List from Cache
    await this.cache.getDataStructuresManager().remove(key);
}
catch (error)
{
   // Handle errors
}

Recommendation: To ensure the operation is fail safe, it is recommended to handle any potential exceptions within your application, as explained in Handling Failures.

Remove Existing Data Structure from Cache

Note

Pre-requisites

Tip

See Also