How can I remove a particular Named Tag from a cache item in NCache?

To remove a particular Named Tag, retrieve the CacheItem from the cache, invoke the remove() method on the NamedTags dictionary using the tag's key, and then re-insert the item into the cache.

What happens if I set NamedTags to null in a CacheItem?

Setting the NamedTags property of a CacheItem to null results in the removal of all associated searchable metadata tags for that item when it is re-inserted into the cache.

Remove Data with Named Tags

The items added with Named Tags to the cache can also be removed from the cache using the same Named Tags. Additionally, like updating Named Tags, they can also be removed via CacheItem. This is a custom class provided by NCache which can be used to add data to the cache. To remove Named Tag via CacheItem, the Named Tag property of the CacheItem is set as null.

Prerequisites

To learn about the standard prerequisites required to work with all NCache client-side features, please refer to the given page on Client-Side API Prerequisites.
For API details, refer to: ICache, CacheItem, NamedTags, GetCacheItem, Insert, Remove.

The following example removes the Named Tags via CacheItem:

// Precondition: Cache is already connected

// A user wants to end the VIP membership discount offer
// So this Named Tag needs to be removed.

string customerKey = "Customer:ALFKI";

// Retrieve the CacheItem using the key
CacheItem cacheItem = cache.GetCacheItem(customerKey);

// Remove tag from dictionary
cacheItem.NamedTags.Remove("VIP_Membership_Discount");

// Reinsert the cacheItem in the cache with Named Tags removed
cache.Insert(customerKey, cacheItem);

// Precondition: Cache is already connected

// A user wants to end the VIP membership discount offer
// So this Named Tag needs to be removed.

String customerKey = "Customer:ALFKI";

// Retrieve the CacheItem using the key
CacheItem cacheItem = cache.getCacheItem(customerKey);

// Remove tag from dictionary
cacheItem.getNamedTags().remove("VIP_Membership_Discount");

// Reinsert the cacheItem in the cache with Named Tags removed
cache.insert(customerKey, cacheItem);

# Precondition: Cache is already connected

# A user wants to end the VIP membership discount offer
# So this Named Tag needs to be removed.

customer_key = "Customer:ALFKI"

# Retrieve the CacheItem using the key
cache_item = cache.get_cacheitem(customer_key)

# Set the Named Tags property of the cacheItem as null
cache_item.set_named_tags(None)

# Re-insert the cacheItem in the cache with Named Tags removed
cache.insert(customer_key, cache_item)

// This is an async method
// Precondition: Cache is already connected

// A user wants to end the VIP membership discount offer
// So this Named Tag needs to be removed.

var customerKey = "Customer:ALFKI";

// Retrieve the CacheItem using the key
var cacheItem = await this.cache.getCacheItem(customerKey);

// Set the Named Tags property of the cacheItem as null
cacheItem.setNamedTags(null);

// Reinsert the cacheItem in the cache with Named Tags removed
await this.cache.insert(customerKey, cacheItem);

Note

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

Note

The cacheItem.NamedTags.Remove(tagName) method will remove the Named Tag associated with the tagName. If all Named Tags are removed from the Named Tags dictionary, it becomes empty. When the cache item is inserted into the cache with this empty dictionary, it will not retain any Named Tags.

Additional Resources

NCache provides a sample application for NamedTags on GitHub.

Remove Data with Named Tags

Prerequisites

Note

Note

Additional Resources

See also

Contact Us