Configure Invalidation Attributes for Data Structures in Cache

Note

This feature is only available in NCache Enterprise Edition.

Data Structures can be invalidated from the cache using:

These attributes are specified during data structure creation using the DataTypeAttributes class and can not be modified once a data structure is created in the cache. Moreover, these invalidation attributes can be specified against all data structures.

Note

Key dependencies can be configured between CacheItem and Data Structures as well.

Prerequisites

Install the following NuGet package in your application:
- Enterprise: Alachisoft.NCache.SDK
Include the following namespaces in your application:
The cache must be running.
The application must be connected to cache before performing the operation.
For API details, refer to: ICache, DataTypeAttributes.
Make sure that the data being added is serializable.
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.dependencies.*;
- import com.alachisoft.ncache.runtime.exceptions.*;
The cache must be running.
The application must be connected to cache before performing the operation.
For API details, refer to: Cache, DataStructureAttributes.
Make sure that the data being added is serializable.
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')
The cache must be running.
The application must be connected to cache before performing the operation.
For API details, refer to: Cache, DataStructureAttributes.
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.
The cache must be running.
For API details refer to: Cache, DataStructureAttributes.
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 cache must be running.
For API details refer to: Cache, DataStructureAttributes
The application must be connected to cache before performing the operation.
Make sure that the data being added is serializable.
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.

Use Invalidation Attributes with Data Structures

The following code sample creates a set OrderIDSet which is dependent on a Product object in the cache. OrderList is assigned an expiration value of 15 minutes and its priority is set to high. If the Product is modified in the cache, OrderIDSet is removed from the cache.

try
{
    // Pre-conditions: Cache must be connected

    // Product exists in cache with key "Product:1001"
    string productKey = "Product:1001";

    // Specify attributes for HashSet
    var attributes = new DataTypeAttributes();

    // Specifiy priority for eviciton
    attributes.Priority = CacheItemPriority.High;

    // Specify Absolute expiration of 15 minutes
    var expiration = new Expiration(ExpirationType.Absolute, TimeSpan.FromMinutes(15));
    attributes.Expiration = expiration;

    // Specify key dependency of orderKey on customerKey
    var keyDependency = new KeyDependency(productKey);
    attributes.Dependency = keyDependency;

    // Create HashSet which is dependent on product:1001
    // Specify unique cache key for set
    string orderKey = "OrderIDSet";
    IDistributedHashSet<int> orderIDSet = cache.DataTypeManager.CreateHashSet<int>(orderKey, attributes);

    // Check if the orderIDSet exists in cache:
    // After 15 minutes or
    // If product is modified in cache
}
catch (OperationFailedException ex)
{
    // NCache specific exception
    if(ex.ErrorCode == NCacheErrorCodes.KEY_ALREADY_EXISTS)
    {
        // An item with the same key already exists
    }
    else if (ex.ErrorCode == NCacheErrorCodes.CACHEITEM_IN_DATA_STRUCTURES)
    {
        // Data structures cannot be of CacheItem type
        // CacheItems cannot be added in data structures
    }
    else
    {
        // NCache specific exception
        // Exception can occur due to:
        // Connection Failures
        // Operation Timeout
        // Operation performed during state transfer
    }
}
catch (Exception ex)
{
    // Any generic exception like ArgumentNullException or ArgumentException
}

try {
    // Pre-conditions: Cache must be connected

    // Product exists in cache with key "Product:1001"
    String productKey = "Product:1001";

    // Specify attributes for HashSet
    var attributes = new DataStructureAttributes();

    // Specifiy priority for eviciton
    attributes.setPriority(CacheItemPriority.High);

    // Specify Absolute expiration of 15 minutes
    var expiration = new Expiration(ExpirationType.Absolute, TimeSpan.FromMinutes(15));
    attributes.setExpiration(expiration);

    // Specify key dependency of orderKey on customerKey
    var keyDependency = new KeyDependency(productKey);
    attributes.setDependency(keyDependency);

    // Create HashSet which is dependent on product:1001
    // Specify unique cache key for set
    String orderKey = "OrderIDSet";
    var writeThruOptions = null;

    // Create HashSet
    DistributedHashSet orderIDSet = InitializeCache.cache.getDataStructuresManager().createHashSet(orderKey, attributes, writeThruOptions, Integer.class);

    // Check if the orderIDSet exists in cache:
    // After 15 minutes or
    // If product is modified in cache    
} catch (OperationFailedException ex) {
    // NCache specific exception
    if (ex.getErrorCode() == NCacheErrorCodes.KEY_ALREADY_EXISTS) {
        // An item with the same key already exists
    } else if (ex.getErrorCode() == NCacheErrorCodes.CACHEITEM_IN_DATA_STRUCTURES) {
        // Data structures cannot be of CacheItem type
        // CacheItems cannot be added in data structures
    } else {
        // 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-conditions: Cache must be connected

  // Product exists in cache with key "Product:1001"
  var productKey = "Product:1001";

  // Specify attributes for list
  var attributes = new ncache.DataStructureAttributes();

  // Specifiy priority for eviciton
  attributes.setPriority(ncache.CacheItemPriority.High);

  // Specify Absolute expiration of 15 minutes
  var expiration = new ncache.Expiration(
    ncache.ExpirationType.Absolute,
    ncache.TimeSpan.FromMinutes(15)
  );
  attributes.setExpiration(expiration);

  // Specify key dependency of orderKey on customerKey
  var keyDependency = new ncache.KeyDependency(productKey);
  attributes.setDependency(keyDependency);

  // Create list which is dependent on product:1001
  // Specify unique cache key for list
  var orderKey = "OrderIDSet";
  var orderIDList = await (
    await this.cache.getDataStructuresManager()
  ).createList(orderKey, Number(), attributes, null);

  // Check if the orderIDSet exists in cache:
  // After 15 minutes or
  // If product is modified in cache
} catch (error) {
  // Handle errors
}

try:
    # Pre-conditions: Cache must be connected
    # Product exists in cache with key "Product:1001"
    product_key = "Product:1001"

    # Specify attributes for list
    attributes = DataStructureAttributes()

    # Specify priority for eviction
    attributes.set_priority(ncache.CacheItemPriority.HIGH)

    # Specify Absolute expiration of 15 minutes
    expiration = ncache.Expiration(ncache.ExpirationType.ABSOLUTE, ncache.TimeSpan.from_minutes(15))
    attributes.set_expiration(expiration)

    # Specify key dependency of orderKey on customerKey
    key_dependency = ncache.KeyDependency(product_key)
    attributes.set_dependency(key_dependency)

    # Create list which is dependent on product:1001
    # Specify unique cache key for list
    order_key = "OrderIDSet"

    order_id_list = cache.get_data_structures_manager().create_list(order_key, int, attributes)

    # Check if the orderIDSet exists in cache:
    # After 15 minutes or
    # If product is modified in cache
except Exception as exp:
    # Handle errors

try {
    // Pre-conditions: Cache must be connected
    // Product exists in cache with key "Product:1001"
    val productKey = "Product:1001"

    // Specify attributes for hashset
    val attributes = new DataStructureAttributes

    // Specify priority for eviction
    attributes.setPriority(CacheItemPriority.High)

    // Specify Absolute expiration of 15 minutes
    val expiration = Expiration(ExpirationType.Absolute, TimeSpan.FromMinutes(15))
    attributes.setExpiration(expiration)

    // Specify key dependency of orderKey on customerKey
    val keyDependency = new KeyDependency(productKey)
    attributes.setDependency(keyDependency)

    // Create hashset which is dependent on product:1001
    // Specify unique cache key for set
    val orderKey = "OrderIDSet"

    val writeThruOptions = null

    val orderIDSet = cache.getDataStructuresManager.createHashSet(orderKey, attributes, writeThruOptions, classOf[Integer])

    // Check if the orderIDSet exists in cache:
    // After 15 minutes or
    // If product is modified in cache
}
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 configuring invalidation attributes with data structures on GitHub.

Configure Invalidation Attributes for Data Structures in Cache

Note

Note

Prerequisites

Use Invalidation Attributes with Data Structures

Note

Additional Resources

See Also