`rename` イベント

項目一覧

概要

説明
動作
拡張イベント情報
例

概要

rename: コレクションの名前が変更されると、 renameイベントが発生します。

説明

フィールド

タイプ

説明

_id

ドキュメント

変更ストリームイベントの識別子として機能する BSONオブジェクト。この値は、変更ストリームを再開するときに、 resumeAfterパラメータのresumeTokenとして使用されます。 _idオブジェクトの形式は次のとおりです。

{
   "_data" : <BinData|hex string>
}

_dataタイプは、変更ストリームの開始時または再開時にMongoDBのバージョン、および場合によっては機能の互換性バージョン（FCV）によって異なります。 _dataタイプの完全なリストについては、「再開トークン」を参照してください。

resumeTokenによる変更ストリームの再開の例については、「変更ストリームの再開」を参照してください。

clusterTime

タイムスタンプ

clusterTime は、イベントに関連付けられたoplogエントリからのタイムスタンプです。

oplogのサイズ制限により、マルチドキュメントトランザクションでは複数のoplogエントリが作成される場合があります。トランザクションでは、特定のoplogエントリでステージされた変更ストリームイベントは同じclusterTime を共有します。

シャーディングされたクラスターでは、同じclusterTimeを持つイベントがすべて同じトランザクションに関連付けられない場合があります。一部のイベントはトランザクションにまったく関連しません。

単一のトランザクションのイベントを識別するには、変更ストリームイベントドキュメントでlsidとtxnNumberの組み合わせを使用できます。

collectionUUID

UUID

変更が発生したコレクションを識別するUUID 。

バージョン 6.0 で追加。

lsid

ドキュメント

トランザクションに関連付けられたセッションの識別子。

操作がマルチドキュメントトランザクションの一部である場合にのみ存在します。

ns

ドキュメント

イベントの影響を受ける名前空間（データベースとまたはコレクション）。

ns.db

string

イベントが発生したデータベースの名前。

ns.coll

string

イベントが発生したコレクションの名前。

operationDescription

ドキュメント

変更操作に関する追加情報。

このドキュメントとそのサブフィールドは、変更ストリームが展開されたイベントを使用する場合にのみ表示されます。

バージョン 6.0 で追加。

operationDescription.

dropTarget

UUID

名前変更操作で削除されたコレクションのUUID 。

バージョン 6.0 で追加。

operationDescription.

to

ドキュメント

名前変更後のコレクションの新しい名前空間。

バージョン 6.0 で追加。

operationDescription.

to.coll

ドキュメント

名前変更後のコレクションの新しい名前。

バージョン 6.0 で追加。

operationDescription.

to.db

ドキュメント

名前変更後のデータベースの新しい名前。

バージョン 6.0 で追加。

operationType

string

変更通知が報告する操作のタイプ。

これらの変更イベントのrenameの値を返します。

to

ドキュメント

名前変更後のコレクションの新しい名前空間。

to.coll

ドキュメント

名前変更後のコレクションの新しい名前。

to.db

ドキュメント

名前変更後のデータベースの新しい名前。

txnNumber

NumberLong

トランザクションを一意に識別するのに役立つ数値は、 lsid と合わせて使用されます。

操作がマルチドキュメントトランザクションの一部である場合にのみ存在します。

wallTime

ISODate

データベースの操作のサーバー日付と時刻。 wallTimeclusterTimeclusterTimeはと異なり、はデータベース操作イベントに関連付けられた oplog エントリから取得されたタイムスタンプであるため、

バージョン 6.0 で追加。

動作

拡張イベント情報

バージョン 6.0 での変更。

MongoDB 6.0 以降では、変更ストリームでshowExpandedEventsオプションがtrueに設定されている場合、 renameイベントにoperationDescriptionドキュメントが含まれます。このドキュメントには、変更されたデータベースとコレクションを示すtoフィールドと、名前変更前にrename操作によってコレクションが削除されたかどうかを示すdropTargetフィールドがあります。

例

次の例では、 renameイベントを示しています。

{
   "_id": { <Resume Token> },
   "operationType": "rename",
   "clusterTime": <Timestamp>,
   "wallTime": <ISODate>,
   "ns": {
      "db": "engineering",
      "coll": "users"
   },
   "to": {
      "db": "engineering",
      "coll": "people"
   },
   "operationDescription": {
      "to": {
         "db": "engineering",
         "coll": "people"
      }
   }
}

renameイベントは、 nsコレクションまたはtoコレクションに対して開かれた変更ストリームの無効化イベントにつながります。

戻る

refineCollectionShardKey

replace