Especifica qué campos se deben devolver

Overview

En esta guía, puedes aprender a controlar qué campos aparecen en los documentos devueltos por operaciones de lectura con el controlador MongoDB Kotlin.

Muchas solicitudes de lectura requieren solo un subconjunto de campos en un documento. Por ejemplo, al iniciar sesión en un usuario, solo es posible que necesites el nombre de usuario y no toda la información del perfil. Por defecto, las consultas en MongoDB devuelven todos los campos en los documentos coincidentes. Puedes usar una proyección para mostrar solo los datos que necesites.

Una proyección es un documento que indica a MongoDB qué campos de un documento se deben devolver. Usa la Proyecciones clase para construir un documento de proyección.

Comportamiento

Las proyecciones funcionan de dos maneras:

• Inclusión explícita de campos. Esto tiene el efecto secundario de excluir implícitamente todos los campos no especificados.

• Excluir implícitamente campos. Esto tiene como efecto secundario incluir implícitamente todos los campos no especificados.

Estos dos métodos de proyección son mutuamente excluyentes: si incluyes explícitamente campos, no puedes excluir explícitamente campos y viceversa.

Explicación

Considere la siguiente colección que contiene documentos que describen variedades de frutas:

{ "_id": 1, "name": "apples", "qty": 5, "rating": 3 },
{ "_id": 2, "name": "bananas", "qty": 7, "rating": 1 },
{ "_id": 3, "name": "oranges", "qty": 6, "rating": 2 },
{ "_id": 4, "name": "avocados", "qty": 3, "rating": 5 },

Estos datos se modelan utilizando la siguiente clase de datos Kotlin:

data class Fruit(
    @BsonId val id: Int,
    val name: String,
    val qty: Int,
    val rating: Int
)

En la siguiente query, pasa la proyección para devolver el campo name de cada documento. Los resultados se modelan usando la clase de datos de Kotlin FruitName:

data class FruitName(
    @BsonId val id: Int? = null,
    val name: String
)
// Return all documents with only the name field
val filter = Filters.empty()
val projection = Projections.fields(
    Projections.include(FruitName::name.name)
)
val flowResults = collection.find<FruitName>(filter).projection(projection)
flowResults.collect { println(it)}

FruitName(id=1, name=apples),
FruitName(id=2, name=bananas),
FruitName(id=3, name=oranges),
FruitName(id=4, name=avocados)

El documento de proyección especifica que el resultado de la operación de lectura debe incluir el campo name de cada documento devuelto. Como resultado, esta proyección excluye implícitamente los campos qty y rating. Encadenar esta proyección a find() con un filtro de query vacío arroja los resultados anteriores.

Aunque esta proyección solo incluía explícitamente el campo name, la query también devolvió el campo _id, representado por id en la clase de datos.

El campo _id es un caso especial: siempre se incluye en cada resultado de query a menos que se excluya explícitamente. Esto se debe a que el campo _id es un identificador único para cada documento, una propiedad que puede ser útil al construir query.

La _id es la única excepción al comportamiento mutuamente excluyente de inclusión-exclusión en las proyecciones: se puede excluir explícitamente el campo _id incluso cuando se incluyen explícitamente otros campos si no se desea que _id esté presente en los documentos devueltos.

data class FruitName(
    @BsonId val id: Int? = null,
    val name: String
)
// Return all documents with *only* the name field
// excludes the id
val filter = Filters.empty()
val projection = Projections.fields(
    Projections.include(FruitName::name.name),
    Projections.excludeId()
)
val flowResults = collection.find<FruitName>(filter).projection(projection)
flowResults.collect { println(it)}

FruitName(name=apples),
FruitName(name=bananas),
FruitName(name=oranges),
FruitName(name=avocados)

El documento de proyección especifica que el resultado de la operación de lectura debe incluir el campo name de cada documento devuelto, y especifica excluir el campo _id. Como resultado, esta proyección excluye implícitamente los campos qty y rating. Encadenar esta proyección a find() con un filtro de query vacío arroja los resultados anteriores.

También puedes especificar múltiples campos para incluir en tu proyección.

Este ejemplo, que identifica dos campos para incluir en la proyección, arroja los siguientes resultados utilizando la clase de datos Kotlin FruitRating:

data class FruitRating(
    val name: String,
    val rating: Int
)
val filter = Filters.empty()
val projection = Projections.fields(
    Projections.include(FruitRating::name.name, FruitRating::rating.name),
    Projections.excludeId()
)
val flowResults = collection.find<FruitRating>(filter).projection(projection)
flowResults.collect { println(it)}

FruitRating(name=apples, rating=3),
FruitRating(name=bananas, rating=1),
FruitRating(name=oranges, rating=2),
FruitRating(name=avocados, rating=5)

Para ejemplos adicionales de proyección, consulta el Página del manual de MongoDB sobre los campos de proyecto que se devolverán en la query.