Insertar documentos

Overview

Mediante esta guía, puedes aprender a usar PyMongo para agregar documentos a una colección de MongoDB mediante la realización de operaciones de inserción.

Una operación de inserción inserta uno o más documentos en una colección de MongoDB. Puede realizar una operación de inserción utilizando insert_one() o método insert_many().

Inserta un documento

Para añadir un único documento a una colección de MongoDB, llama al método insert_one() y pasa el documento que quieras añadir.

El siguiente ejemplo inserta un documento en la colección restaurants. Seleccione el Synchronous o pestaña Asynchronous para ver el código correspondiente:

sample_restaurants.restaurants.insert_one({"name" : "Mongo's Burgers"})

await sample_restaurants.restaurants.insert_one({"name" : "Mongo's Burgers"})

También puedes pasar una instancia de una clase personalizada al método insert_one(). Esto proporciona seguridad de tipos adicional si estás utilizando una herramienta de comprobación de tipos. La instancia que apruebes debe heredar de la clase TypedDict .

El siguiente ejemplo pasa una instancia de la clase Restaurant al método insert_one() para aumentar la seguridad de tipos. Selecciona la pestaña Synchronous o Asynchronous para ver el código correspondiente:

class Restaurant(TypedDict):
   name: str
sample_restaurants.restaurants.insert_one(Restaurant(name="Mongo's Burgers"))

class Restaurant(TypedDict):
   name: str
await sample_restaurants.restaurants.insert_one(Restaurant(name="Mongo's Burgers"))

Inserta varios documentos

Para añadir varios documentos a una colección de MongoDB, llama al método insert_many() y pasa una lista de documentos que quieres añadir.

El siguiente ejemplo inserta una lista de documentos en la colección restaurants. Se debe seleccionar la pestaña Synchronous o Asynchronous para ver el código correspondiente:

document_list = [
   { "name" : "Mongo's Burgers" },
   { "name" : "Mongo's Pizza" }
]
sample_restaurants.restaurants.insert_many(document_list)

document_list = [
   { "name" : "Mongo's Burgers" },
   { "name" : "Mongo's Pizza" }
]
await sample_restaurants.restaurants.insert_many(document_list)

También puedes pasar una lista de instancias de una clase personalizada al método insert_many(). Esto proporciona seguridad de tipos adicional si estás utilizando una herramienta de comprobación de tipos. Las instancias que superes deben heredar de la clase TypedDict .

El siguiente ejemplo llama al método insert_many() y pasa una lista que contiene instancias de la clase Restaurant. Esto añade seguridad de tipo a la operación de inserción. Selecciona la pestaña Synchronous o Asynchronous para ver el código correspondiente:

class Restaurant(TypedDict):
   name: str
document_list = [
   Restaurant(name="Mongo's Burgers"),
   Restaurant(name="Mongo's Pizza")
]
sample_restaurants.restaurants.insert_many(document_list)

class Restaurant(TypedDict):
   name: str
document_list = [
   Restaurant(name="Mongo's Burgers"),
   Restaurant(name="Mongo's Pizza")
]
await sample_restaurants.restaurants.insert_many(document_list)

Modificar el comportamiento de inserción

El método insert_one() opcionalmente acepta parámetros adicionales que representan opciones que puedes usar para configurar la operación de inserción. Si no especificas ningún parámetro adicional, el driver no personaliza la inserción.

El método insert_many() acepta los parámetros opcionales anteriores, así como la propiedad ordered opcional:

document_list = [
   { "name" : "Mongo's Burgers" },
   { "name" : "Mongo's Pizza" },
   { "name" : "Mongo's Tacos" }
]
sample_restaurants.restaurants.insert_many(document_list, bypass_document_validation = True)

document_list = [
   { "name" : "Mongo's Burgers" },
   { "name" : "Mongo's Pizza" },
   { "name" : "Mongo's Tacos" }
]
await sample_restaurants.restaurants.insert_many(document_list, bypass_document_validation = True)

Solución de problemas

from pymongo import MongoClient
client = MongoClient()  # error: Need type annotation for "client"

error: Dict entry 0 has incompatible type "str": "int";
expected "Mapping[str, Any]": "int"

client: MongoClient[Dict[str, Any]]

Es posible que veas un error similar si pasas una lista al método insert_one():

error: Argument 1 to "insert_one" of "Collection" has
incompatible type "List[Dict[<nothing>, <nothing>]]";
expected "Mapping[str, Any]"

Este error se produce porque el método insert_one() acepta un documento, no una lista. Puedes resolver este error pasando un documento al método insert_one() o llamando al método insert_many() en su lugar.

TypedDict has no key "_id"

from typing import TypedDict
from pymongo import MongoClient
from pymongo.collection import Collection
class Movie(TypedDict):
    name: str
    year: int
client: MongoClient = MongoClient()
collection: Collection[Movie] = client.test.test
inserted = collection.insert_one(Movie(name="Jurassic Park", year=1993))
result = collection.find_one({"name": "Jurassic Park"})
# _id is present but was added by PyMongo; this will raise a type-checking error
assert result["_id"]

from typing import TypedDict
from pymongo import MongoClient
from pymongo.collection import Collection
class Movie(TypedDict):
    name: str
    year: int
collection: Collection[Movie] = client.test.test
inserted = collection.insert_one(
    Movie(name="Jurassic Park", year=1993)
)
result = collection.find_one({"name": "Jurassic Park"})
assert result is not None
assert result["_id"] # type:ignore[typeddict-item]

from typing import TypedDict
from pymongo import MongoClient
from pymongo.collection import Collection
from bson import ObjectId
class Movie(TypedDict):
    _id: ObjectId
    name: str
    year: int
collection: Collection[ExplicitMovie] = client.test.test
inserted = collection.insert_one(
    ExplicitMovie(_id=ObjectId(), name="Jurassic Park", year=1993)
)
result = collection.find_one({"name": "Jurassic Park"})
assert result is not None
assert result["_id"]

from typing import TypedDict, NotRequired
from pymongo import MongoClient
from pymongo.collection import Collection
from bson import ObjectId
class Movie(TypedDict):
     _id: NotRequired[ObjectId]
    name: str
    year: int
client: MongoClient = MongoClient()
collection: Collection[Movie] = client.test.test
inserted = collection.insert_one(Movie(name="Jurassic Park", year=1993))
result = collection.find_one({"name": "Jurassic Park"})
assert result is not None
assert result["_id"]

Información Adicional

Para obtener ejemplos de código ejecutable de insertar documentos con PyMongo, mira Operaciones CRUD.