• Webinars
  • Docs
  • Download
  • Blogs
  • Contact Us
Show / Hide Table of Contents
  • Administrator's Guide
  • NCache Architecture
    • Cache Topologies
    • Cache Cluster
    • Local Cache
    • Cache Client
    • Client Cache
    • Data Load Balancing
    • Cache Server Backward Compatibility
    • Client Backward Compatibility
    • Eviction
    • Indexing
    • Runtime Data Sharing
    • Portable Data Types
    • Class Versioning
    • IP Binding with Multiple NICs
    • Graceful Node Down
    • Separate Cache Host Process
    • Self Healing Dynamic Clustering
  • Configuring Caches
    • Create Cache
      • Creating Local Cache
        • Create New Cache
        • Add Existing Cache
      • Creating Clustered Cache
        • Create New Cache Cluster
        • Add Existing Cache Cluster
    • Remove Cache
    • Clear Cache Contents
    • Adding Server Node in Cache Cluster
    • Removing Server Node from Cache Cluster
    • Configuring Basic Cache Settings
      • Cache Size
      • Cache Isolation Levels
      • Cache Data Expiration
      • Cache Data Format
    • Configuring Cache Cluster Settings
      • Ports
      • Operation Timeout
      • Static Replication Interval
      • Connection Retries
      • Retry Interval
    • Add Test Data to Cache
    • Deploy Providers
    • Configuring Query Indexes
    • Registering Classes for Compact Serialization
      • Registering Non-Generic Classes
      • Unregistering Non-Generic Classes
      • Registering Generic Classes
      • Registering Generic Classes Using Generic Type Handler
    • Registering Classes for Portable Data Sharing
    • Configuring Data Source Providers
      • Read-Through Provider
      • Write-Through Provider
      • Write-Through Provider for Write-Behind Operations
    • Configuring Cache Startup Loader
    • Configuring Cache Level Events
    • Configuring Cache Activity Events
    • Configuring Eviction Policy
    • Configuring Compression
    • Configuring Email Notifications
    • Binding Cluster and Client/Server IP with Multiple NICs
      • Binding Cluster with a Dedicated IP
      • Binding Client/Server with a Dedicated IP
    • Configuring Heartbeat
    • Configuring MapReduce
    • Configuring Communication Reliability
    • Auto Start Cache on Boot
    • Nagling
    • Dual Socket
    • Error Logging
    • Configuration Files
      • Client Side Configurations
        • Client Config
        • EFCaching Config
      • Server Side Configurations
        • Cache Config
        • Bridge Config
        • Security Config
      • Cache Server Configuration
  • Management Operations
    • Start Cache
    • Stop Cache
    • Restart Cache
    • Manage Cache Service on a Server Node
    • Apply Configuration
    • Hot Apply Configuration
    • Reset Configuration
    • Data Load Balancing
  • Configuring Cache Clients
    • Adding Client Node in Cluster
    • Removing Client Node from Cluster
    • Configuring Client Node Settings
    • Creating Client Cache
    • Enable Client Cache on Client Nodes
    • Disable Client Cache on Client Nodes
    • Removing Client Cache
    • Configuring Client Cache Settings
  • Configuring Security
    • Configuring Security for Cache Management
    • Configuring Security for Cache
    • Configuring Security for Client Nodes
    • Configuring Encryption for Cache
    • Configure SSL/TLS Encryption in NCache
  • Configuring Bridge for WAN Replication
    • Creating Clustered Bridge
    • Adding Clustered Caches to Bridge
    • Configuring Bridge Settings
    • Configuring Conflict Resolver
    • Changing Cache Syncronization Modes
    • Configuring Master Cache
    • Force State Transfer
    • Connect/Disconnect Cache in Bridge
    • Remove Cache from Bridge
    • Bridge Management
  • NCache on Docker
    • Using NCache Docker Images
    • Customize NCache Dockerfile
  • Monitoring NCache
    • Cache Counters
    • Monitoring Caches using NCache Manager
      • Changing Management Port of Cache Node
      • Configuring Counters to Display
      • Browse Cache Statistics
      • Cluster Health
      • Monitoring Cache Clusters using NCache Email Alerts
    • Monitoring Caches using NCache Monitor
      • Monitoring with Built-In Dashboard
      • Monitoring with Custom Dashboard
    • Monitoring Bridge using NCache Manager
    • Monitoring NCache using Windows PerfMon Tool
      • Monitoring Cache Server Counters Using PerfMon
      • Monitoring Cache Client Counters Using PerfMon
      • Monitoring Bridge Counters Using PerfMon
    • Logging in NCache
      • NCache Log Viewer
      • NCache Monitor Logging
      • Performance Counters Logging
      • Windows Event Logging
      • Email Notifications on NCache Events
      • Cache Server Logging
      • Client Side API Logging
      • Cache Event IDs
    • Troubleshooting NCache Monitoring
      • Computer Name Not Found
      • Diskperf Not Installed
      • No READ Access to the Perflib Subkeys
      • Unable to Connect to Remote Server
    • IPV6 Support
  • Upgrading NCache Versions
    • Live Upgrade NCache Version
    • Upgrade NCache Version Offline
  • Apply Windows Patches on NCache Server

Configuring Query Indexes

Indexes are used in querying for efficiency, and are based on the type of a class. The user may further specify the attributes of the class on which indexes are required. Query Indexes can be configured in the following ways:

Add Query Indexes

Using NCache Manager

  • Click on the cache name in Cache Explorer to open cache settings.

  • Go to Query Indexes tab.

  • Click Add.

  • Select Query Indices wizard will open. Click Browse to browse for required assembly. Select the assembly.

  • Assembly and all its classes will be listed in Selected Assemblies section.

  • Select the required classes by checking the check box and click Add Class button.

  • List of selected classes along with its attributes will be listed down in List of selected Classes section. Select the attributes you want to add indexes for and click OK.

Note

NCache Manager displays all private members and properties of selected class. Select either private members or properties.

  • Select Query Indexes wizard will close and selected classes and their attributes will appear in ‘Selected Classes and their attributes’ section of ‘Query Indexes’ tab.

  • Right click on the cache name in Cache Explorer and select Apply Configuration option.

Using Windows PowerShell

Add-QueryIndex cmdlet enables the user to add query indexes for the objects to be added in the cache.

The following command adds ProductID, ProductName, Category, Supplier and UnitsAvailable attributes from the class Data.Product in query indexes for demoLocalCache

Add-QueryIndex demoLocalCache -AssemblyPath C:\Data.dll -Class Data.Product -Attributes ProductID$ProductName$Category$UnitsAvailable

Manually Editing NCache Configuration

Important

Make sure the cache is stopped before making any configuration changes.

  • Specify the query indexes through config.ncconf by adding the <query-indexes> and <query-class> tag under the <cache-settings> tag. The following example adds attributes of two classes, Product and Customer, as indexes:
<cache-settings ...>
  <query-indexes>
    <query-class id="Data.Customer" name="Data.Customer">
      <query-attributes id="CustomerName" name="CustomerName" data-type="System.String"/>
      <query-attributes id="CustomerID" name="CustomerID" data-type="System.Int32"/>
    </query-class>
    <query-class id="Data.Product" name="Data.Product">
      <query-attributes id="ProductName" name="ProductName" data-type="System.String"/>
      <query-attributes id="ProductID" name="ProductID" data-type="System.Int32"/>
      <query-attributes id="Category" name="Category" data-type="System.String"/>
      <query-attributes id="UnitsAvailable" name="UnitsAvailable" data-type="System.Int32"/>
    </query-class>
  </query-indexes>
</cache-settings>
  • Once changes are made, start the cache and restart NCache service.

Removing Query Indexes

Pre-defined query indexes can be removed by the user using the following steps.

Using NCache Manager

  • Select the Cache name from Cache Explorer for which query indexing is to be removed.

  • Go to the Query Indexes tab.

  • Select the Indexes to be removed by checking the box and select Remove.

Using Windows PowerShell

Remove-QueryIndex cmdlet enables the user to remove pre-defined query indexes for the objects to be added in the cache.

The following command removes query indexing for the class Customers using default port 8250.

Remove-QueryIndex -CacheName demoClusteredCache -Class Data.Customer
Back to top Copyright © 2017 Alachisoft