$listLocalSessions（集計ステージ）

定義

$listLocalSessions

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

重要

When a user creates a session on a mongod or mongos instance, the record of the session initially exists only in-memory on the instance; i.e. the record is local to the instance. Periodically, the instance will sync its cached sessions to the system.sessions collection in the config database, at which time, they are visible to $listSessions and all members of the deployment. Until the session record exists in the system.sessions collection, you can only list the session via the $listLocalSessions operation.

The $listLocalSessions operation uses the db.aggregate() method and not the db.collection.aggregate().

To run $listLocalSessions, it must be the first stage in the pipeline.

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

{ $listLocalSessions: <document> }

The $listLocalSessions stage takes a document with one of the following contents:

フィールド	説明
{ }	アクセス制御を使用して実行している場合、 は現在認証されているユーザーのすべてのセッションを返します。 アクセス制御なしで実行している場合、 はすべてのセッションを返します。
{ 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>
}