Remove Cache Data with Groups [Deprecated]
NCache allows the user to remove the items with the cache groups. It also allows the user to remove the data group with CacheItem.
To remove cache items from cache that belong to a specific group, the RemoveGroupData method can be used. This method removes all the cache items mapped under the group passed to this API present in the cache.
Prerequisites
- Create a new Console Application.
- Install either of the following NuGet packages in your .NET client application:
- Enterprise:
Install-Package Alachisoft.NCache.SDK -Version 4.9.1.0
- Professional:
Install-Package Alachisoft.NCache.Professional.SDK -Version 4.9.1.0
- Create a new Console Application.
- Make sure that the data being added is serializable.
- Add NCache References by locating
%NCHOME%\NCache\bin\assembly\4.0 and adding Alachisoft.NCache.Web and Alachisoft.NCache.Runtime as appropriate.
- Include the
Alachisoft.NCache.Web.Caching namespace in your application.
- To learn more about the NCache Legacy API, please download the NCache 4.9 documents available as a .zip file on the Alachisoft Website.
Important
- Passing empty strings for the group will return an empty result set.
- Passing null for the group will throw an
ArgumentNullException.
- Passing only the value of the group will remove all the cache items mapped under the group.
The following example removes the data under the group West Coast Customers.
// Precondition: Cache is already connected
// A user wants to remove a customer from West Coast Region
// Items are previously added in the cache with the group 'West Coast Customers'
string groupName = "West Coast Customers";
// Cache items belonging to the group are removed from the cache
cache.SearchService.RemoveGroupData(groupName);
Console.WriteLine($"Data of group '{groupName}' has been removed successfully.");
// Precondition: Cache is already connected
// A user wants to remove a customer from West Coast Region
// Items are previously added in the cache with the group 'West Coast Customers'
String groupName = "West Coast Customers";
// Cache items belonging to the group are removed from the cache
cache.getSearchService().removeGroupData(groupName);
System.out.println("Data of group '" + groupName + "' has been removed successfully.");
# Precondition: Cache is already connected
# Items are previously added in the cache with group 'ImportantCustomers'
group_name = "ImportantCustomers"
# Cache items belonging to the group are removed from the cache
search_service = cache.get_search_service()
retrieved_keys = search_service.remove_group_data(group_name)
// Precondition: Cache is already connected
// Items are previously added in the cache with group 'ImportantCustomers'
var groupName = "ImportantCustomers";
// Cache items belonging to the group are removed from the cache
var searchService = await this.cache.getSearchService();
var retrievedKeys = await searchService.removeGroupData(groupName);
// Using NCache Enterprise 4.9.1
// Precondition: Cache is already connected
// Items are previously added in the cache with the group 'West Coast Customers' and subgroup 'Retail'
string groupName = "West Coast Customers";
string subGroupName = "Retail";
// Cache items belonging to the group are removed from the cache
cache.RemoveGroupData(groupName, subGroupName);
Console.WriteLine($"Data of group '{groupName}' and subgroup '{subGroupName}' has been removed successfully.");
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 Groups on GitHub.
See Also
.NET: Alachisoft.NCache.Client namespace.
Java: com.alachisoft.ncache.client namespace.
Python: ncache.client class.
Node.js: Cache class.
