Resume Index Operation

  • After an index has been paused using StopIndexOperation,
    use StartIndexOperation to resume the index.

  • When resuming the index from the client:
    The index is resumed on the preferred node only, and Not on all the database-group nodes.

  • When resuming the index from the Studio indexes list view:
    The index is resumed on the local node the browser is opened on, even if it is Not the preferred node.

  • In this page:

Resume index example

// Define the resume index operation, pass the index name 
const resumeIndexOp = new StartIndexOperation("Orders/Totals");

// Execute the operation by passing it to maintenance.send
await store.maintenance.send(resumeIndexOp);

// At this point:
// Index 'Orders/Totals' is resumed on the preferred node

// Can verify the index status on the preferred node by sending GetIndexingStatusOperation
const indexingStatus = await store.maintenance.send(new GetIndexingStatusOperation());

const index = indexingStatus.indexes.find(x => === "Orders/Totals")
assert.strictEqual(index.status, "Running");


// class name has "Start", but this is ok, this is the "Resume" operation
const resumeIndexOp = new StartIndexOperation(indexName);
Parameters Type Description
indexName string Name of an index to resume