Disable Index

On which node the index is disabled:

• The index can be disabled either:

  • On a single node, or
  • Cluster wide - on all database-group nodes.

• When disabling the index from the Client API on a single node:
  The index will be disabled on the preferred node only, and Not on all the database-group nodes.

• When disabling an index from the Studio (from the indexes list view),
  The index will be disabled on the local node the browser is opened on, even if it is Not the preferred node.

• When disabling the index manually,
  The index will be disabled on the preferred node only, and Not on all the database-group nodes.

When index is disabled:

• No indexing will be done by a disabled index on the node where index is disabled.
  However, new data will be indexed by the index on other database-group nodes where it is not disabled.

• You can still query the index,
  but results may be stale when querying a node on which the index was disabled.

• Disabling an index is a persistent operation:

  • The index will remain disabled even after restarting the server or after disabling/enabling the database.
  • To only pause the index and resume after a restart see: pause index operation.

Disable index - single node:

// Define the disable index operation
// Use this overload to disable on a single node
const disableIndexOp = new DisableIndexOperation("Orders/Totals");

// Execute the operation by passing it to maintenance.send
await documentStore.maintenance.send(disableIndexOp);

// At this point, the index is disabled only on the 'preferred node'
// New data will not be indexed on this node only

Disable index - cluster wide:

// Define the disable index operation
// Pass 'true' to disable the index on all nodes in the database-group
const disableIndexOp = new DisableIndexOperation("Orders/Totals", true);

// Execute the operation by passing it to maintenance.send
await documentStore.maintenance.send(disableIndexOp);

// At this point, the index is disabled on ALL nodes
// New data will not be indexed

Syntax:

const disableIndexOp = new DisableIndexOperation(indexName, clusterWide = false);