定義
sp.listStreamProcessors()現在の ストリーム プロセシング ワークスペース 上の名前付き ストリーム プロセッサ ごとにドキュメントを返します。各ドキュメントには、ストリーム プロセッサの名前、現在の状態、パイプラインなどの説明情報が記載されています。
このコマンドは、ストリーム処理ワークスペースに接続しているときにのみ呼び出せます。
このコマンドには、
mongoshバージョン `` 2.0が必要です。
互換性
このメソッドは Atlas Stream Processing ワークスペース でサポートされています。
構文
sp.listStreamProcessors()メソッドの構文は次のとおりです。
sp.listStreamProcessors( { <filter> })コマンドフィールド
sp.listStreamProcessors() 次のフィールドを取ります。
フィールド | タイプ | 必要性 | 説明 |
|---|---|---|---|
| ドキュメント | 任意 | ストリーム プロセッサをフィルタリングするフィールドを指定するドキュメント。 フィルターを指定すると、コマンドは指定したすべてのフィールドの値と一致するプロセッサのみを返します。 |
動作
sp.listStreamProcessors() は、現在のストリーム処理ワークスペース上のすべての名前付きストリーム プロセッサを説明するドキュメントを 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")}