Docs Menu

Docs HomeDevelop ApplicationsMongoDB Manual

sp.processor.start()

On this page

  • Definition
  • Syntax
  • Command Fields
  • Behavior
  • Access Control
  • Example
  • Learn More
sp.processor.start()

Starts 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.

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

sp.processor.start()

sp.processor.start() takes no fields.

sp.processor.start() starts a named stream processor on the current stream processing instance. The stream processor must be in a STOPPED state. If you invoke sp.processor.start() for a stream processor that is not STOPPED, mongosh will return an error.

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

The following example starts a stream processor named solarDemo.

sp.solarDemo.start()
← sp.processor.sample()