Para agentes de IA: hay un índice de documentación disponible en https://www.mongodb.com/es/docs/llms.txt — versiones en markdown de todas las páginas están disponibles agregando .md a cualquier ruta URL.

Interpreta los resultados del plan de explicación

Puedes usar los resultados de 'explain' para determinar la siguiente información sobre una consulta:

  • La cantidad de tiempo que tardó en completarse una query

  • Si la query usó o no un índice.

  • El número de documentos y claves de índice escaneados para cumplir con una query

Nota

Los resultados del plan de explicación para las consultas están sujetos a cambios entre las versiones de MongoDB.

Los métodos cursor.explain("executionStats") y db.collection.explain("executionStats") proporcionan estadísticas sobre el rendimiento de una consulta. Estas estadísticas pueden ser útiles para medir si una consulta utiliza un índice y cómo lo hace. Consulta db.collection.explain() para más detalles.

Los ejemplos de esta página utilizan datos del conjunto de datos sample_mflix. Para obtener más información sobre cómo cargar este conjunto de datos en la implementación autogestionada de MongoDB, consultar Cargar el conjunto de datos de muestra. Si realizó alguna modificación en las bases de datos de muestra, es posible que deba descartar y volver a crear las bases de datos para ejecutar los ejemplos de esta página.

La siguiente query recupera documentos donde el campo year tiene un valor entre 2000 y 2005, inclusivo:

db.movies.find( { year: { $gte: 2000, $lte: 2005 } } )

Este query coincide con 3809 de los 21349 documentos en la colección.

Para ver el plan del query seleccionado, encadena el método cursor cursor.explain("executionStats") al final del comando find:

db.movies.find( { year: { $gte: 2000, $lte: 2005 } }).explain("executionStats")
{ queryPlanner: { namespace: 'sample_mflix.movies', winningPlan: { stage: 'COLLSCAN', '...': '...' }, '...': '...' }, executionStats: { executionSuccess: true, nReturned: 3809, totalKeysExamined: 0, totalDocsExamined: 21349, executionStages: { stage: 'COLLSCAN', '...': '...' }, '...': '...' }, '...': '...'}
  • queryPlanner.winningPlan.stage muestra COLLSCAN para indicar un escaneo de colección.

    El escaneo de colección indica que la mongod tuvo que escanear toda la colección documento por documento para identificar los resultados. Esta es una operación generalmente costosa y puede resultar en consultas lentas.

  • executionStats.nReturned muestra 3809 para indicar que el plan del query ganador devuelve 3,809 documentos.

  • executionStats.totalKeysExamined muestra 0 para indicar que esta query no está utilizando un índice.

  • executionStats.totalDocsExamined muestra 21349 para indicar que MongoDB tuvo que escanear todos los 21,349 documentos de la colección para encontrar los 3,809 documentos coincidentes.

La diferencia entre el número de documentos coincidentes y el número de documentos examinados puede sugerir que la query podría beneficiarse del uso de un índice para mejorar la eficiencia.

Para admitir la query en el campo year, añada un índice en el campo year:

db.movies.createIndex( { year: 1 } )

Para ver las estadísticas del plan del query, utiliza el método explain():

db.movies.find( { year: { $gte: 2000, $lte: 2005 } }).explain("executionStats")
{ queryPlanner: { namespace: 'sample_mflix.movies', winningPlan: { stage: 'FETCH', inputStage: { stage: 'IXSCAN', keyPattern: { year: 1 }, '...': '...' }, '...': '...' }, '...': '...' }, executionStats: { executionSuccess: true, nReturned: 3809, totalKeysExamined: 3809, totalDocsExamined: 3809, '...': '...' }, '...': '...'}
  • queryPlanner.winningPlan.inputStage.stage muestra IXSCAN para indicar el uso del índice.

  • executionStats.nReturned muestra 3809 para indicar que el plan del query ganador devuelve 3,809 documentos.

  • executionStats.totalKeysExamined muestra 3809 para indicar que MongoDB ha escaneado 3,809 entradas de índice. El número de claves examinadas coincide con el número de documentos devueltos, lo que significa que el mongod solo tuvo que examinar las claves de índice para devolver los resultados. La mongod no tuvo que escanear todos los documentos, y solo los 3,809 documentos coincidentes tuvieron que cargarse en la memoria. Esto da como resultado una query muy eficiente.

  • executionStats.totalDocsExamined muestra 3809 para indicar que MongoDB escaneó 3,809 documentos.

Sin el índice, la query escanea toda la colección para devolver los documentos coincidentes. La query también tiene que escanear cada documento en su totalidad, potencialmente cargándolos en la memoria. Esto da como resultado una operación de query costosa y potencialmente lenta.

Cuando se ejecuta con un índice, la query solo escanea tantas entradas de índice y documentos como devuelve, lo que da como resultado una query más eficiente.

Comparar el funcionamiento de los índices

Para comparar manualmente el rendimiento de una query utilizando más de un índice, puedes utilizar el hint() método junto con el explain() método.

Considera el siguiente query:

db.movies.find( { year: { $gte: 2000, $lte: 2005 }, rated: "PG"} )

Esta query coincide con 235 documentos.

Para respaldar la query, agregue un índice compuesto. Con los índices compuestos, el orden de los campos es importante.

Por ejemplo, añade los siguientes dos índices compuestos. El primer índice ordena primero por el campo year y luego por el campo rated. El segundo índice ordena primero por rated y luego por el campo year.

db.movies.createIndex( { year: 1, rated: 1 } )db.movies.createIndex( { rated: 1, year: 1 } )

Evalúa el efecto del primer índice en la query:

db.movies.find( { year: { $gte: 2000, $lte: 2005 }, rated: "PG" }).hint( { year: 1, rated: 1 } ).explain("executionStats")
{ queryPlanner: { namespace: 'sample_mflix.movies', winningPlan: { stage: 'FETCH', inputStage: { stage: 'IXSCAN', keyPattern: { year: 1, rated: 1 }, '...': '...' }, '...': '...' }, '...': '...' }, executionStats: { executionSuccess: true, nReturned: 235, totalKeysExamined: 246, totalDocsExamined: 235, '...': '...' }, '...': '...'}

MongoDB analizó 246 claves del índice (executionStats.totalKeysExamined) para devolver 235 documentos coincidentes (executionStats.nReturned).

Evaluar el efecto del segundo índice en la query:

db.movies.find( { year: { $gte: 2000, $lte: 2005 }, rated: "PG" }).hint( { rated: 1, year: 1 } ).explain("executionStats")
{ queryPlanner: { namespace: 'sample_mflix.movies', winningPlan: { stage: 'FETCH', inputStage: { stage: 'IXSCAN', keyPattern: { rated: 1, year: 1 }, '...': '...' }, '...': '...' }, '...': '...' }, executionStats: { executionSuccess: true, nReturned: 235, totalKeysExamined: 235, totalDocsExamined: 235, '...': '...' }, '...': '...'}

MongoDB analizó 235 claves del índice (executionStats.totalKeysExamined) para devolver 235 documentos coincidentes (executionStats.nReturned).

El segundo índice compuesto, { rated: 1, year: 1 }, es, por lo tanto, el índice más eficiente para admitir la query de ejemplo, ya que el servidor de MongoDB solo necesita escanear 235 index keys para encontrar todos los documentos coincidentes utilizando este índice, en comparación con 246 cuando se utiliza el índice compuesto { year: 1, rated: 1 }.

Califique esta página