Create a Distributed Lucene with Persistence Cache

A distributed Lucene cache deals with Lucene-based indexing and searching of documents. NCache allows you to specify your store type as distributed Lucene through the NCache Management Center and Command Line Interface. This section will explain how you can create a Distributed Lucene with Persistence cache.

Important

For Distributed Lucene, it's strongly encouraged that you use an SSD to store your indexes instead of an HDD.

Using NCache Management Center

  • Launch the NCache Management Center by browsing to http://localhost:8251 or <server-ip>:8251 on Windows and Linux.

  • In the left navigation bar, click on Clustered Caches. This opens up the Clustered Caches page at <server-ip>:8251/ClusteredCaches/.

  • To create a new distributed Lucene cache, click on New.

NCache Management Center Clustered Caches

  • From the In-Memory Store Type dropdown menu, select Distributed Lucene with Persistence and specify the name of your cache. Click Next.
Note

Distributed Lucene with Persistence supports JSON serialization only.

Distributed Lucene Cache Step 1

  • Select the caching topology and set any advanced options like Operation Timeout and Statistic Replication Interval. Click Next.
Note

Distributed Lucene with Persistence only supports the Partitioned and Partition-Replica Topologies.

Distributed Lucene Cache Step 2

  • Specify the Cache Partition Size of the cache and add your cluster nodes by specifying the Server Node IP or Hostname of the machine and clicking on the Add Node button. To add more nodes, click Add Node. Click Next once all the required nodes are added.
Note

Cache size doesn't matter much in Distributed Lucene with Persistence as all documents are stored on a disk instead of the actual cache itself.

Distributed Lucene 3

  • You have two options, Create new indexes or Use existing indexes. Choose the former option and specify your index path in the field next to the Index Path label. The default path is C:\ProgramData\ncache\lucene-index. Once done, click on Validate Path. Once your Index Path has been validated, you will be prompted with a success notification and the path will be updated as C:\ProgramData\ncache\lucene-index\demoLuceneCache. Click Next.
Warning

Unless the index path has been validated successfully, you can't proceed further with the cache creation process.

Distributed Lucene 4

  • Change the Cluster Port and Port Range if required. Enable pipelining for the cache if required by checking the Enable Pipelining checkbox. Set the Batch Interval for the duration after which the commands will be transmitted over the network in microseconds. Click Next.

Distributed Lucene 5

  • If you want to enable encryption and compression, check the Enable Encryption and Enable Compression checkboxes. If enabled, set the Providers and Key for encryption and Threshold Size for compression. Click Next.

Distributed Lucene 6

  • Click Finish to complete the process. Your created cache will appear on the Clustered Caches page with the server nodes and their status and a success notification will be displayed in the notification panel.

Distributed Lucene 8

Using Command Line Interface

You can also use PowerShell or Command Line Tools to manage distributed Lucene caches by using the NCache supported Command Line Interface.

Create Cache

The New-Cache PowerShell cmdlet is responsible for creating new caches.

The following command creates a cache named demoLuceneCache on the nodes 20.200.20.39 and 20.200.20.40. The InMemoryStoreType is specified as DistributedLuceneWithPersistence and LuceneIndexPath provided is C:\ProgramData\ncache\lucene-index. The Topology is set as PartitionReplica.

New-Cache -Name demoLuceneCache -Server "20.200.20.39,20.200.20.40" -Size 1024 -InMemoryStoreType DistributedLuceneWithPersistence -LuceneIndexPath "C:\ProgramData\ncache\lucene-index\" -Topology PartitionReplica

Start Cache

The Start-Cache PowerShell cmdlet is responsible for starting already created caches.

The following command starts the distributed Lucene cache demoLuceneCache created previously on node 20.200.20.39.

Start-Cache -Name demoLuceneCache -Server 20.200.20.39

See Also

Add Local/Remote Clients
Monitor Caches
NCache Programmer's Guide
NCache Command Line Interface