validate

定義

validate

validateコマンドは、コレクションのデータとインデックスを正確性を確認し、結果を返します。 コマンドをバックグラウンドで実行しない場合、 コマンドはコレクションのカウントとデータ サイズの不整合も修正します。

Tip

mongoshでは、このコマンドは validate()ヘルパー メソッドを通じて実行することもできます。

ヘルパー メソッドはmongoshユーザーには便利ですが、データベースコマンドと同じレベルの情報は返されない可能性があります。 便宜上必要ない場合、または追加の戻りフィールドが必要な場合は、 データベースコマンドを使用します。

バージョン 5.0 での変更。

バージョン5.0以降では、 validateコマンドでもコレクション内の不整合を見つけ、可能であれば修正することができます。

インデックスの不一致には、次のものが含まれます。

• インデックスはマルチキーですが、マルチキー フィールドはありません。

• インデックスには、マルチキーではないフィールドをカバーするmultikeyPathがあります。

• インデックスにmultikeyPathsはありませんが、マルチキー ドキュメントは存在します（ 3.4 以前にビルドされたインデックスの場合）。

db.collection.validate()コマンドによって不整合が検出された場合は、警告が返され、インデックスの修復フラグはtrueに設定されます。

db.collection.validate()は、コレクションのスキーマ検証ルールに違反するドキュメントも検証します。

注意

validateコマンドはビューをサポートしていないため、ビューに対して実行するとエラーが発生します。

db.collection.validate()validateのmongosh メソッドは を囲むラッパーを提供します。

互換性

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

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

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

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

構文

このコマンドの構文は、次のとおりです。

db.runCommand(
   {
     validate: <string>,  // Collection name
     full: <boolean>,  // Optional
     repair: <boolean>,  // Optional, added in MongoDB 5.0
     metadata: <boolean>,  // Optional, added in MongoDB 5.0.4
     checkBSONConformance: <boolean>  // Optional, added in MongoDB 6.2
     background: <boolean> // Optional
   }
)

コマンドフィールド

このコマンドは、次のフィールドを使用します。

db.runCommand( { collMod: <collectionName> } )

動作

例

• デフォルトの検証設定（具体的には、 full: false ）を使用してコレクションmyCollectionを検証するには次のようにします。

  db.runCommand( { validate: "myCollection" } )

• コレクションmyCollectionの完全な検証を実行するには、 full: trueを指定します。

  db.runCommand( { validate: "myCollection", full: true } )

• コレクションmyCollectionを修復するには、修復: trueを指定します。

  db.runCommand( { validate: "myCollection", repair: true } )

• myCollectionコレクション内のメタデータを検証するには、 metadata: trueを指定します。

  db.runCommand( { validate: "myCollection", metadata: true } )

• myCollectionで追加の BSON 準拠チェックを実行するには、 checkpointBSONConformance: trueを指定します。

  db.runCommand( { validate: "myCollection", checkBSONConformance: true } )

出力を検証する

より詳細な出力を行うには、 full: trueを指定します。

validate.uuid

コレクションの 汎用一意識別子（UUID） 。

バージョン 6.2 の新機能。

validate.nInvalidDocuments

コレクション内の 無効な ドキュメントの数。 無効なドキュメントとは、読み取れないドキュメントとはなります。つまり、 BSONドキュメントが破損しており、エラーまたはサイズが一致していないことを意味します。

validate.nNonCompliantDocuments

コレクションのスキーマに準拠していないドキュメントの数。 準拠していないドキュメントは、 nInvalidDocumentsでは無効としてカウントされません。

MongoDB 6.2 以降では、 nNonCompliantDocumentsにはBSONまたは時系列コレクションの要件に準拠していないドキュメントの数も含まれます。

validate.nrecords

コレクション内のドキュメントの数。

validate.nIndexes

検証されたコレクションのインデックスの数。

validate.keysPerIndex

コレクションの各インデックスの名前とインデックスエントリ数を含むドキュメント。

"keysPerIndex" : {
   "_id_" : <num>,
   "<index2_name>" : <num>,
   ...
}

keysPerIndex は、インデックスを名前のみで識別します。

validate.indexDetails

各インデックスのインデックス検証のステータスを含むドキュメント。

"indexDetails" : {
   "_id_" : {
      "valid" : <boolean>
   },
   "<index2_name>" : {
      "valid" : <boolean>
   },
   ...
}

• indexDetails は、無効な特定のインデックスを識別します。 MongoDB の以前のバージョンでは、いずれかのインデックスが無効な場合、すべてのインデックスが無効としてマークされていました。

• indexDetailsはインデックスを名前のみで識別します。 MongoDB の以前のバージョンでは、インデックスの完全な名前空間が表示されていました。つまり<db>.<collection>.$<index_name>です。

validate.ns

コレクションの完全な名前空間名。 名前空間には、データベース名とコレクション名がdatabase.collection形式で含まれます。

validate.valid

ブール値はvalidateがコレクションのすべての要素が有効であると判断した場合はtrueです。 falseの場合、詳細についてはerrorsフィールドを参照してください。

validate.repaired

ブール値はvalidateがコレクションを修復した場合はtrueになります。

validate.warnings

検証操作自体に関する警告メッセージ（存在する場合）を含む配列。 警告メッセージは、コレクション自体が無効であることを示すものではありません。 例:

"warnings" : [
   "Could not complete validation of table:collection-28-6471619540207520785. This is a transient issue as the collection was actively in use by other operations."
],

validate.errors

コレクションが有効でない場合（つまり、 validが false）、このフィールドには検証エラーを説明するメッセージが含まれます。

validate.extraIndexEntries

コレクションに存在しないドキュメントを指す各インデックスエントリの情報を含む配列。

"extraIndexEntries" : [
   {
      "indexName" : <string>,
      "recordId" : <NumberLong>,  // for the non-existent document
      "indexKey" : {
         "<key1>" : <value>,
         ...
      }
   }
   ...
]

注意

extraIndexEntries配列の場合、すべてのindexKeyフィールド サイズの合計は1 MB の制限であり、サイズにはindexKeyのキーと値の両方が含まれます。 合計がこのサイズを超えると、警告フィールドにメッセージが表示されます。

validate.missingIndexEntries

対応するインデックスエントリが欠落している各ドキュメントの情報を含む配列。

"missingIndexEntries" : [
   {
      "indexName" : <string>,
      "recordId" : <NumberLong>,
      "idKey" : <_id key value>,     // The _id value of the document. Only present if an ``_id`` index exists.
      "indexKey" : {                 // The missing index entry
         "<key1>" : <value>,
         ...
      }
   }
   ...
 ]

注意

missingIndexEntries配列の場合、 idKeyフィールド サイズとそのすべてのindexKeyフィールド サイズの合計は1 MB の制限があり、フィールド サイズにはidKeyとindexKeyのキーと値の両方が含まれます。 . 合計がこのサイズを超えると、警告フィールドにメッセージが表示されます。

validate.corruptRecords

データが破損している可能性があり、読み取りできないドキュメントのRecordId値の配列。 これらのドキュメントは検証中に破損しているとして報告されます。 RecordIdは、コレクション内のドキュメントを一意に識別する 64 ビットの整数内部キーです。

"corruptRecords" : [
   NumberLong(1),  // RecordId 1
   NumberLong(2)   // RecordId 2
]

バージョン 5.0 で追加

validate.ok

コマンドが成功した場合の値1を持つ整数。 コマンドが失敗した場合、 okフィールドの値は0になります。