• Facebook
  • Twitter
  • Youtube
  • LinkedIn
  • RSS
  • Docs
  • Comparisons
  • Blogs
  • Try NCache
  • Contact Us
Try NCache
Show / Hide Table of Contents

Add-QueryIndex

The Add-QueryIndex PowerShell cmdlet enables the user to add query indexes for the objects to be added in the cache. These query indexes can later be used by the user to search for items in the cache.

Warning

Make sure that the cache has been stopped before proceeding to execute this cmdlet.

Add-QueryIndex -CacheName -AssemblyPath `
               -Attributes -Class `
               [-Server] [-Port] `
               [-TlsCertPath] [-TlsCertPassword] `
               [-Credentials] [-NoLogo]

Examples

  • This command adds query index for the attributes CustomerID and FirstName in cache.
Add-QueryIndex -CacheName defaultCache -AssemblyPath C:\Data.dll `
               -Class Data.Customer -Attributes CustomerID$FirstName
  • This command adds query index for the attributes CustomerID and FirstName in cache on server 20.200.20.11.
Add-QueryIndex -CacheName defaultCache -AssemblyPath C:\Data.dll `
               -Class Data.Customer -Attributes CustomerID$FirstName `
               -Server 20.200.20.11
  • This command adds JSON-based query index for the attributes CustomerID and FirstName whose data type will be String and Integer respectively in cache on server 20.200.20.11.
Add-QueryIndex -CacheName defaultCache -JsonFilePath C:\data.json `
               -Class Data.Customer -Attributes CustomerID$FirstName `
               -AttributeTypes Integer$String -Server 20.200.20.11
  • This command adds query indexes for the CustomerID and FirstName attributes of Data.Customer from C:\Data.dll to defaultCache on the specified server with mutual TLS (mTLS) enabled. It runs from a machine where NCache is not installed and uses C:\certs\client.pem to authenticate the machine running the cmdlet. The -TlsCertPassword parameter decrypts the certificate’s password-protected private key. Omit this parameter if the private key is not encrypted.
Add-QueryIndex -CacheName defaultCache -AssemblyPath C:\Data.dll `
               -Type Data.Customer -Attributes CustomerID'$'FirstName `
               -Server 20.200.20.11 -TlsCertPath "C:\certs\client.pem" `
               -TlsCertPassword "clientKeyPassword"
  • This command adds query index for the attributes CustomerID and FirstName in cache using security credentials.
Add-QueryIndex -CacheName defaultCache -AssemblyPath C:\Data.dll `
               -Class Data.Customer -Attributes CustomerID$FirstName `
               -Credentials(Get-Credential john_smith)

Properties

Note

The parameters with asterisk (*) on their names are the required parameters and the rest are optional.

Parameters Data Types Description Default Value
-CacheName* <String> Specifies the name of the cache for which query indexing needs to be done.
NOTE: The cache must already exist on the source server.
-
-AssemblyPath* <String> Specifies the path of the assembly which needs to be configured. -
-Attributes* <String> Specifies the attributes for query indexing. If multiple attributes need to be indexed; they are separated by a ‘$’. -
-Class* <String> Specifies the fully qualified class name for query indexing. -
-Server <String> Specifies a server name where the NCache Service is running and a cache with the specified cache-name is registered. IP of local machine
-Port <Integer> Specifies the server port where NCache Service is listening. 9803
-TlsCertPath <string> Path to the client PEM certificate used to authenticate the machine running the NCache PowerShell cmdlet when connecting to an NCache server with mutual TLS (mTLS) enabled. The PEM file must contain the private key, leaf certificate, and any intermediate certificates. You can generate a certificate using New-NCacheTlsCertificate. This parameter is required when running the PowerShell module from a machine where NCache is not installed and the server requires mTLS. On a machine with an NCache server installation, the node's own certificate is used automatically. Relative paths are resolved against the current PowerShell location, and the file must exist. To configure the certificate presented by the server, use -CustomCertificatePath. -
-TlsCertPassword <string> Password used to load the encrypted private key in the PEM file specified by -TlsCertPath. Required only when the private key is password-protected. Not needed for an unencrypted private key. The password is used only to load the client certificate for the current command's connections. It is not saved in the NCache server configuration. -
-Credentials <pscredential> Specifies the user credentials required to authorize access for the specified operation. These credentials should belong to a user with the appropriate permissions at the node. -
-NoLogo <SwitchParameter> Suppresses display of the logo banner. False

Contact Us

PHONE

+1 214-619-2601   (US)

+44 20 7993 8327   (UK)

 
EMAIL

sales@alachisoft.com

support@alachisoft.com

NCache
  • Edition Comparison
  • NCache Architecture
  • Benchmarks
Try NCache
Pricing
NCache Playground

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

  • EnglishChinese (Simplified)FrenchGermanItalianJapaneseKoreanPortugueseSpanish

  • Terms of Use
  •  
  • Privacy Policy
  •  
  • Cookie Policy
© Copyright Alachisoft 2002 - . All rights reserved. NCache is a registered trademark of Diyatech Corp.
  • Facebook
  • Twitter
  • Youtube
  • LinkedIn
  • RSS