• Products
  • Solutions
  • Customers
  • Resources
  • Company
  • Pricing
  • Download
Try Playground
  • Client Side API Programming
  • Named Tags
  • Add/Update Data with Named Tags
Show / Hide Table of Contents
  • Programmer's Guide
  • Setting Up Development Environment
    • .NET
      • Client API Prerequisites
      • Server-side API Prerequisites
    • Java
      • Client API Prerequisites
      • Server-side API Prerequisites
    • Python
      • Client API Prerequisites
    • Node.js
      • Client API Prerequisites
  • Client Side API Programming
    • Error Handling
    • Troubleshooting
    • Cache Keys and Data
    • How to Connect to Cache
    • Basic Operations - An Overview
      • Add Data
      • Update/Insert Data
      • Retrieve Data
      • Remove Data
    • Groups
      • Overview
      • Add/Update Data with Groups
      • Retrieve Data with Groups
      • Remove Data with Group
      • Search Group Data Using SQL
      • Delete Group Data Using SQL
    • Tags
      • Overview
      • Add/Update Data with Tags
      • Retrieve Data with Tags
      • Remove Data with Tags
      • Search Tag Data Using SQL
      • Delete Tag Data Using SQL
    • Named Tags
      • Overview
      • Add/Update Data with Named Tags
      • Remove Data with Named Tags
      • Search Data with Named Tags Using SQL
      • Delete Data with Named Tags Using SQL
    • Expirations
      • Overview
      • Absolute Expiration
      • Sliding Expiration
    • Data Dependency
      • Key Dependency
      • Multi-Cache Dependency
    • Dependency on Database
      • SQL Server
      • Oracle
      • OleDB with Polling
      • CLR Procedures in SQL Server
    • Dependency on External Source
      • File Dependency
      • Custom Dependency
      • Aggregate Dependency
    • Locks
      • Types of Locking
      • Pessimistic Locking
      • Optimistic Locking
    • SQL Query
      • Overview
      • Define Indexes Programmatically
      • Query with ExecuteReader and ExecuteScalar
      • Delete Data with ExecuteNonQuery
      • SQL Reference
    • LINQ Query
      • Overview
      • LINQ Query for Objects
      • LINQ Reference
    • Data Structures
      • Overview
      • List
      • Queue
      • Set
      • Dictionary
      • Counter
      • Invalidation Attributes
      • Searchable Attributes
      • Query on Data Structures
      • Remove from Data Structure
    • Events
      • Cache Level Events
      • Item Level Events
      • Management Level Events
    • Pub/Sub Messaging
      • Overview
      • Topics
      • Publish Messages
      • Subscribe to a Topic
      • Pub/Sub Events
    • Continuous Query
      • Overview
      • Use Continuous Query
    • Stream Processing
      • Add/Update Stream Data
      • Retrieve Stream Data
    • JSON
      • Overview
      • Use JSON Objects
      • Query JSON Data
    • Security API
      • Login with Credentials
    • Management API
    • Clear Cache
    • Error Logging
    • Location Affinity
  • Server-side API Programming
    • Loader and Refresher
      • Overview
      • Implement Loader and Refresher
      • Components of Loader/Refresher
    • Data Source Providers
      • Read-through
        • Implement Read-through
        • Use Read-through
      • Write-through
        • Implement Write-through
        • Use Write-through
        • Use Write-behind
    • Custom Dependency
      • Implement Extensible Dependency
      • Implement Bulk Extensible Dependency
      • Implement Notify Extensible Dependency
    • Bridge Conflict Resolver
    • Entry Processor
      • Overview
      • Implement Entry Processor
    • MapReduce
      • Overview
      • Implement MapReduce
      • Use MapReduce
    • MapReduce Aggregator
      • Overview
      • Implement and Use Aggregator
    • Compact Serialization
  • Client Side Features
    • ASP.NET Core Caching
      • Session Storage
        • Session Provider
        • IDistributedCache
        • Sessions Usage
        • Multi-site Session Provider
        • Session Sharing with ASP.NET
      • SignalR
        • NCache Extension for SignalR Core
      • Response Caching
        • Configure and Use
        • Configure with IDistributedCache
      • Data Caching
        • NCache API
        • IDistributedCache API
      • Data Protection Provider
        • Configure
    • Java Web App Caching
      • Web Sessions
        • Overview
        • Configure App
          • Add Maven Dependencies
          • Deploy Application
        • Multi-site Sessions
    • Node.js App Caching
      • Web Sessions
    • ASP.NET Caching Benefits and Overview
      • ASP.NET Session State Provider Properties
      • Multi-region ASP.NET Session State Provider Configuration
      • Session Sharing between ASP.NET and ASP.NET Core
      • ASP.NET SignalR Backplane
        • NCache Extension for SignalR
      • ASP.NET View State Caching
        • View State Content Optimization Configuration
        • Group View State with Sessions
        • Limit View State Caching
        • Page Level Grouping
      • ASP.NET Output Cache
        • Output Caching Provider Overview
        • Output Cache with Custom Hooks
  • .NET Third Party Integrations
    • Entity Framework (EF) Core
      • Installation
      • Configure
      • EF Core Extension Methods
        • Extension Methods
        • Cache Handle
        • Caching Options
        • Query Deferred API
      • Logging in EF Core
    • Entity Framework EF 6
      • EF Second Level Cache
      • EF Caching Resync Provider
      • EF Caching Configuration File
    • NHibernate
      • Second Level Cache
      • Query Caching
      • Synchronize Database with Cache
    • Debug NCache Providers in Visual Studio
  • Java Third Party Integrations
    • Hibernate
      • Second Level Cache
      • Configure Cacheable Objects and Regions
      • Configure Application
      • Query Caching
    • Spring
      • Overview
      • Use NCache with Spring
        • Configure Generic Provider
        • Configure JCache Spring Caching Provider
        • Configure Caching Declaration
        • Configure Spring Sessions
    • JCache API
      • CRUD Operations
      • Expiration
      • Events
  • Third-Party Wrappers
    • AppFabric to NCache Migration
      • AppFabric API vs. NCache API
      • Configuration Differences Between AppFabric and NCache
      • Migrating from an AppFabric Application to NCache
    • Redis to NCache Migration
      • Redis to NCache Migration
    • Memcached Wrapper
      • Memcached Gateway Approach
      • Memcached Client Plugin for .NET

Add/Update Data with Named Tags in Data Cache

To associate Named Tags with any cache item, it is required to provide a list of Named Tags, each having two parameters that are key as a string which is the name of the tag, and value as any primitive type which is the assigned value to the key. NCache then allows you to associate your objects with these Named Tags. You can add items in the data cache with Named Tags and then later retrieve these items from the cache using the previously added Named Tags.

When items are already added in the cache with certain Named Tags, NCache provides the user with an option of updating Named Tags already present in the data cache.

Prerequisites

  • .NET
  • Java
  • Python
  • Node.js
  • Legacy API
  • 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, Add, Insert, Get, NamedTagsDictionary.
  • 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: Cache, CacheItem, add, insert, CacheItemVersion, getCacheItem, NamedTagsDictionary, setNamedTags.
  • 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: Cache, CacheItem, add, insert, get_cacheitem, set_named_tags, NamedTagsDictionary.
  • 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: Cache, CacheItem, NamedTagsDictionary, add, insert, setNamedTags, getCacheItem.
  • 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.

Add Named Tags

NCache provides a custom class, CacheItem that can be used to add data to the data cache. This class encapsulates data as its value property. The CacheItem also lets you set additional specifications associated with an object as a property of the Named Tags class.

In the following example, Named Tags are set by assigning them as a property of CacheItem.

  • .NET
  • Java
  • Python
  • Node.js
  • Legacy API
// Precondition: Cache is already connected
// In an online-store, VIP members are offered 10% discount
// A customer with VIP membership has signed in to the website

string customerKey = $"Customer:ALFKI";
Customer customer = cache.Get<Customer>(customerKey);

// Get customer from database if not found in cache
if (customer == null)
{
    // Get customer from the database
    customer = FetchCustomerFromDB("ALFKI");

    // Create a new CacheItem
    var cacheItem = new CacheItem(customer);

    // Creating a Named Tags Dictionary
    var namedTags = new NamedTagsDictionary();

    // Adding Named Tags to the Dictionary
    // Where keys are the names of the tags as string type and Values are of primitive type
    namedTags.Add("VIP_Membership_Discount", 0.10 );

    // Setting the named tag property of the cacheItem
    cacheItem.NamedTags = namedTags;

    cache.Add(customerKey, cacheItem);
}
// Precondition: Cache is already connected
// In an online-store, VIP members are offered 10% discount
// A customer with VIP membership has signed in to the website

String customerKey = "Customer:ALFKI";
Customer customer = cache.get(customerKey, Customer.class);

if (customer == null) {
    // Fetch customer from database and create a com.alachisoft.ncache.sample.NamedTags.Customer object
    customer = Customer.fetchCustomerFromDB("Customer:ALFKI");
}
NamedTagsDictionary namedTags = new NamedTagsDictionary();
namedTags.add("VIP_Membership_Discount", 0.10);

CacheItem cacheItem = new CacheItem(customer);
cacheItem.setNamedTags(namedTags);

cache.insert(customerKey, cacheItem);
System.out.println("Customer added to cache: " + customerKey);
# Precondition: Cache is already connected
# Get product from database against given productID

product = fetch_product_from_db()

# Create a unique cache key for this product
key = "Product:" + product.get_product_id()

# Creating a Named Tags Dictionary
product_named_tag = ncache.NamedTagsDictionary()

# Adding Named Tags to the Dictionary where
# Keys are the names of the tags as string type
# Values are the instances of data, of primitive data structures.
product_named_tag.add("FlashSaleDiscount", 0.5)

# Create a new CacheItem
cache_item = ncache.CacheItem(product)

# Setting the named tag property of the CacheItem
cache_item.set_named_tags(product_named_tag)

# Add product object to the cache
version = cache.add(key, cache_item)

# CacheItem added successfully
// This is an async method
// Precondition: Cache is already connected
// Get product from database against given productID

var product = this.fetchProductFromDB(1001);

// Create a unique cache key for this product
var key = "Product:" + product.getProductID();

// Creating a Named Tags Dictionary
var productNamedTag = new ncache.NamedTagsDictionary();

// Adding Named Tags to the Dictionary where
// Keys are the names of the tags as string type
// Values are the instances of data, of primitive data structures.
productNamedTag.add("FlashSaleDiscount", 0.5);

// Create a new CacheItem
// You alose need to specify the FQN (Fully Qualified Name) of the class
var cacheItem = new ncache.CacheItem(product,"FQN.Product");

// Setting the named tag property of the CacheItem
cacheItem.setNamedTags(productNamedTag);

// Add product object to the cache
var version = await this.cache.add(key, cacheItem);

// CacheItem added successfully
CacheItem cacheItem = new CacheItem(product);
cacheItem.NamedTags = productNamedTag;

cache.Add(key, 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.

Update Named Tags Data through CacheItem

Updating Named Tags through CacheItem requires the item to be first fetched, its Named Tags to be modified, and then it is reinserted into the cache using the Insert method.

The following example first fetches the CacheItem, creates a list with the newly Named Tags, and then reinserts the CacheItem in the cache along with the modified named tag list. Hence, it overwrites the value of existing Named Tags.

Warning

Providing Null Named Tag array will throw an ArgumentNullException.

  • .NET
  • Java
  • Python
  • Node.js
// Store Owner has increased VIP membership discount to 12%

string customerKey = $"Customer:ALFKI";
Customer customer = cache.Get<Customer>(customerKey);

// Get the customer from database if not found in the cache
if (customer == null)
{
    customer = FetchCustomerFromDB("ALFKI");
}

// Create a new CacheItem
var cacheItem = new CacheItem(customer);

// Creating a Named Tags Dictionary
var newNamedTags = new NamedTagsDictionary();

// Add Named Tag with the updated discount value to the Dictionary
newNamedTags.Add("VIP_Membership_Discount", 0.12);

// Updates the Named Tags with the new Named Tags
// Overrides the value of the existing Named Tags
cacheItem.NamedTags = newNamedTags;

// Reinserts the updated cacheItem into the cache with the modified Named Tags
cache.Insert(customerKey, cacheItem);
// Store Owner has increased VIP membership discount to 12%

String customerKey = "Customer:ALFKI";
Customer customer = cache.get(customerKey, Customer.class);

if (customer == null) {
    // Fetch customer from database and create a com.alachisoft.ncache.sample.NamedTags.Customer object
    customer = Customer.fetchCustomerFromDB("Customer:ALFKI");
}
// Create a new CacheItem
CacheItem cacheItem = new CacheItem(customer);

NamedTagsDictionary namedTags = new NamedTagsDictionary();
namedTags.add("VIP_Membership_Discount", 0.50);
cacheItem.setNamedTags(namedTags);

cache.insert(customerKey, cacheItem);

System.out.println("Customer with updated named tags inserted into cache: " + customerKey);
# Get cache item from cache against given key

key = "Product:1001"
cache_item = cache.get_cacheitem(key)

# Create a Named Tags Dictionary
new_product_named_tag = ncache.NamedTagsDictionary()

# Adding Named Tags to the Dictionary where
# Keys are the names of the tags as string type
# Values are the updated instances of data, of primitive data types.
new_product_named_tag.add("FlashSaleDiscount", 0.7)

# Updates the Named Tags with the new Named Tags
# Overrides the value of the existing Named Tags
cache_item.set_named_tags(new_product_named_tag)

# Re-insert the cacheItem into cache with modified Named Tags
version = cache.insert(key, cache_item)

# cacheItem is successfully added in cache with modified Named Tags
// This is an async method
// Get cache item from cache against given key

var key = "Product:1001";
var cacheItem = await this.cache.getCacheItem(key);

// Create a Named Tags Dictionary
var newProductNamedTag = new ncache.NamedTagsDictionary();

// Adding Named Tags to the Dictionary where
// Keys are the names of the tags as string type
// Values are the updated instances of data, of primitive data types.
newProductNamedTag.add("FlashSaleDiscount", 0.7);

// Updates the Named Tags with the new Named Tags
// Overrides the value of the existing Named Tags
cacheItem.setNamedTags(newProductNamedTag);

//Re-inserts the cacheItem into cache with modified Named Tags
var version = await this.cache.insert(key, cacheItem);

// cacheItem is successfully added in cache with modified Named Tags

Additional Resources

NCache provides a sample application for Named Tags on GitHub.

See Also

.NET: Alachisoft.NCache.Runtime.Caching namespace.
Java: com.alachisoft.ncache.runtime.caching namespace.
Python: ncache.runtime.caching class.
Node.js: NamedTagsDictionary class.

In This Article
  • Prerequisites
  • Add Named Tags
  • Update Named Tags Data through CacheItem
  • Additional Resources
  • See Also

Contact Us

PHONE

+1 (214) 764-6933   (US)

+44 20 7993 8327   (UK)

 
EMAIL

sales@alachisoft.com

support@alachisoft.com

NCache
  • NCache Enterprise
  • NCache Professional
  • Edition Comparison
  • NCache Architecture
  • Benchmarks
Download
Pricing
Try Playground

Deployments
  • Cloud (SaaS & Software)
  • On-Premises
  • Kubernetes
  • Docker
Technical Use Cases
  • ASP.NET Sessions
  • ASP.NET Core Sessions
  • Pub/Sub Messaging
  • Real-Time ASP.NET SignalR
  • Internet of Things (IoT)
  • NoSQL Database
  • Stream Processing
  • Microservices
Resources
  • Magazine Articles
  • Third-Party Articles
  • Articles
  • Videos
  • Whitepapers
  • Shows
  • Talks
  • Blogs
  • Docs
Customer Case Studies
  • Testimonials
  • Customers
Support
  • Schedule a Demo
  • Forum (Google Groups)
  • Tips
Company
  • Leadership
  • Partners
  • News
  • Events
  • Careers
Contact Us

  • EnglishChinese (Simplified)FrenchGermanItalianJapaneseKoreanPortugueseSpanish

  • Contact Us
  •  
  • Sitemap
  •  
  • Terms of Use
  •  
  • Privacy Policy
© Copyright Alachisoft 2002 - 2025. All rights reserved. NCache is a registered trademark of Diyatech Corp.
Back to top