설명합니다.

정의

explain

explain 명령은 다음 명령의 실행에 대한 정보를 제공합니다. aggregate, count, distinct, find, findAndModify, delete, mapReduce, 및 update.

팁

mongosh에서 이 명령은 db.collection.explain() 및 cursor.explain() 헬퍼 메서드를 통해서도 실행할 수 있습니다.

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

참고

explain을 사용하면 기존의 모든 계획 캐시 항목이 무시되고 MongoDB 쿼리 플래너가 새 계획 캐시 항목을 만들 수 없습니다.

호환성

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

• MongoDB Atlas: 클라우드에서의 MongoDB 배포를 위한 완전 관리형 서비스

• MongoDB Enterprise: MongoDB의 구독 기반 자체 관리 버전

• MongoDB Community: MongoDB의 소스 사용 가능 무료 자체 관리 버전

필요한 액세스 권한

explain 을(를) 사용하려면 기본 명령을 실행 수 있는 권한이 있어야 합니다.

구문

명령은 다음과 같은 구문을 가집니다:

db.runCommand(
   {
     explain: <command>,
     verbosity: <string>,
     comment: <any>
   }
)

명령 필드

이 명령은 다음 필드를 사용합니다.

행동

출력

explain 작업은 다음과 관련된 정보를 반환할 수 있습니다.

• explainVersion, 출력 형식 버전(예시: "1").

• command설명 중인 명령에 대한 자세한 정보를 제공합니다.

• queryShapeHash는 MongoDB 8.0부터 시작되었으며 쿼리 형태의 해시를 포함하는 16진수 문자열입니다. 자세한 내용은 쿼리 형태, 쿼리 형태 해시 및 explain.queryShapeHash를 참조하세요.

• queryPlanner는 쿼리 옵티마이저가 선택한 계획을 설명하고 거부된 계획을 나열합니다.

• executionStats성공적인 계획과 거부된 계획의 실행을 자세히 설명합니다.

• serverInfo이는 MongoDB 인스턴스에 대한 정보를 제공합니다.

• serverParameters내부 매개변수를 자세히 설명합니다.

다변성 모드(예: queryPlanner, executionStats, allPlansExecution)는 결과에 executionStats를 포함되는지 여부와 executionStats에 요금제 선택 중 캡처한 데이터가 포함되는지 여부를 결정합니다.

Explain 출력은 BSON 문서의 최대 중첩 깊이(중첩 수준 100단계)로 제한됩니다. 한도를 초과하는 Explain 출력은 잘립니다.

출력에 대한 자세한 내용은 Explain 결과 항목을 참조하세요.

예시

db.runCommand(
   {
     explain: { count: "products", query: { quantity: { $gt: 50 } } },
     verbosity: "queryPlanner"
   }
)

db.runCommand(
   {
      explain: { count: "products", query: { quantity: { $gt: 50 } } },
      verbosity: "executionStats"
   }
)

db.runCommand(
   {
     explain: {
        update: "products",
        updates: [
           {
               q: { quantity: 1057, category: "apparel" },
               u: { $set: { reorder: true } }
           }
        ]
     }
   }
)