sp.processor.stop()

Definition

sp.processor.stop()

Stops a named Stream Processor on the current Stream Processing Instance.

You can only invoke this command while connected to a stream processing instance.

This command requires mongosh version ≥ 2.0.

Compatibility

This method is supported in Atlas Stream Processing Instances.

Syntax

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

sp.processor.stop()

Command Fields

sp.processor.stop() takes no fields.

Behavior

sp.processor.stop() stops a named stream processor on the current stream processing instance. 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