Documentos

Overview

En esta guía, puede aprender a utilizar documentos en el controlador MongoDB Kotlin.

Un documento de MongoDB es una estructura de datos que contiene campos clave-valor en formato JSON binario (BSON). Puedes usar documentos y los datos que contienen en sus campos para almacenar datos y para ejecutar comandos o consultas en MongoDB.

Para obtener más información sobre la terminología, la estructura y las limitaciones de los documentos, lea nuestra página sobre Documentos en el manual de MongoDB.

El controlador MongoDB Kotlin y la biblioteca BSON incluyen las siguientes clases que le ayudan a acceder y manipular los datos BSON en los documentos:

Si bien puede usar cualquiera de estas clases en su aplicación, le recomendamos usar la clase Document, ya que puede representar de forma concisa documentos con estructura dinámica de cualquier complejidad. Implementa la interfaz Map<String, Object>, lo que le permite usar valores de tipo flexible.

Documento

La clase Document ofrece una representación flexible de un documento BSON. Con esta clase, puede acceder y manipular campos utilizando tipos Kotlin de la biblioteca estándar. Consulte la siguiente tabla para ver las asignaciones entre los tipos BSON y Kotlin más utilizados:

En el siguiente fragmento de código, mostramos cómo crear y crear una instancia de muestra Document que representa un documento que contiene varios tipos de campos diferentes:

val author = Document("_id", ObjectId())
    .append("name", "Gabriel García Márquez")
    .append(
        "dateOfDeath",
        LocalDateTime.of(2014, 4, 17, 4, 0)
    )
    .append(
        "novels", listOf(
            Document("title", "One Hundred Years of Solitude").append("yearPublished", 1967),
            Document("title", "Chronicle of a Death Foretold").append("yearPublished", 1981),
            Document("title", "Love in the Time of Cholera").append("yearPublished", 1985)
        )
    )

Para insertar este documento en una colección, cree una instancia de una colección usando el método getCollection() y llame al método Insertar una operación como la siguiente:

// val mongoClient = <code to instantiate your client>
val database = mongoClient.getDatabase("fundamentals_data")
val collection = database.getCollection<Document>("authors")
val result = collection.insertOne(author)

Una vez que realice una inserción exitosa, puede recuperar los datos del documento de muestra de la colección utilizando el siguiente código:

val doc = collection.find(Filters.eq("name", "Gabriel García Márquez")).firstOrNull()
doc?.let {
    println("_id: ${it.getObjectId("_id")}, name: ${it.getString("name")}, dateOfDeath: ${it.getDate("dateOfDeath")}")
    it.getList("novels", Document::class.java).forEach { novel ->
        println("title: ${novel.getString("title")}, yearPublished: ${novel.getInteger("yearPublished")}")
    }
}

_id: 5fb5fad05f734e3794741a35, name: Gabriel García Márquez, dateOfDeath: Thu Apr 17 00:00:00 EDT 2014
title: One Hundred Years of Solitude, yearPublished: 1967
title: Chronicle of a Death Foretold, yearPublished: 1981
title: Love in the Time of Cholera, yearPublished: 1985

Para obtener más información sobre cómo recuperar y manipular datos de MongoDB, consulte nuestra guía CRUD.

Para obtener más información sobre los métodos y clases mencionados en esta sección, consulte la siguiente documentación de API:

• Documento

• getCollection()

• conseguir()

Documento Bson

La clase BsonDocument proporciona una API con seguridad de tipos para acceder y manipular un documento BSON. Debe especificar el tipo BSON de la biblioteca BSON para cada campo. Consulte la siguiente tabla para ver las asignaciones entre los tipos BSON y los tipos de la biblioteca BSON más utilizados:

En el siguiente fragmento de código, mostramos cómo crear y crear una instancia de muestra BsonDocument que representa un documento que contiene varios tipos de campos diferentes:

val author = BsonDocument()
    .append("_id", BsonObjectId())
    .append("name", BsonString("Gabriel García Márquez"))
    .append(
        "dateOfDeath",
        BsonDateTime(
            LocalDateTime.of(2014, 4, 17, 0, 0).atZone(ZoneId.of("America/New_York")).toInstant().toEpochMilli()
        )
    )
    .append(
        "novels", BsonArray(
            listOf(
                BsonDocument().append("title", BsonString("One Hundred Years of Solitude"))
                    .append("yearPublished", BsonInt32(1967)),
                BsonDocument().append("title", BsonString("Chronicle of a Death Foretold"))
                    .append("yearPublished", BsonInt32(1981)),
                BsonDocument().append("title", BsonString("Love in the Time of Cholera"))
                    .append("yearPublished", BsonInt32(1985))
            )
        )
    )

Para insertar este documento en una colección, instancia una colección utilizando el método getCollection() especificando la clase BsonDocument como el parámetro documentClass. Luego, llama a la operación insertOne de la siguiente manera:

// val mongoClient = <code to instantiate your client>
val database = mongoClient.getDatabase("fundamentals_data")
val collection = database.getCollection<BsonDocument>("authors")
val result: InsertOneResult = collection.insertOne(author)

Una vez que realice una inserción exitosa, puede recuperar los datos del documento de muestra de la colección utilizando el siguiente código:

// <MongoCollection setup code here>
val doc = collection.find(Filters.eq("name", "Gabriel García Márquez")).firstOrNull()
doc?.let {
    println("_id: ${it.getObjectId("_id").value}, name: ${it.getString("name").value}, dateOfDeath: ${Instant.ofEpochMilli(it.getDateTime("dateOfDeath").value).atZone(ZoneId.of("America/New_York")).toLocalDateTime()}")
    it.getArray("novels").forEach { novel ->
        val novelDocument = novel.asDocument()
        println("title: ${novelDocument.getString("title").value}, yearPublished: ${novelDocument.getInt32("yearPublished").value}")
    }
}

_id: 5fb5fad05f734e3794741a35, name: Gabriel García Márquez, dateOfDeath: 2014-04-17T00:00
title: One Hundred Years of Solitude, yearPublished: 1967
title: Chronicle of a Death Foretold, yearPublished: 1981
title: Love in the Time of Cholera, yearPublished: 1985

Para obtener más información sobre los métodos y clases mencionados en esta sección, consulte la siguiente documentación de API:

• Documento Bson

• getCollection()

• BsonInvalidOperationException

• conseguir()

• Valor de Bson

JsonObject

La clase JsonObject actúa como contenedor de cadenas JSON. Si solo desea trabajar con datos JSON, puede usar JsonObject para evitar la conversión innecesaria de datos a un objeto Map.

De forma predeterminada, JsonObject almacena JSON extendido. Puede personalizar el formato de JSON en JsonObject especificando un JsonObjectCodec y pasándole un JsonWriterSettings objeto. Para obtener más información sobre los formatos JSON, consulte nuestra guía de JSON extendido.

En el siguiente fragmento de código, mostramos cómo crear una instancia de muestra JsonObject que envuelva una cadena JSON extendida que contenga diferentes tipos de pares clave-valor:

val ejsonStr = """
    {"_id": {"${"$"}oid": "6035210f35bd203721c3eab8"},
    "name": "Gabriel García Márquez",
    "dateOfDeath": {"${"$"}date": "2014-04-17T04:00:00Z"},
    "novels": [
        {"title": "One Hundred Years of Solitude","yearPublished": 1967},
        {"title": "Chronicle of a Death Foretold","yearPublished": 1981},
        {"title": "Love in the Time of Cholera","yearPublished": 1985}]}
    """.trimIndent()
val author = JsonObject(ejsonStr)

Para insertar este documento en una colección, instancia una colección utilizando el método getCollection() especificando la clase JsonObject como el parámetro documentClass. Luego, llama a la operación insertOne de la siguiente manera:

// val mongoClient = <code to instantiate your client>;
val database = mongoClient.getDatabase("fundamentals_data")
val collection= database.getCollection<JsonObject>("authors")
val result = collection.insertOne(author)

Una vez realizada la inserción correctamente, podrá recuperar los datos JSON de muestra de la colección. Si bien puede usar cualquier clase que extienda Bson para especificar su consulta, aquí le mostramos cómo consultar sus datos usando JsonObject:

// val mongoClient = <code to instantiate your client>;
val query = JsonObject("{\"name\": \"Gabriel Garc\\u00eda M\\u00e1rquez\"}")
val jsonResult = collection.find(query).firstOrNull()
jsonResult?.let {
    println("query result in extended json format: " + jsonResult.json)
}

query result in extended json format: {"_id": {"$oid": "6035210f35bd203721c3eab8"}, "name": "Gabriel García Márquez", "dateOfDeath": {"$date": "2014-04-17T04:00:00Z"}, "novels": [{"title": "One Hundred Years of Solitude", "yearPublished": 1967}, {"title": "Chronicle of a Death Foretold", "yearPublished": 1981}, {"title": "Love in the Time of Cholera", "yearPublished": 1985}]}

Para obtener más información sobre los métodos y clases mencionados en esta sección, consulte la siguiente documentación de API:

• JsonObject

• JsonObjectCodec

• Configuración de JsonWriter

• getCollection()

Resumen

En esta guía, cubrimos los siguientes temas sobre las clases que puede utilizar para trabajar con datos BSON:

• Se describen las clases de Kotlin que puedes usar para trabajar con documentos MongoDB y por qué podrías preferir una sobre la otra.

• Se proporcionan ejemplos de uso para cada clase sobre cómo construir documentos que contienen varios tipos, insertarlos en una colección y recuperar/acceder a sus campos tipados.