Remove Existing Data Structure from Cache

Note

This feature is only available in NCache Enterprise Edition.

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

Prerequisites

Install the following NuGet package in your application:
- Enterprise: Alachisoft.NCache.SDK
Include the following namespaces in your application:
Cache must be running.
The application must be connected to cache before performing the operation.
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 dependency in your pom.xml file:

<dependency>
    <groupId>com.alachisoft.ncache</groupId>
    <artifactId>ncache-client</artifactId>
    <version>x.x.x</version>
</dependency>

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

Install and include the following module in your application:
- Enterprise: const ncache = require('ncache-client')
Cache must be running.
The application must be connected to cache before performing the operation.
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.

Install the NCache Python client by executing the following command:

# Enterprise Client
pip install ncache-client

Import the NCache module in your application.
Cache must be running.
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-scala-client</artifactId>
    <version>x.x.x</version>
</dependency>

Import the following packages in your application:
- import com.alachisoft.ncache.scala.client.*;
- import com.alachisoft.ncache.scala.client.datastructures*;
The caches being connected must be configured and running.
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.

Remove Data Structures from Cache

Tip

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

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

The following example assumes the key exists against a data structure in the cache. The data structure is then removed from the cache using this key.

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
}

try:
    # Pre-condition: Cache is connected
    # Key exists in cache
    key = "ProductIDList"

    # Remove List from Cache
    cache.get_data_structures_manager().remove(key)
except Exception as exp:
    # Handle errors

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

    // Remove List from Cache
    cache.getDataStructuresManager.remove(key)
}
catch {
    case exception: Exception => {
      // Handle any errors
    }
}

Note

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

Additional Resources

NCache provides a sample application for removing data structures from cache on GitHub.

Remove Existing Data Structure from Cache

Note

Prerequisites

Remove Data Structures from Cache

Tip

Note

Additional Resources

See Also