View a markdown version of this page

$ liste SearchIndexes - Amazon DocumentDB
Beispiel (MongoDB Shell)Codebeispiele

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

$ liste SearchIndexes

Neu ab Version 8.0.1.

Die $listSearchIndexes Aggregationsphase in Amazon DocumentDB gibt Informationen zu vorhandenen Suchindizes für eine Sammlung zurück. Sie muss die erste Phase in einer Aggregationspipeline sein.

Parameter

  • name: (optional) Der Name des Suchindex, über den Informationen zurückgegeben werden sollen. Wenn er weggelassen wird, werden alle Suchindizes für die Sammlung zurückgegeben.

Ausgabefelder

Jedes zurückgegebene Dokument enthält die folgenden Felder:

  • name: Der Name des Suchindex.

  • status: Der Erstellungsstatus des Indexes. Einer von READY (erstellt und gültig), BUILDING (ein gleichzeitiger Build wird gerade erstellt) oder FAILED (die Indexerstellung wurde nicht erfolgreich abgeschlossen).

  • queryable: Ein boolescher Wert, der angibt, ob der Index derzeit zur Bearbeitung von Abfragen verwendet werden kann. Dies gilt false für versteckte Indizes (die übrig bleibenREADY) und für Indizes. FAILED Ein versteckter Index ist der Fall, wo er ist, READY aber status queryable ist. false

  • latestDefinitionVersion: Ein Dokument, das version (die Version im Indexformat) und createdAt (die Uhrzeit, zu der der Index erstellt wurde) enthält.

Syntax

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

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

Beispiel (MongoDB Shell)

Das folgende Beispiel zeigt, wie der $listSearchIndexes Stagingbereich verwendet wird, um alle Suchindizes einer Sammlung aufzulisten.

Beispiel für eine Abfrage 

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

Ausgabe

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

Ein ausgeblendeter Index bleibt bestehenqueryable: false, meldet sich READY aber, da er nicht zur Bearbeitung von Abfragen verwendet werden kann, während er ausgeblendet ist:

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

So filtern Sie nach einem bestimmten Indexnamen:

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

Codebeispiele

Um ein Codebeispiel für die Verwendung der $listSearchIndexes Stufe anzuzeigen, wählen Sie die Registerkarte für die Sprache, die Sie verwenden möchten:

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()