$listLocalSessions（集計ステージ）

定義

$listLocalSessions

mongodまたはmongosインスタンスによってメモリにキャッシュされたセッションを一覧表示します。

重要

ユーザーがmongod またはmongos インスタンスでセッションを作成すると、セッションのレコードは最初はインスタンスのメモリ内にのみ存在します。つまり、レコードはインスタンスに対してローカルです。インスタンスはキャッシュされたセッションをsystem.sessions configデータベースの コレクションに定期的に同期します。同期されると、$listSessions と配置のすべてのノードにそのセッションが表示されます。セッションレコードが コレクションに存在するまでは、system.sessions $listLocalSessions操作によってのみセッションを一覧表示できます。

$listLocalSessions操作では、db.aggregate() ではなく db.collection.aggregate()メソッドが使用されます。

$listLocalSessionsを実行するには、パイプラインの最初のステージである必要があります。

このステージの構文は、次のとおりです。

{ $listLocalSessions: <document> }

$listLocalSessionsステージは、次のいずれかの内容を持つドキュメントを取得します。

フィールド	説明
{ }	アクセス制御を使用して実行している場合、 は現在認証されているユーザーのすべてのセッションを返します。 アクセス制御なしで実行している場合、 はすべてのセッションを返します。
{ users: [ { user: <user>, db: <db> }, ... ] }	指定されたユーザーのすべてのセッションを返します。 アクセス制御を使用して実行中の場合、認証されたユーザーは、他のユーザーのセッションを一覧表示するには、クラスターに対してlistSessionsアクションの特権を持っている必要があります。
{ allUsers: true }	すべてのユーザーのすべてのセッションを返します。 アクセス制御を使用して実行している場合、認証されたユーザーにはクラスターでのlistSessionsアクション権限が必要です。

制限事項

$listLocalSessions トランザクションでは許可されていません。

例

db.aggregate( [  { $listLocalSessions: { allUsers: true } } ] )

db.aggregate( [ { $listLocalSessions: { users: [ { user: "myAppReader", db: "test" } ] } } ] )

db.aggregate( [ { $listLocalSessions: { } } ] )

const pipeline = [{ $listLocalSessions: { allUsers: true } }];
const cursor = db.aggregate(pipeline);
return cursor;

const pipeline = [
  { 
    $listLocalSessions: { 
      users: [{ user: "myAppReader", db: "test"}] 
    } 
  }
];
const cursor = db.aggregate(pipeline);
return cursor;

const pipeline = [{ $listLocalSessions: {} }];
const cursor = db.aggregate(pipeline);
return cursor;

出力

$listLocalSessions メモリにキャッシュされたセッションごとに 1 つのドキュメントを含むカーソルを返します。各ドキュメントには次のプロトタイプがあります。

{
   _id: {
      id: <UUID>,
      uid: <BinData>
   },
   lastUse: <date>
}