Skip to content

Commit 38258c1

Browse files
authored
(DOCSP-36600) Backporting. (#7505)
* (DOCSP-36600) Add sp.listConnections() page * (DOCSP-36600) * (DOCSP-36600) * (DOCSP-36600) Copy review and updating other pages to conform. * (DOCSP-36600) * (DOCSP-36600) * (DOCSP-36600) * (DOCSP-36600)
1 parent 955a6cd commit 38258c1

12 files changed

+117
-17
lines changed
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
You can only invoke this command while connected to a stream
2+
processing instance.
3+
4+
This command requires ``mongosh`` version ≥ 2.0.

source/reference/method.txt

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Atlas Search Index Methods
3838
/reference/method/js-atlas-search
3939

4040
Atlas Stream Processing Methods
41-
------------------------------------------------------
41+
-------------------------------
4242

4343
:atlas:`Atlas Stream Processors
4444
</atlas-sp/overview/#mongodb-expression-exp.Stream-Processor>`
@@ -65,6 +65,11 @@ Use the following methods to manage Stream Processors:
6565

6666
- Creates a stream processor.
6767

68+
* - :method:`sp.listConnections()`
69+
70+
- Lists all existing connections in the connection registry of the
71+
current stream processing instance.
72+
6873
* - :method:`sp.listStreamProcessors()`
6974

7075
- Lists all existing stream processors on the current stream

source/reference/method/js-atlas-streams.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,11 @@ Use the following methods to manage Stream Processors
4343

4444
- Creates a stream processor.
4545

46+
* - :method:`sp.listConnections()`
47+
48+
- Lists all existing connections in the connection registry of the
49+
current stream processing instance.
50+
4651
* - :method:`sp.listStreamProcessors()`
4752

4853
- Lists all existing stream processors on the current stream
@@ -77,6 +82,7 @@ Use the following methods to manage Stream Processors
7782
:hidden:
7883

7984
/reference/method/sp.createStreamProcessor
85+
/reference/method/sp.listConnections
8086
/reference/method/sp.listStreamProcessors
8187
/reference/method/sp.process
8288
/reference/method/sp.processor.drop

source/reference/method/sp.createStreamProcessor.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ Definition
1515

1616
.. method:: sp.createStreamProcessor()
1717

18-
.. versionadded:: 7.0
19-
2018
Creates a :atlas:`Stream Processor
2119
</atlas-sp/overview/#mongodb-expression-exp.Stream-Processor>` on
2220
the current :atlas:`Stream Processing Instance
2321
</atlas-sp/overview/#mongodb-expression-exp.Stream-Processing-Instance>`.
2422

23+
.. include:: /includes/stream-processing-command-reqs.rst
24+
2525
Syntax
2626
-----------
2727

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
====================
2+
sp.listConnections()
3+
====================
4+
5+
.. default-domain:: mongodb
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 2
11+
:class: singlecol
12+
13+
Definition
14+
-----------
15+
16+
.. method:: sp.listConnections()
17+
18+
Returns documents for each connection in the connection registry of
19+
the current :atlas:`stream processing instance
20+
</atlas-sp/manage-processing-instance>`. Each document provides
21+
descriptive information including the name and type of each
22+
connection.
23+
24+
.. include:: /includes/stream-processing-command-reqs.rst
25+
26+
Syntax
27+
-----------
28+
29+
The :method:`sp.listConnections()` method has the following syntax:
30+
31+
.. code-block:: json
32+
33+
sp.listConnections()
34+
35+
36+
Command Fields
37+
---------------------------
38+
39+
``sp.listConnections()`` takes no fields.
40+
41+
Behavior
42+
---------------
43+
44+
``sp.listConnections()`` returns documents describing all of the
45+
connections in the connection registry of the current stream
46+
processing instance to the shell.
47+
48+
Access Control
49+
------------------------
50+
51+
The user running ``sp.listConnections()`` must have the
52+
:atlasrole:`atlasAdmin` role.
53+
54+
Example
55+
----------------
56+
57+
The following example shows an expected response from
58+
``sp.listConnections()``:
59+
60+
.. io-code-block::
61+
:copyable: true
62+
63+
.. input::
64+
:language: sh
65+
66+
sp.listStreamProcessors()
67+
68+
.. output::
69+
:language: json
70+
:linenos:
71+
72+
{
73+
ok: 1,
74+
connections: [
75+
{ name: 'vt', type: 'atlas', cluster: 'versiontest' },
76+
{ name: 'testkafka', type: 'kafka' },
77+
{ name: 'sample_stream_solar', type: 'inmemory' },
78+
{ name: 'jsncluster0', type: 'atlas', cluster: 'jsncluster0' }
79+
]
80+
}
81+
82+
Learn More
83+
------------------
84+
85+
- :atlas:`Manage Stream Processors </atlas-sp/manage-processing-instance>`

source/reference/method/sp.listStreamProcessors.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@ Definition
1515

1616
.. method:: sp.listStreamProcessors()
1717

18-
.. versionadded:: 7.0
19-
2018
Returns documents for each named
2119
:atlas:`Stream Processor
2220
</atlas-sp/overview/#mongodb-expression-exp.Stream-Processor>` on
@@ -25,6 +23,8 @@ Definition
2523
document provides descriptive information including the name,
2624
current state, and pipeline of a stream processor.
2725

26+
.. include:: /includes/stream-processing-command-reqs.rst
27+
2828
Syntax
2929
-----------
3030

source/reference/method/sp.process.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ Definition
1515

1616
.. method:: sp.process()
1717

18-
.. versionadded:: 7.0
19-
2018
Creates an ephemeral :atlas:`Stream Processor
2119
</atlas-sp/overview/#mongodb-expression-exp.Stream-Processor>` on
2220
the current :atlas:`Stream Processing Instance
2321
</atlas-sp/overview/#mongodb-expression-exp.Stream-Processing-Instance>`.
2422

23+
.. include:: /includes/stream-processing-command-reqs.rst
24+
2525
Syntax
2626
-----------
2727

source/reference/method/sp.processor.drop.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ Definition
1515

1616
.. method:: sp.processor.drop()
1717

18-
.. versionadded:: 7.0
19-
2018
Deletes a named
2119
:atlas:`Stream Processor
2220
</atlas-sp/overview/#mongodb-expression-exp.Stream-Processor>` from
2321
the current :atlas:`Stream Processing Instance
2422
</atlas-sp/overview/#mongodb-expression-exp.Stream-Processing-Instance>`.
2523

24+
.. include:: /includes/stream-processing-command-reqs.rst
25+
2626
Syntax
2727
-----------
2828

source/reference/method/sp.processor.sample.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ Definition
1515

1616
.. method:: sp.processor.sample()
1717

18-
.. versionadded:: 7.0
19-
2018
Returns arrays of sampled results from a currently running
2119
:atlas:`Stream Processor
2220
</atlas-sp/overview/#mongodb-expression-exp.Stream-Processor>` on
2321
the current :atlas:`Stream Processing Instance
2422
</atlas-sp/overview/#mongodb-expression-exp.Stream-Processing-Instance>`.
2523

24+
.. include:: /includes/stream-processing-command-reqs.rst
25+
2626
Syntax
2727
-----------
2828

source/reference/method/sp.processor.start.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ Definition
1515

1616
.. method:: sp.processor.start()
1717

18-
.. versionadded:: 7.0
19-
2018
Starts a named
2119
:atlas:`Stream Processor
2220
</atlas-sp/overview/#mongodb-expression-exp.Stream-Processor>` on
2321
the current :atlas:`Stream Processing Instance
2422
</atlas-sp/overview/#mongodb-expression-exp.Stream-Processing-Instance>`.
2523

24+
.. include:: /includes/stream-processing-command-reqs.rst
25+
2626
Syntax
2727
-----------
2828

source/reference/method/sp.processor.stats.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ Definition
1515

1616
.. method:: sp.processor.stats()
1717

18-
.. versionadded:: 7.0
19-
2018
Returns a document containing statistics of a currently running
2119
:atlas:`Stream Processor
2220
</atlas-sp/overview/#mongodb-expression-exp.Stream-Processor>` on
2321
the current :atlas:`Stream Processing Instance
2422
</atlas-sp/overview/#mongodb-expression-exp.Stream-Processing-Instance>`.
2523

24+
.. include:: /includes/stream-processing-command-reqs.rst
25+
2626
Syntax
2727
-----------
2828

source/reference/method/sp.processor.stop.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ Definition
1515

1616
.. method:: sp.processor.stop()
1717

18-
.. versionadded:: 7.0
19-
2018
Stops a named
2119
:atlas:`Stream Processor
2220
</atlas-sp/overview/#mongodb-expression-exp.Stream-Processor>` on
2321
the current :atlas:`Stream Processing Instance
2422
</atlas-sp/overview/#mongodb-expression-exp.Stream-Processing-Instance>`.
2523

24+
.. include:: /includes/stream-processing-command-reqs.rst
25+
2626
Syntax
2727
-----------
2828

0 commit comments

Comments
 (0)