View a markdown version of this page

$lista SearchIndexes - Amazon DocumentDB
Exemplo (MongoDB Shell)Exemplos de código

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

$lista SearchIndexes

Novo na versão 8.0.1.

O estágio $listSearchIndexes de agregação no Amazon DocumentDB retorna informações sobre os índices de pesquisa existentes em uma coleção. Deve ser o primeiro estágio em um pipeline de agregação.

Parâmetros

  • name: (opcional) O nome do índice de pesquisa sobre o qual retornar informações. Se omitido, todos os índices de pesquisa na coleção serão retornados.

Campos de saída

Cada documento devolvido contém os seguintes campos:

  • name: O nome do índice de pesquisa.

  • status: O estado de construção do índice. Um dos READY (criado e válido), BUILDING (uma compilação simultânea está em andamento) ou FAILED (a construção do índice não foi concluída com êxito).

  • queryable: um booleano que indica se o índice pode ser usado atualmente para atender consultas. Isso é false para índices ocultos (que permanecemREADY) e para FAILED índices. Um índice oculto é o caso em que status estáREADY, mas queryable estáfalse.

  • latestDefinitionVersion: Um documento contendo version (a versão do formato do índice) e createdAt (a hora em que o índice foi criado).

Sintaxe

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

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

Exemplo (MongoDB Shell)

O exemplo a seguir mostra como usar o $listSearchIndexes estágio para listar todos os índices de pesquisa em uma coleção.

Exemplo de consulta 

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

Saída

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

Um índice oculto permanece, READY mas relataqueryable: false, porque não pode ser usado para atender consultas enquanto estiver oculto:

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

Para filtrar por um nome de índice específico:

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

Exemplos de código

Para ver um exemplo de código para usar o $listSearchIndexes estágio, escolha a guia do idioma que você deseja 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()