Definición
planCacheSetFilterConfigurá un filtro de índice para una colección. Si ya existe un filtro de índice para la forma del query, el comando sobrescribe el filtro de índice anterior.
Compatibilidad
Este comando está disponible en implementaciones alojadas en los siguientes entornos:
MongoDB Atlas: El servicio totalmente gestionado para implementaciones de MongoDB en la nube
Importante
Este comando no es compatible con los clústeres M0 y Flex. Para obtener más información, consulta Comandos no compatibles.
MongoDB Enterprise: La versión basada en suscripción y autogestionada de MongoDB
MongoDB Community: La versión de MongoDB con código fuente disponible, de uso gratuito y autogestionada.
Sintaxis
El comando tiene la siguiente sintaxis:
db.runCommand( { planCacheSetFilter: <collection>, query: <query>, sort: <sort>, projection: <projection>, collation: { <collation> }, indexes: [ <index1>, <index2>, ...], comment: <any> } )
La forma de consulta para el filtro de índice es la combinación de:
querysortprojectioncollation
Campos de comandos
El comando tiene los siguientes campos:
Campo | Tipo | Descripción | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| string | El nombre de la colección para el filtro de índice. | ||||||||||
| Documento | El predicado de la query para el filtro del índice. Solo la estructura del predicado, incluidos los nombres de los campos, se utiliza en el filtro de índice. Los valores de campo en el predicado de la query no se utilizan. Por lo tanto, el predicado de query en un filtro de índice es utilizado por queries similares que solo difieren en los valores de los campos. | ||||||||||
| Documento | opcional. El orden para el filtro de índice. | ||||||||||
| Documento | opcional. La proyección para el filtro de índice. | ||||||||||
| Documento | Especifica la intercalación a utilizar para la operación. La intercalación permite a los usuarios especificar reglas propias del lenguaje para la comparación de strings, como reglas para el uso de mayúsculas y minúsculas y marcas de acento. La opción de intercalación tiene la siguiente sintaxis: Al especificar la intercalación, el campo Si no se especifica la intercalación, pero la colección tiene una intercalación por defecto (ver Si no se especifica ninguna intercalación para la colección o para las operaciones, MongoDB utiliza la comparación binaria simple usada en versiones anteriores para las comparaciones de strings. No puedes especificar varias intercalaciones para una operación. Por ejemplo, no puedes especificar diferentes intercalaciones por campo, o si realizas una búsqueda con un ordenamiento, no puedes usar una intercalación para la búsqueda y otra para el ordenamiento. A partir de MongoDB 6.0, un filtro de índice utiliza la intercalación establecida previamente mediante el comando | ||||||||||
| arreglo | Un arreglo de filtros de índices para la forma del queryespecificada. Especifica los filtros de índice como uno de estos arreglos:
El optimizador del query utiliza un escaneo de colección o los arreglos de índice para el plan del query. Si los índices especificados no existen o están ocultos, el optimizador utiliza un escaneo de colección. Para múltiples índices con el mismo patrón de clave, debes especificar el índice como un arreglo de nombres. | ||||||||||
| any | Opcional. Un comentario proporcionado por el usuario para adjuntar a este comando. Una vez configurado, este comentario aparece junto a los registros de este comando en las siguientes ubicaciones:
Un comentario puede ser de cualquier tipo BSON válido (string, objeto, arreglo, etc.). |
Los filtros de índice solo existen durante la duración del proceso del servidor y no persisten después del apagado. Para borrar los filtros de índice, utilice el comando planCacheClearFilters.
Acceso requerido
Un usuario debe tener acceso que incluya la acción planCacheIndexFilter.
Ejemplos
Configura el filtro en la forma del query consistente solo en el predicado
El siguiente ejemplo crea un filtro de índice en la colección orders de modo que, para las consultas que consisten únicamente en una coincidencia de igualdad en el campo status sin ninguna proyección ni ordenamiento, el optimizador de consultas evalúa únicamente los dos índices especificados y el escaneo de la colección para el plan ganador:
db.runCommand( { planCacheSetFilter: "orders", query: { status: "A" }, indexes: [ { cust_id: 1, status: 1 }, { status: 1, order_date: -1 } ] } )
En el predicado de la query, solo la estructura del predicado, incluyendo los nombres de los campos, es significativa; los valores son insignificantes. Como tal, el filtro creado se aplica a las siguientes operaciones:
db.orders.find( { status: "D" } ) db.orders.find( { status: "P" } )
Para ver si MongoDB aplicará un filtro de índice a una forma del query, verifica el campo indexFilterSet del método db.collection.explain() o del cursor.explain().
Establecer filtro en la forma del query que consiste en predicado, proyección y ordenación
El siguiente ejemplo crea un filtro de índice para la colección orders. El filtro se aplica a las consultas cuyo predicado es una coincidencia exacta en el campo item, donde solo se proyecta el campo quantity y se especifica una ordenación ascendente por el campo order_date.
db.runCommand( { planCacheSetFilter: "orders", query: { item: "ABC" }, projection: { quantity: 1, _id: 0 }, sort: { order_date: 1 }, indexes: [ { item: 1, order_date: 1 , quantity: 1 } ] } )
Para la forma de consulta, el optimizador de consultas solo considerará los planes indexados que utilicen el índice { item: 1, order_date: 1, quantity: 1 }.
Establecer filtro en forma del query que consiste en predicado y intercalación
El siguiente ejemplo crea un filtro de índice para la colección orders. El filtro se aplica a queries cuyo predicado es una coincidencia exacta en el campo item y la intercalación en_US (inglés de Estados Unidos).
db.runCommand( { planCacheSetFilter: "orders", query: { item: "Movie" }, collation: { locale: "en_US" }, indexes: [ { item: 1, order_date: 1 , quantity: 1 } ] } )
Para la forma del query, el optimizador del query sólo utiliza planes indexados que utilicen el índice { item: 1, order_date: 1, quantity: 1 }.
A partir de MongoDB 6.0, un filtro de índice utiliza la intercalación configurada previamente mediante el comando planCacheSetFilter.