Buscar documentos

Datos de muestra

Los ejemplos de esta guía utilizan la colección sample_restaurants.restaurants de Conjuntos de datos de muestra de Atlas. Para aprender a crear un clúster gratuito de MongoDB Atlas y cargar los conjuntos de datos de muestra, consulte Tutorial paraempezar a usar PyMongo.

Encuentre un documento

Para encontrar un solo documento en una colección, llama al método find_one() y pasa un filtro de query que especifique los criterios del documento que desea encontrar. Si más de un documento coincide con el filtro de query, este método devuelve el primer documento coincidente de los resultados recuperados como un diccionario de Python. Si ningún documento coincide con el filtro de query, el método devuelve None.

El siguiente ejemplo utiliza el método find_one() para encontrar el primer documento donde el campo "cuisine" tiene el valor "Bakery". Seleccione el Synchronous o pestaña Asynchronous para ver el código correspondiente:

restaurant = sample_restaurants.restaurants.find_one({"cuisine": "Bakery"})

restaurant = await sample_restaurants.restaurants.find_one({"cuisine": "Bakery"})

Encuentra varios documentos

Para encontrar varios documentos en una colección, pasar un filtro de query al método find() que especifique los criterios de los documentos que desea recuperar.

El siguiente ejemplo utiliza el método find() para encontrar todos los documentos donde el campo "cuisine" tiene el valor "Spanish".

cursor = sample_restaurants.restaurants.find({"cuisine": "Spanish"})

Se puede utilizar un cursor para iterar sobre los documentos devueltos por el método find(). Un cursor es un mecanismo que permite a una aplicación iterar sobre los resultados de una base de datos mientras mantiene solo un subconjunto de ellos en la memoria en un momento dado. Los cursores son útiles cuando el método find() devuelve una gran cantidad de documentos.

Se puede iterar sobre los documentos en un cursor usando un bucle de for-in, como se muestra en el siguiente ejemplo. Seleccionar la pestaña Synchronous o Asynchronous para ver el código correspondiente:

cursor = sample_restaurants.restaurants.find({"cuisine": "Spanish"})
for restaurant in cursor:
...

cursor = sample_restaurants.restaurants.find({"cuisine": "Spanish"})
async for restaurant in cursor:
...

all_restaurants = sample_restaurants.restaurants.find({})

Modificar el comportamiento de búsqueda

Se puede modificar el comportamiento de los métodos find() y find_one() pasándoles argumentos con nombre. La siguiente tabla describe los argumentos comúnmente utilizados:

El siguiente ejemplo utiliza el método find() para encontrar todos los documentos donde el campo "cuisine" tiene el valor "Italian" y establece un tiempo de ejecución máximo de 10 segundos (10,000 milisegundos):

cursor = sample_restaurants.restaurants.find({"cuisine": "Italian"}, max_time_ms=10000)

Para una lista completa de argumentos disponibles, consultar la documentación de la API para el find() method.

cursor = sample_restaurants.restaurants.find({"cuisine": "Italian"}, max_time_ms=10000,
                                           collation=Collation(locale="fr_CA"))

cursor = sample_restaurants.restaurants.find({"cuisine": "Italian"}, max_time_ms=10000)
                                       .collation(Collation(locale="fr_CA"))

Localización de documentos inválidos en colecciones

El siguiente ejemplo muestra cómo identificar documentos no válidos al iterar sobre una colección. Seleccione la pestaña Synchronous o Asynchronous para ver el código correspondiente:

import bson
# Use RawBSONDocument to delay BSON decoding
raw_coll = collection.with_options(
    codec_options=collection.codec_options.with_options(
        document_class=bson.raw_bson.RawBSONDocument
    )
)
# Iterate through documents and check for BSON errors
for doc in raw_coll.find():
    try:
        bson.decode(doc.raw)
    except bson.errors.InvalidBSON as exc:
        print(f"Invalid document {exc}, raw bson: {doc.raw}")

import bson
# Use RawBSONDocument to delay BSON decoding
raw_coll = collection.with_options(
    codec_options=collection.codec_options.with_options(
        document_class=bson.raw_bson.RawBSONDocument
    )
)
# Iterate through documents and check for BSON errors
async for doc in raw_coll.find():
    try:
        bson.decode(doc.raw)
    except bson.errors.InvalidBSON as exc:
        print(f"Invalid document {exc}, raw bson: {doc.raw}")

Identificación de documentos no válidos en las respuestas de los comandos

El siguiente ejemplo muestra cómo gestionar BSON no válido en las respuestas de comandos de base de datos. Selecciona la pestaña Synchronous o Asynchronous para ver el código correspondiente:

import bson
# Execute command with raw BSON options
res = client.admin.command(
    "serverStatus",
    codec_options=bson.raw_bson.DEFAULT_RAW_BSON_OPTIONS
)
# Check for BSON errors in the response
try:
    bson.decode(res.raw)
except bson.errors.InvalidBSON as exc:
    print(f"Invalid BSON found in serverStatus response {exc}, raw bson: {res.raw}")

import bson
# Execute command with raw BSON options
res = await client.admin.command(
    "serverStatus",
    codec_options=bson.raw_bson.DEFAULT_RAW_BSON_OPTIONS
)
# Check for BSON errors in the response
try:
    bson.decode(res.raw)
except bson.errors.InvalidBSON as exc:
    print(f"Invalid BSON found in serverStatus response {exc}, raw bson: {res.raw}")

Documentación de la API

Para aprender más sobre cualquiera de los métodos o tipos analizados en esta guía, consulta la siguiente documentación de API:

• find()

• find_one()

• Intercalación

• Cursor