반환할 필드 지정
개요
이 가이드에서는 프로젝션 을 사용하여 읽기 작업에서 반환할 필드를 지정하는 방법을 배울 수 있습니다. 프로젝션은 MongoDB가 쿼리에서 반환하는 필드를 지정하는 문서입니다.
샘플 데이터
이 가이드 의 예제에서는 Atlas 샘플 데이터 세트 의 sample_restaurants
데이터베이스 에 있는 restaurants
컬렉션 을 사용합니다. 무료 MongoDB Atlas cluster 를 생성하고 샘플 데이터 세트를 로드하는 방법을 학습 보려면 Atlas 시작하기 가이드 를 참조하세요.
이 컬렉션 의 문서는 다음 코틀린 (Kotlin) 데이터 클래스에 따라 모델링됩니다.
data class Restaurant( val id: ObjectId? = null, val name: String, val borough: String, val cuisine: String )
프로젝션 유형
프로젝션 을 사용하여 반환 문서 에 포함할 필드를 지정하거나 제외할 필드를 지정할 수 있습니다.
프로젝션 에 포함할 특정 필드를 지정할 때 다른 모든 필드는 암시적으로 제외됩니다( 기본값 포함되는 _id
필드 제외). _id
필드 를 제외하지 않는 한 단일 프로젝션 에서 포함 및 제외 문을 결합할 수 없습니다.
반환 문서 에서 _id
필드 를 제거 하려면 해당 필드를 명시적으로 제외해야 합니다.
포함할 필드 지정
다음 구문을 사용하여 결과에 포함할 필드를 지정합니다.
val projection = Projection.fields( Projections.include(<fieldName1>, <fieldName2>, ...) )
다음 예시 에서는 find()
메서드를 사용하여 name
필드 값이 "Emerald Pub"
인 모든 레스토랑을 찾습니다. 그런 다음 프로젝션 을 사용하여 반환된 문서의 name
, cuisine
및 borough
필드만 반환합니다.
val projection = Projections.fields( Projections.include( Restaurant::name.name, Restaurant::cuisine.name, Restaurant::borough.name ) ) val results = collection .find(eq(Restaurant::name.name, "Emerald Pub")) .projection(projection) results.forEach { result -> println(result) }
Restaurant(id=5eb3d668b31de5d588f429e2, name=Emerald Pub, borough=Manhattan, cuisine=American) Restaurant(id=5eb3d668b31de5d588f432dd, name=Emerald Pub, borough=Queens, cuisine=American)
필드 제외 _id
포함할 필드를 지정할 때 반환된 문서에서 _id
필드를 제외할 수도 있습니다.
다음 예시 에서는 앞의 예시 와 동일한 쿼리 를 실행하지만 프로젝션 에서 _id
필드 를 제외합니다.
val projection = Projections.fields( Projections.excludeId(), Projections.include( Restaurant::name.name, Restaurant::cuisine.name, Restaurant::borough.name ) ) val results = collection .find(eq(Restaurant::name.name, "Emerald Pub")) .projection(projection) results.forEach { result -> println(result) }
Restaurant(id=null, name=Emerald Pub, borough=Manhattan, cuisine=American) Restaurant(id=null, name=Emerald Pub, borough=Queens, cuisine=American)
추가 정보
프로젝션에 대해 자세히 알아보려면 MongoDB Server 매뉴얼의 프로젝트 필드 가이드 를 참조하세요.
API 문서
이 가이드에서 설명하는 메서드나 유형에 대해 자세히 알아보려면 다음 API 설명서를 참조하세요.