Set Index Priority Operation


  • In RavenDB, each index has its own dedicated thread for all indexing work.
    By default, RavenDB prioritizes processing requests over indexing,
    so indexing threads start with a lower priority than request-processing threads.

  • Use SetIndexesPriorityOperation to raise or lower the index thread priority.

  • Indexes scope:
    Index priority can be set for both static and auto indexes.

  • Nodes scope:
    The priority will be updated on all nodes in the database group.

  • Setting the priority can also be done from the indexes list view in the Studio.

  • In this page:


Index priority

Setting the priority will affect the indexing thread priority at the operating system level:

Priority value Indexing thread priority
at OS level
Low Lowest
  • Having the Lowest priority at the OS level, indexes will run only when there's a capacity for them, when the system is not occupied with higher-priority tasks.
  • Requests to the database will complete faster.
    Use when querying the server is more important to you than indexing.
Normal (default) Below normal
  • Requests to the database are still preferred over the indexing process.
  • The indexing thread priority at the OS level is Below normal
    while Requests processes have a Normal priority.
High Normal
  • Requests and Indexing will have the same priority at the OS level.

Set priority - single index

// Define the set priority operation
// Pass index name & priority
const setPriorityOp = new SetIndexesPriorityOperation("Orders/Totals", "High");

// Execute the operation by passing it to maintenance.send
// An exception will be thrown if index does not exist
await store.maintenance.send(setPriorityOp);

Set priority - multiple indexes

// Define the index list and the new priority:
const parameters = {
    indexNames: ["Orders/Totals", "Orders/ByCompany"],
    priority: "Low"
}

// Define the set priority operation, pass the parameters
const setPriorityOp = new SetIndexesPriorityOperation(parameters);

// Execute the operation by passing it to maintenance.send
// An exception will be thrown if any of the specified indexes do not exist
await store.maintenance.send(setPriorityOp);

Syntax

// Available overloads:
const setPriorityOp = new SetIndexesPriorityOperation(indexName, priority);
const setPriorityOp = new SetIndexesPriorityOperation(parameters);
Parameters Type Description
indexName string Index name for which to change priority
priority "Low" /
"Normal" /
"High"
Priority to set
parameters parameters object List of indexes + Priority to set.
An exception is thrown if any of the specified indexes doesn't exist.

// parameters object
{
    indexNames, // string[], list of index names
    priority    // Priority to set
}