定义
sp.listStreamProcessors()返回当前流处理工作区上每个已命名流处理器的文档。每个文档都提供描述性信息,包括流处理器的名称、当前省/市/自治区和管道。
只有在连接到流处理工作区时才能调用此命令。
此命令需要
mongosh版本 ≥ 2.0 。
兼容性
Atlas Stream Processing 工作区支持此方法。
语法
sp.listStreamProcessors() 方法使用的语法如下:
sp.listStreamProcessors( { <filter> })命令字段
sp.listStreamProcessors() 采用这些字段:
字段 | 类型 | 必要性 | 说明 |
|---|---|---|---|
| 文档 | Optional | 指定按哪些字段筛选流处理器的文档。 如果提供筛选器,则该命令将仅返回与您指定的所有字段的值匹配的处理器。 |
行为
sp.listStreamProcessors() 返回描述当前 stream processing 工作区上所有已命名 stream processing 处理器的文档到 STDOUT。
访问控制
运行sp.listStreamProcessors() 的用户必须具有atlasAdmin角色。
例子
以下示例显示了在不使用任何筛选器的情况下调用该命令时sp.listStreamProcessors()的预期响应:
sp.listStreamProcessors(){ id: '0135', name: "proc01", last_modified: ISODate("2023-03-20T20:15:54.601Z"), state: "RUNNING", error_msg: '', pipeline: [ { $source: { connectionName: "myKafka", topic: "stuff" } }, { $match: { temperature: 46 } }, { $emit: { connectionName: "mySink", topic: "output", } } ], lastStateChange: ISODate("2023-03-20T20:15:59.442Z")},{ id: '0218', name: "proc02", last_modified: ISODate("2023-03-21T20:17:33.601Z"), state: "STOPPED", error_msg: '', pipeline: [ { $source: { connectionName: "myKafka", topic: "things" } }, { $match: { temperature: 41 } }, { $emit: { connectionName: "mySink", topic: "results", } } ], lastStateChange: ISODate("2023-03-21T20:18:26.139Z")}以下示例显示了如果您仅对state为running的流处理器调用sp.listStreamProcessors()筛选的预期响应。
sp.listStreamProcessors({"state": "running"}){ id: '0135', name: "proc01", last_modified: ISODate("2023-03-20T20:15:54.601Z"), state: "RUNNING", error_msg: '', pipeline: [ { $source: { connectionName: "myKafka", topic: "stuff" } }, { $match: { temperature: 46 } }, { $emit: { connectionName: "mySink", topic: "output", } } ], lastStateChange: ISODate("2023-03-20T20:15:59.442Z")}