js-atlas-streams.txt

.. _doc-stream-methods:

===============================
Atlas Stream Processing Methods
===============================

.. default-domain:: mongodb

.. contents:: On this page
   :local:
   :backlinks: none
   :depth: 1
   :class: singlecol

.. note:: ``mongosh`` Methods

   .. include:: /includes/fact-mongosh-shell-method-toc.rst

:atlas:`Atlas Stream Processors
</atlas-sp/overview/#mongodb-expression-exp.Stream-Processor>`
let you perform aggregation operations against streams of
continuous data using the same data model and query API that
you use with at-rest data.

Use the following methods to manage Stream Processors

.. important::

   The following methods can only be run on deployments hosted on
   :atlas:`MongoDB Atlas </>`.

.. include:: /includes/extracts/methods-toc-explanation.rst

.. list-table::
   :widths: 30 70
   :header-rows: 1

   * - Name

     - Description

   * - :method:`sp.createStreamProcessor()`

     - Creates a stream processor.

   * - :method:`sp.listStreamProcessors()`

     - Lists all existing stream processors on the current stream
       processing instance.

   * - :method:`sp.process()`

     - Creates an ephemeral stream processor.

   * - :method:`sp.processor.drop()`

     - Deletes an existing stream processor.

   * - :method:`sp.processor.sample()`

     - Returns an array of sampled results from a currently running stream processor.

   * - :method:`sp.processor.start()`

     - Starts an existing stream processor.

   * - :method:`sp.processor.stats()`

     - Returns statistics summarizing an existing stream processor.

   * - :method:`sp.processor.stop()`

     - Stops a currently running stream processor.

.. toctree::
   :titlesonly: 
   :hidden: 

   sp.createStreamProcessor </reference/method/sp.createStreamProcessor>
   sp.listStreamProcessors </reference/method/sp.listStreamProcessors>
   sp.process </reference/method/sp.process>
   sp.processor.drop </reference/method/sp.processor.drop>
   sp.processor.sample </reference/method/sp.processor.sample>
   sp.processor.start </reference/method/sp.processor.start>
   sp.processor.stats </reference/method/sp.processor.stats>
   sp.processor.stop </reference/method/sp.processor.stop>