Create a Distributed Lucene 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 Web Manager and PowerShell. This section will explain how you can create a Distributed Lucene cache.

Important

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

Clustered Lucene Cache

A cache cluster is a set of interconnected server nodes forming a cluster of servers that behave as a single cache unit from the outside. Here is how you can create a clustered Distributed Lucence cache.

Using NCache Web Manager

  • Launch NCache Web Manager 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 Web Manager Clustered Caches

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

Distributed Lucene supports JSON serialization only.

Warning

If a cache with the specified name already exists, you are prompted with an error message.

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 only supports the Partitioned Topology in NCache Professional.

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 Add Node button. To add more nodes, click Add Node button. Click Next once all the required nodes are added.
Note

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

Warning

If a node is already registered on that cache, notification is prompted.

Distributed Lucene 3

  • You have two options, Create new indexes and Use existing indexes. Chose 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 path will be updated as C:\ProgramData\ncache\lucene-index\demoClusteredCache. 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. Click Next.

Distributed Lucene 5

  • In Advanced Options page, you can configure the following settings:

    • You can change the Default Priority of eviction from the dropdown list.

    • You can change the Eviction percentage by changing the value of the field next to the Eviction Percentage label.

    • You can change the Clean interval value. Default is 15 seconds.

    • This cache can be started automatically upon the completion of this process if you have check the Start this cache on Finish checkbox.

  • This cache will start automatically after service restart if you check the Auto start this cache on service startup.

Distributed Lucene 7

  • Click Finish to complete the process. Your created cache will appear in 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 PowerShell

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

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

New-Cache -Name demoClusteredCache -Server "20.200.20.40,20.200.20.39" -Size 1024 -InMemoryStoreType DistributedLucene -LuceneIndexPath "C:\ProgramData\ncache\lucene-index\" -Topology Partitioned

Local Lucene Cache

A local Lucene cache can be created in the following ways

Using NCache Web Manager

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

  • In the left navigation bar, click on Local Caches. This opens up the Local Caches page at <server-ip>:8251/LocalCaches/. The page shows any existing local caches on your machine and additional details like Server and Server Platform.

  • To create a new local cache, click on New.

Create New Local PubSub Cache Web

  • Specify the Server Node IP / Name and click Next.

Enter Server IP Web

  • Specify the In-Memory Store Type as Distributed Lucene with Persistence from the dropdown menu. Afterwards, specify the Name and Isolation Level. Click Next.
Warning

If a cache already exists against the Name specified, you are prompted with an error message.

Note

A Distributed Lucene cache only supports JSON serialization.

Specify Cache Name Web

  • Change the cache size if required and click Next.

Specify Cache Size Web

  • You have two options, Create new indexes and Use existing indexes. Chose 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 Index Path Validated on Local node notification. Click Next.
Warning

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

Lucene Index Path Validated

  • In Advanced Options page, you can configure the following settings:

    • You can change the Default Priority of eviction from the dropdown list.

    • You can change the Eviction percentage; items will be evicted from the cache using this percentage value if eviction is enabled.

    • You can change the Clean interval value. Default is 15 seconds.

    • This cache can be started automatically upon the completion of this process if you have checked the Start this cache on Finish checkbox on this dialog box.

    • You can make the cache to start automatically after service restart by checking the checkbox Auto start this cache on service startup.

Advanced Options Web

  • Click Finish. The created cache will appear on the Local Caches page, and a success notification will be received in the notification panel.

Distrbiuted Lucene Local Cache

Using PowerShell

New-Cache cmdlet enables the user to create a new cache on one or more server nodes.

This command creates a cache called myCache of Local topology with Size of 1024MB and InMemoryStoreType specified as DistributedLucene on the node 20.200.20.47

New-Cache myCache -Topology Local -InMemoryStoreType DistributedLucene -Server 20.200.20.47 -Size 1024

See Also

Start Cache
Remove Cache
Add Server Node