

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

# $lista SearchIndexes
<a name="listSearchIndexes"></a>

Nuevo a partir de la versión 8.0.1.

La fase de `$listSearchIndexes` agregación de Amazon DocumentDB devuelve información sobre los índices de búsqueda existentes en una colección. Debe ser la primera etapa de un proceso de agregación.

**Parámetros**
+ `name`: (opcional) El nombre del índice de búsqueda sobre el que se devolverá la información. Si se omite, se devuelven todos los índices de búsqueda de la colección.

**Campos de salida **

Cada documento devuelto contiene los siguientes campos:
+ `name`: el nombre del índice de búsqueda.
+ `status`: El estado de creación del índice. Uno de `READY` (creado y válido), `BUILDING` (hay una compilación simultánea en curso) o `FAILED` (la creación del índice no se completó correctamente).
+ `queryable`: un booleano que indica si el índice se puede usar actualmente para atender consultas. Esto es `false` para los índices ocultos (que permanecen`READY`) y para los índices. `FAILED` Un índice oculto es el caso en el que `status` es `READY` pero `queryable` es. `false`
+ `latestDefinitionVersion`: un documento que contiene `version` (la versión en formato de índice) y `createdAt` (la hora en que se creó el índice).

**Sintaxis**

```
db.collection.aggregate([
  { $listSearchIndexes: {} }
])

// Or filter by name:
db.collection.aggregate([
  { $listSearchIndexes: { name: "mySearchIndex" } }
])
```

## Ejemplo (MongoDB Shell)
<a name="listSearchIndexes-examples"></a>

El siguiente ejemplo muestra cómo usar el `$listSearchIndexes` escenario para mostrar todos los índices de búsqueda de una colección.

**Ejemplo de consulta **

```
db.movies.aggregate([
  { $listSearchIndexes: {} }
]);
```

**Salida**

```
[
  {
    "name": "default",
    "status": "READY",
    "queryable": true,
    "latestDefinitionVersion": {
      "version": 2,
      "createdAt": ISODate("2026-05-11T21:12:57.974Z")
    }
  }
]
```

Un índice oculto permanece, `READY` pero informa`queryable: false`, porque no se puede usar para atender consultas mientras está oculto:

```
[
  {
    "name": "myHiddenIndex",
    "status": "READY",
    "queryable": false,
    "latestDefinitionVersion": {
      "version": 2,
      "createdAt": ISODate("2026-05-11T21:12:57.974Z")
    }
  }
]
```

Para filtrar por un nombre de índice específico:

```
db.movies.aggregate([
  { $listSearchIndexes: { name: "default" } }
]);
```

## Ejemplos de código
<a name="listSearchIndexes-code"></a>

Para ver un ejemplo de código sobre el uso del `$listSearchIndexes` escenario, elige la pestaña correspondiente al idioma que quieres usar:

------
#### [ Node.js ]

```
const { MongoClient } = require('mongodb');

async function example() {
  const client = new MongoClient('mongodb://<username>:<password>@<cluster-endpoint>:27017/?tls=true&tlsCAFile=global-bundle.pem&replicaSet=rs0&readPreference=secondaryPreferred&retryWrites=false');

  try {
    await client.connect();
    const db = client.db('test');
    const collection = db.collection('movies');

    // List all search indexes
    const allIndexes = await collection.aggregate([
      { $listSearchIndexes: {} }
    ]).toArray();
    console.log('All search indexes:', allIndexes);

    // List a specific search index by name
    const namedIndex = await collection.aggregate([
      { $listSearchIndexes: { name: "default" } }
    ]).toArray();
    console.log('Named index:', namedIndex);

  } finally {
    await client.close();
  }
}

example();
```

------
#### [ Python ]

```
from pymongo import MongoClient

def example():
    client = MongoClient('mongodb://<username>:<password>@<cluster-endpoint>:27017/?tls=true&tlsCAFile=global-bundle.pem&replicaSet=rs0&readPreference=secondaryPreferred&retryWrites=false')

    try:
        db = client['test']
        collection = db['movies']

        # List all search indexes
        all_indexes = list(collection.aggregate([
            { '$listSearchIndexes': {} }
        ]))
        print('All search indexes:', all_indexes)

        # List a specific search index by name
        named_index = list(collection.aggregate([
            { '$listSearchIndexes': { 'name': 'default' } }
        ]))
        print('Named index:', named_index)

    finally:
        client.close()

example()
```

------