/ /

Especifique los campos a devolver

Overview

En esta guía, se puede aprender cómo especificar qué campos devolver de una operación de lectura utilizando una proyección. Una proyección es un documento que especifica qué campos devuelve MongoDB de una query.

Datos de muestra

Los ejemplos de esta guía utilizan la colección restaurants en la base de datos sample_restaurants de los conjuntos de datos de muestra de Atlas. Para aprender cómo crear una implementación gratuita de MongoDB y cargar los conjuntos de datos de muestra, consulta la guía de MongoDB Comenzar.

Los documentos de esta colección están modelados por la siguiente clase de datos Kotlin:

data class Restaurant(
    @BsonId
    val id: ObjectId? = null,
    val name: String,
    val borough: String,
    val cuisine: String
)

Tipos de proyección

Puedes usar una proyección para especificar qué campos incluir en un documento de retorno o para especificar qué campos excluir.

Cuando se especifican ciertos campos para incluir en una proyección, todos los demás campos se excluyen implícitamente (excepto el campo _id, que se incluye por defecto). No se pueden combinar instrucciones de inclusión y exclusión en una sola proyección, a menos que se esté excluyendo el campo _id.

Para remover el campo _id del documento devuelto, debes excluirlo explícitamente.

Especifica los campos que deseas incluir

Utiliza la siguiente sintaxis para especificar los campos que deseas incluir en el resultado:

val projection = Projection.fields(
    Projections.include(<fieldName1>, <fieldName2>, ...)
)

El siguiente ejemplo utiliza el método find() para localizar todos los restaurantes con el valor del campo name igual a "Emerald Pub". Luego utiliza una proyección para devolver únicamente los campos name, cuisine y borough de los documentos devueltos.

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)

Excluir el campo `_id`

Al especificar los campos a incluir, también puedes excluir el campo _id del documento devuelto.

El siguiente ejemplo ejecuta la misma query que el ejemplo anterior, pero excluye el campo _id de la proyección:

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)

Información Adicional

Para obtener más información sobre proyecciones, consulta la Guía de campos de proyecto en el Manual del Servidor de MongoDB.

Documentación de la API

Para obtener más información sobre cualquiera de los métodos o tipos discutidos en esta guía, consultar la siguiente documentación de la API:

Volver

Especifica los documentos a devolver

Especifica un query