Docs Menu

db.collection.checkMetadataConsistency()

db.collection.checkMetadataConsistency(options)

Performs a series of consistency checks on sharding metadata for the collection. The method returns a cursor with either all or a batch of the inconsistency results found.

重要

mongosh メソッド

このページでは、mongosh メソッドについて記載しています。ただし、データベースコマンドや Node.js などの言語固有のドライバーのドキュメントには該当しません

データベースコマンドについては、checkMetadataConsistency コマンドを参照してください。

MongoDB API ドライバーについては、各言語の MongoDB ドライバー ドキュメントを参照してください。

Run this method after major maintenance operations, such as upgrades and downgrades, to check the state of the catalog.

デフォルトでは、 メソッドはシャード間での整合性についてインデックスをチェックしません。 インデックス チェックは、インデックスを作成、削除、または変更する操作と同時に実行されると、誤検知の不整合を返す可能性があります。 この方法でインデックスを確認するには、 checkIndexesオプションを設定します。

このメソッドがチェックする不整合について詳しくは、「不整合のタイプ 」を参照してください。

次の値を返します。このメソッドは、シャーディング メタデータで見つかった各不整合に対応するドキュメントを含むdocuments配列を持つカーソルを返します。

このメソッドは、次の環境でホストされている配置で使用できます。

  • MongoDB Atlas はクラウドでの MongoDB 配置のためのフルマネージド サービスです

重要

このコマンドは、M0、M2、M5、および Flex クラスターではサポートされていません。詳細については、「 サポートされていないコマンド 」を参照してください。

  • MongoDB Enterprise: サブスクリプションベースの自己管理型 MongoDB バージョン

  • MongoDB Community: ソースが利用可能で、無料で使用できる自己管理型の MongoDB のバージョン

注意

checkMetadataConsistencyヘルパーは、mongos に接続しているときにのみ実行できます。 mongod はこのメソッドをサポートしていません。

db.collection.checkMetadataConsistency()メソッドの構文は次のとおりです。

db.collection.checkMetadataConsistency( { <options> } )

optionsドキュメントは、次のフィールドと値を取ることができます。

フィールド
タイプ
説明

checkIndexes

ブール値

コマンドがシャーディング メタデータのインデックスもチェックするかどうかを設定します。

デフォルトでは、この操作は無効になっています。これは、インデックスを作成、削除、または変更する操作と同時に実行されると、誤検知によって不整合が返される可能性があるためです。 これらの操作が発生する可能性が低いことがわかっている場合にのみ、インデックスをチェックしてください。

cursor

ドキュメント

リターンカーソル を構成します。

cursor.batchSize

integer

各バッチに含めるシャーディング メタデータの不整合ドキュメントの最大数。

db.authors.checkMetadataConsistency()
{
cursorHasMore: false,
documents: [
{
type: "MisplacedCollection",
description: "Unsharded collection found on shard different from database primary shard",
details: {
namespace: "test.authors",
shard: "shard02",
localUUID: new UUID("1ad56770-61e2-48e9-83c6-8ecefe73cfc4")
}
}
],
}