유효성 검사

정의

validate

validate 명령은 컬렉션의 데이터와 인덱스가 올바른지 검사하고 결과를 반환합니다.

팁

mongosh 에서 이 명령은 validate() 헬퍼 메서드를 통해서도 실행 수 있습니다.

헬퍼 메서드는 mongosh 사용자에게 편리하지만 데이터베이스 명령과 동일한 수준의 정보를 반환하지 못할 수 있습니다. 편의가 필요하지 않거나 추가 리턴 필드가 필요한 경우 데이터베이스 명령을 사용합니다.

버전 5.0에서 변경됨

버전 5.0부터 validate 명령은 컬렉션에서 불일치를 찾아서 가능한 경우 수정할 수도 있습니다.

인덱스 불일치에는 다음이 포함됩니다.

• 인덱스는 멀티키이지만 멀티키 필드는 없습니다.

• 인덱스에는 멀티키가 아닌 필드를 포함하는 MultiKeyPath가 있습니다.

• 인덱스에는 MultiKeyPath가 없지만 멀티키 문서가 있습니다. (3.4 이전에 빌드된 인덱스의 경우)

db.collection.validate() 명령으로 불일치가 감지되면 경고가 반환되고 인덱스의 복구 플래그가 true로 설정됩니다.

db.collection.validate()는 컬렉션의 스키마 유효성 검사 규칙을 위반하는 모든 문서의 유효성도 검사합니다.

참고

validate 명령은 뷰를 지원하지 않으며 뷰에 대해 실행할 때 오류가 발생합니다.

mongosh의 db.collection.validate() 메서드는 validate주위에 래퍼(wrapper)를 제공합니다.

호환성

이 명령은 다음 환경에서 호스팅되는 배포에서 사용할 수 있습니다.

• 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
} )

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

행동

예시

• 기본 유효성 검사 설정(특히 전체: false)을 사용하여 myCollection 컬렉션의 유효성을 검사합니다.

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

• 컬렉션 myCollection의 전체 유효성 검사를 수행하려면 full: true를 지정합니다.

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

• 컬렉션 myCollection을 복구하려면 repair: true를 지정합니다.

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

• myCollection 컬렉션 메타데이터의 유효성을 검사하려면 metadata: true를 지정합니다.

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

출력 유효성 검사

더 자세한 출력을 위해서는 full: true를 지정합니다.

validate.nInvalidDocuments

컬렉션 내의 유효하지 않은 문서 수입니다. 유효하지 않은 문서는 읽을 수 없는 문서로, BSON 문서가 손상되었거나 오류 또는 크기 불일치가 있음을 의미합니다.

비호환 문서는 컬렉션의 스키마를 준수하지 않는 문서입니다. 정책을 준수하지 않는 문서는 nInvalidDocuments 에서 유효하지 않은 것으로 계산되지 않습니다.

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입니다.