/ /

Hidden Indexes

Esta versión de la documentación se archivó y ya no se admite. Para actualizar tu implementación de 6.0, consulta el Procedimientos de actualización de MongoDB.7.0

Los índices ocultos no son visibles para los Planificador de consultas y no se puede utilizar para respaldar una consulta.

Al ocultar un índice del planificador, puede evaluar el impacto potencial de eliminarlo sin eliminarlo realmente. Si el impacto es negativo, puede mostrarlo en lugar de tener que volver a crearlo.

Comportamiento

Aparte de estar ocultos en el planificador, los índices ocultos se comportan como índices no ocultos. Es decir,

Si un índice oculto es un índice único, el índice sigue aplicando su restricción de unicidad a los documentos.
Si un índice oculto es un índice TTL, el índice sigue expirando documentos.
Los índices ocultos se incluyen en listIndexes y db.collection.getIndexes() resultados.
Los índices ocultos se actualizan cuando se realizan operaciones de escritura en la colección y siguen consumiendo espacio de disco y memoria. Como tal, se incluyen en varias operaciones estadísticas, tales como db.collection.stats() y $indexStats.
Ocultar o mostrar un índice no oculto restablece su $indexStats valor. Ocultar o mostrar un índice ya oculto no restablece su $indexStats valor.

Restricciones

Para ocultar un índice, se debe tener el valor featureCompatibilityVersion de 5.0 o superior.
No puedes ocultar el índice _id.
No se puede un índice cursor.hint() oculto.

Ejemplos

Crea un índice oculto

Para crear un índice de hidden, utiliza el método db.collection.createIndex() con la opción hidden configurada en true.

Nota

Para usar la opción hidden con db.collection.createIndex(), debes tener featureCompatibilityVersion configurado en 5.0 o superior.

Por ejemplo, la siguiente operación crea un índice ascendente oculto en el campo borough:

db.addresses.createIndex(
   { borough: 1 },
   { hidden: true }
);

Para verificar, ejecute en db.collection.getIndexes() la addresses colección:

db.addresses.getIndexes()

La operación devuelve la siguiente información:

[
   {
      "v" : 2,
      "key" : {
         "_id" : 1
      },
      "name" : "_id_"
   },
   {
      "v" : 2,
      "key" : {
         "borough" : 1
      },
      "name" : "borough_1",
      "hidden" : true
   }
]

La opción de índice hidden solo se devuelve si el valor es true.

Ocultar un índice existente

Nota

Para ocultar un índice, se debe tener el valor featureCompatibilityVersion de 5.0 o superior.
No puedes ocultar el índice _id.

Para ocultar un índice existente, puedes usar el comando collMod o el asistente mongosh db.collection.hideIndex().

Por ejemplo, crear un índice sin ocultar:

db.restaurants.createIndex( { borough: 1, ratings: 1 } );

Para ocultar el índice, puedes especificar:

el documento de especificación de la clave de índice para el método db.collection.hideIndex():
```
db.restaurants.hideIndex( { borough: 1, ratings: 1 } ); // Specify the index key specification document
```
el nombre del índice al método db.collection.hideIndex():
```
db.restaurants.hideIndex( "borough_1_ratings_1" );  // Specify the index name
```

Para verificar, ejecute en db.collection.getIndexes() la restaurants colección:

db.restaurants.getIndexes()

La operación devuelve la siguiente información:

[
   {
      "v" : 2,
      "key" : {
         "_id" : 1
      },
      "name" : "_id_"
   },
   {
      "v" : 2,
      "key" : {
         "borough" : 1,
         "ratings" : 1
      },
      "name" : "borough_1_ratings_1",
      "hidden" : true
   }
]

La opción de índice hidden solo se devuelve si el valor es true.

Mostrar un índice existente

Para mostrar un índice oculto, puede utilizar el comando collMod o el asistente mongosh db.collection.unhideIndex(). Se puede especificar cualquiera de las siguientes opciones:

el documento de especificación de la clave de índice para el método db.collection.unhideIndex():
```
db.restaurants.unhideIndex( { borough: 1, city: 1 } );  // Specify the index key specification document
```
el nombre del índice al método db.collection.unhideIndex():
```
db.restaurants.unhideIndex( "borough_1_ratings_1" );    // Specify the index name
```

Para verificar, ejecute en db.collection.getIndexes() la restaurants colección:

db.restaurants.getIndexes()

La operación devuelve la siguiente información:

[
   {
      "v" : 2,
      "key" : {
         "_id" : 1
      },
      "name" : "_id_"
   },
   {
      "v" : 2,
      "key" : {
         "borough" : 1,
         "ratings" : 1
      },
      "name" : "borough_1_ratings_1"
   }
]

La opción de índice hidden ya no aparece como parte del índice borough_1_ratings_1, ya que el campo solo se muestra si el valor es true.

Debido a que los índices se mantienen completamente mientras están ocultos, el índice está inmediatamente disponible para su uso una vez que se revela.

Volver

Índices que no discriminan entre mayúsculas y minúsculas

Sparse Indexes