sp.processor.stop() (mongosh method)

Definition

sp.processor.stop()

Compatibility

This method is supported in Atlas Stream Processing Workspaces.

Syntax

The sp.processor.stop() method has the following syntax:

sp.processor.stop(
  {
    <options>
  }
)

Command Fields

sp.processor.stop() takes a generic, optional <options> document whose fields are passed to the underlying stop command.

Behavior

sp.processor.stop() stops a named stream processor on the current stream processing workspace. The stream processor must be in a running state. If you invoke sp.processor.stop() for a stream processor that is not running, mongosh will return an error.

Access Control

The user running sp.processor.stop() must have the atlasAdmin role.

Example

The following example stops a stream processor named solarDemo.

sp.solarDemo.stop()

Learn More

• Manage Stream Processors