

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

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

Baru dari versi 8.0.1.

T `$listSearchIndexes` ahap agregasi di Amazon DocumentDB mengembalikan informasi tentang indeks pencarian yang ada pada koleksi. Ini harus menjadi tahap pertama dalam pipa agregasi.

**Parameter**
+ `name`: (opsional) Nama indeks pencarian untuk mengembalikan informasi tentang. Jika dihilangkan, semua indeks pencarian pada koleksi dikembalikan.

**Bidang keluaran **

Setiap dokumen yang dikembalikan berisi bidang berikut:
+ `name`: Nama indeks pencarian.
+ `status`: Status build indeks. Salah satu `READY` (dibangun dan valid), `BUILDING` (build bersamaan sedang berlangsung), atau `FAILED` (pembuatan indeks tidak berhasil diselesaikan).
+ `queryable`: Sebuah boolean yang menunjukkan apakah indeks saat ini dapat digunakan untuk melayani kueri. Ini `false` untuk indeks tersembunyi (yang tetap`READY`) dan untuk `FAILED` indeks. Indeks tersembunyi adalah kasus di mana `status` ada `READY` tetapi `queryable` ada`false`.
+ `latestDefinitionVersion`: Dokumen yang berisi `version` (versi format indeks) dan `createdAt` (waktu indeks dibuat).

**Sintaksis**

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

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

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

Contoh berikut menunjukkan cara menggunakan stage untuk `$listSearchIndexes` mencantumkan semua indeks pencarian pada koleksi.

**Contoh kueri **

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

**Keluaran **

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

Indeks tersembunyi tetap ada `READY` tetapi melaporkan`queryable: false`, karena tidak dapat digunakan untuk melayani kueri saat disembunyikan:

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

Untuk memfilter berdasarkan nama indeks tertentu:

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

## Contoh kode
<a name="listSearchIndexes-code"></a>

Untuk melihat contoh kode untuk menggunakan pang `$listSearchIndexes` gung, pilih tab untuk bahasa yang ingin Anda gunakan:

------
#### [ 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()
```

------