db.collection.explain()
드라이버가 포함된 MongoDB
이 페이지에서는 mongosh
메서드를 설명합니다. MongoDB 드라이버에서 해당 메서드를 보려면 프로그래밍 언어의 해당 페이지를 참조하세요.
설명
db.collection.explain()
다음 메서드에 대한 쿼리 계획 정보를 반환합니다.
mapReduce()
에 대한 정보를 반환합니다.db.collection.explain()
을 사용하려면db.collection.explain()
에 앞서 언급한 메서드 중 하나를 추가합니다.db.collection.explain().<method(...)> 예를 들면 다음과 같습니다.
db.products.explain().remove( { category: "apparel" }, { justOne: true } ) 더 많은 예는 예시를 참조하세요. db.collection.explain().help()도 참조하세요.
db.collection.explain()
메서드에는 다음과 같은 매개변수가 있습니다.Parameter유형설명verbosity
문자열선택 사항. 설명 출력의 상세도 모드를 지정합니다. 모드는
explain()
의 동작에 영향을 미치고 반환할 정보의 양을 결정합니다. 가능한 모드는 다음과 같습니다."queryPlanner"
(기본값)"executionStats"
"allPlansExecution"
cursor.explain()
의 이전 버전과의 하위 호환성을 위해 MongoDB는true
를"allPlansExecution"
으로,false
를"queryPlanner"
로 해석합니다.자세한 내용은 상세도 모드에서 확인하세요.
호환성
이 메서드는 다음 환경에서 호스팅되는 배포에서 사용할 수 있습니다.
MongoDB Atlas: 클라우드에서의 MongoDB 배포를 위한 완전 관리형 서비스
참고
이 명령은 모든 MongoDB Atlas 클러스터에서 지원됩니다. 모든 명령에 대한 Atlas 지원에 관해 자세히 알아보려면 지원되지 않는 명령을 참조하십시오.
MongoDB Enterprise: MongoDB의 구독 기반 자체 관리 버전
MongoDB Community: MongoDB의 소스 사용 가능 무료 자체 관리 버전
행동
참고
explain
을 사용하면 기존의 모든 계획 캐시 항목이 무시되고 MongoDB 쿼리 플래너가 새 계획 캐시 항목을 만들 수 없습니다.
상세도 모드
db.collection.explain()
의 동작과 반환되는 정보의 양은 verbosity
모드에 따라 달라집니다.
기본적으로 db.collection.explain()
은 queryPlanner
다변성 모드에서 실행됩니다.
MongoDB는 쿼리 옵티마이저를 실행하여 평가 중인 작업에 가장 적합한 계획을 선택합니다. db.collection.explain()
은 평가된 메서드에 대한 queryPlanner
정보를 반환합니다.
MongoDB는 쿼리 옵티마이저를 실행하여 성공적인 계획을 선택하고, 성공적인 계획을 완료할 때까지 실행하고, 성공적인 계획의 실행을 설명하는 통계를 반환합니다.
쓰기 작업의 경우 db.collection.explain()
은 수행될 업데이트 또는 삭제 작업에 대한 정보를 반환하지만 실제로 데이터베이스에 변경을 적용하지는 않습니다.
db.collection.explain()
은 평가된 메서드에 대한 queryPlanner
및 executionStats
정보를 반환합니다. 그러나 executionStats
는 거부된 계획에 대한 쿼리 실행 정보는 제공하지 않습니다.
MongoDB는 쿼리 옵티마이저를 실행하여 가장 적합한 계획을 선택하고 이를 실행하여 완료합니다. "allPlansExecution"
모드에서 MongoDB는 계획 선택 중에 캡처된 다른 후보 계획에 관한 통계뿐만 아니라 가장 적합한 계획의 실행을 설명하는 통계를 반환합니다.
쓰기 작업의 경우 db.collection.explain()
은 수행될 업데이트 또는 삭제 작업에 대한 정보를 반환하지만 실제로 데이터베이스에 변경을 적용하지는 않습니다.
db.collection.explain()
은 평가된 메서드에 대한 queryPlanner
및 executionStats
정보를 반환합니다. executionStats
에는 성공 계획의 완료된 쿼리 실행 정보가 포함됩니다.
쿼리 옵티마이저가 둘 이상의 계획을 고려한 경우, executionStats
정보에는 채택된 계획과 거부된 후보 계획 모두에 관하여 계획 선택 단계에서 캡처된 부분 실행 정보도 포함됩니다.
설명 및 쓰기 작업
쓰기 작업의 경우 db.collection.explain()
은 수행될 쓰기 작업에 대한 정보를 반환하지만 실제로 데이터베이스를 수정하지는 않습니다.
제한 사항
$out
단계가 포함된 aggregation pipeline
에 대해 executionStats
모드 또는 allPlansExecution
모드에서 explain
명령/db.collection.explain()
을 실행할 수 없습니다. 대신 다음 중 하나를 실행할 수 있습니다.
explain()
메커니즘
db.collection.explain()
메서드는 explain
명령을 래핑하며 explain
을 실행하는 데 선호되는 방법입니다.
db.collection.explain().find()
은 db.collection.find().explain()
과 유사하지만 다음과 같은 주요 차이점이 있습니다.
db.collection.explain().find()
구문을 사용하면 쿼리 수정자를 추가로 연결할 수 있습니다. 쿼리 수정자 목록은 db.collection.explain().find().help()를 참조하세요.db.collection.find().explain()
은 커서를 반환하며,.next()
또는 그 별칭.finish()
를 호출해야explain()
결과를 반환할 수 있습니다.mongosh
에서 대화형으로 실행하는 경우mongosh
는 자동으로.finish()
를 호출하여 결과를 반환합니다. 그러나 스크립트의 경우 결과를 반환하려면.next()
또는.finish()
를 명시적으로 호출해야 합니다. 커서 관련 메서드 목록은 db.collection.explain().find().help()를 참조하세요.
db.collection.explain().aggregate()
는 db.collection.aggregate()
메서드에 설명 옵션을 전달하는 것과 같습니다.
help()
db.collection.explain()
에서 지원하는 작업 목록을 보려면 다음을 실행합니다.
db.collection.explain().help()
db.collection.explain().find()
는 쿼리 수정자를 연결할 수 있는 커서를 반환합니다. db.collection.explain().find()
에서 지원되는 쿼리 수정자 목록과 커서 관련 메서드를 보려면 다음을 실행합니다.
db.collection.explain().find().help()
여러 개의 수정자를 db.collection.explain().find()
에 연결할 수 있습니다. 예를 들어 수정자를 사용한 find()
설명을 참조하세요.
출력
db.collection.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 결과 항목을 참조하세요.
예시
queryPlanner
모드
기본적으로 db.collection.explain()
은 "queryPlanner"
다변성 모드에서 실행됩니다.
다음 예시에서는 "queryPlanner"
상세도 모드에서 db.collection.explain()
을 실행하여 지정된 count()
작업에 대한 쿼리 계획 정보를 반환합니다.
db.products.explain().count( { quantity: { $gt: 50 } } )
executionStats
모드
다음 예시에서는 "executionStats"
상세도 모드에서 db.collection.explain()
을 실행하여 지정된 find()
작업에 대한 쿼리 계획 및 실행 정보를 반환합니다.
db.products.explain("executionStats").find( { quantity: { $gt: 50 }, category: "apparel" } )
allPlansExecution
모드
다음 예시는 "allPlansExecution"
상세 모드에서 db.collection.explain()
을 실행합니다. db.collection.explain()
은 지정된 findAndModify()
작업에 고려된 모든 계획에 대한 queryPlanner
및 executionStats
를 반환합니다.
참고
이 explain을 실행하면 데이터가 수정되지 않지만 업데이트 작업의 쿼리 술어가 실행됩니다. 후보 계획의 경우, MongoDB는 계획 선택 단계에서 캡처한 실행 정보를 반환합니다.
db.products.explain( "allPlansExecution" ).findAndModify( { query: { name: "Tom", state: "active", rating: { $gt: 10 } }, sort: { rating: 1 }, update: { $inc: { score: 1 } } } )
수정자를 find()
사용하여 설명
db.collection.explain().find()
구문을 사용하면 쿼리 수정자를 연결할 수 있습니다. 예를 들어 다음 연산은 sort()
및 hint()
쿼리 수정자가 있는 find()
메서드에 대한 정보를 제공합니다.
db.products.explain("executionStats").find( { quantity: { $gt: 50 }, category: "apparel" } ).sort( { quantity: -1 } ).hint( { category: 1, quantity: -1 } )
사용 가능한 쿼리 수정자 목록을 보려면 mongosh
에서 다음을 실행하세요.
db.collection.explain().find().help()
explain().find()
반환 커서 반복
db.collection.explain().find()
는 설명 결과로 커서를 반환합니다. mongosh
에서 대화형으로 실행하는 경우 mongosh
는 .next()
메서드를 사용하여 커서를 자동으로 반복합니다. 그러나 스크립트의 경우 결과를 반환하려면 .next()
(또는 그 별칭 .finish()
)를 명시적으로 호출해야 합니다.
var explainResult = db.products.explain().find( { category: "apparel" } ).next();