db.collection.getSearchIndexes()
項目一覧
定義
バージョン 7.0 の新機能: (6.0.7 以降でも利用可能)
指定されたコレクションの既存の Atlas Search インデックスに関する情報を返します。
重要
mongosh メソッド
このページでは、mongosh
メソッドについて記載しています。これは Node.js などの言語固有のドライバーのドキュメントではありません。
MongoDB API ドライバーについては、各言語の MongoDB ドライバー ドキュメントを参照してください。
互換性
このメソッドは、次の環境でホストされている配置で使用できます。
MongoDB Atlas はクラウドでの MongoDB 配置のためのフルマネージド サービスです
重要
This command is not supported in M0, M2, and M5 clusters or in serverless instances. 詳細については、「サポートされていないコマンド 」を参照してください。
構文
コマンド構文:
db.<collection>.getSearchIndexes(<indexName>)
コマンドフィールド
getSearchIndexes()
このフィールドは、次のフィールドがあります。
フィールド | タイプ | 必要性 | 説明 |
---|---|---|---|
indexName | string | 任意 | 情報を返すインデックスの名前。 indexName フィールドを省略すると、 getSearchIndexes() はコレクションのすべての Atlas Search インデックスに関する情報を返します。 |
アクセス制御
配置でアクセス制御を強制する場合、 getSearchIndexes()
を実行しているユーザーは、データベースまたはコレクションに対する listSearchIndexes
特権アクションを持っている必要があります。
{ resource: { db : <database>, collection: <collection> }, actions: [ "listSearchIndexes" ] }
組み込みのread
ロールにはlistSearchIndexes
特権が付与されます。 次の例では、 qa
データベースでread
ロールを付与しています。
db.grantRolesToUser( "<user>", [ { role: "read", db: "qa" } ] )
出力
getSearchIndexes()
は、ドキュメントの配列を返します。 配列内の各ドキュメントには、次のフィールドが含まれています。
フィールド | タイプ | 説明 |
---|---|---|
id | string | インデックスの一意の識別子。 |
name | string | インデックスの名前。 |
status | string | インデックスのステータス。 詳細については、「 Atlas Search インデックスのステータス 」を参照してください。 |
queryable | ブール値 | インデックスがクエリの準備ができているかどうかを示します。 |
latestDefinitionVersion | ドキュメント | インデックスのバージョンを説明します。 |
latestDefinitionVersion.version | integer | インデックス定義に関連付けられているバージョン番号。 インデックスの定義を更新すると、バージョン番号が自動的に増加します。 |
latestDefinitionVersion.createdAt | date | 現在のインデックス定義が作成された時間。 |
latestDefinition | ドキュメント | インデックスの最新の定義。 詳しくは、「検索インデックスの定義構文 」を参照してください。 |
statusDetail | ドキュメントの配列 | 各検索ホストのインデックスのステータスが含まれます( mongot )。 |
statusDetail.[n].hostname | string | 対応する mongot のホスト名。 |
statusDetail.[n].status | string | 対応する mongot のインデックスのステータス。 |
statusDetail.[n].queryable | ブール値 | 対応する mongot でインデックスがクエリされる準備ができているかどうかを示します。 |
statusDetail.[n].mainIndex | ドキュメント | 対応する 詳細については、「インデックス ステータスの詳細」を参照してください。 |
statusDetail.[n].stagedIndex | ドキュメント | 対応する 詳細については、「インデックス ステータスの詳細」を参照してください。 |
synonymMappingStatus | string | インデックスのシノニム(同意語)マッピングのステータス。 このフィールドは、インデックスにシノニムが定義されている場合にのみ表示されます。 次のいずれかの値になります。
返されるステータスは、個々の |
synonymMappingStatusDetail | ドキュメントの配列 | 各検索ホストでのインデックスのシノニム マッピングのステータスが含まれます( mongot )。 このフィールド(およびそのサブフィールド)は、インデックスにシノニム(同意語)が定義されている場合にのみ表示されます。 |
synonymMappingStatusDetail.[n].status | string | すべての mongot プロセスにわたる対応するシノニム マッピングのステータス。 |
synonymMappingStatusDetail.[n].queryable | ブール値 | 対応するシノニム マッピングがすべての mongot プロセスにわたるクエリをサポートできるかどうかを示します。 |
message | string | 該当する場合、シノニム マッピングのエラーを説明します。 このシノニム マッピングの status がFAILED の場合にのみ表示されます。 |
インデックス ステータスの詳細
以下の表では、次のドキュメントの埋め込みフィールドを説明していますstatusDetail.[mongot].mainIndex
- statusDetail.[mongot].stagedIndex
フィールドは、特定のmongot
のインデックス ステータスを説明します。
フィールド | タイプ | 説明 |
---|---|---|
status | string | 対応する mongot でのインデックス生成の状態。 |
queryable | ブール値 | インデックス生成が対応する mongot でクエリされる準備ができているかどうかを示します。 |
synonymMappingStatus | string | 対応する mongot でのインデックス生成のシノニム マッピングの状態。 インデックスにシノニム(同意語)が定義されている場合にのみ存在します。 |
synonymMappingStatusDetails | ドキュメント | 対応する 詳細については、 「シノニム(同意語)マッピングの詳細」 を参照してください。 |
definitionVersion | ドキュメント | このインデックス生成がビルドされるインデックス定義バージョンを説明します。 |
definitionVersion.version | integer | インデックス生成が対応する mongot で使用しているバージョン番号。 インデックス定義を更新すると、更新されたインデックスは増分されたバージョン番号で構築されます。 |
definitionVersion.createdAt | date | インデックス定義が作成された時間。 |
definition | ドキュメント | このインデックスが構築される定義。 |
同義語マッピングの詳細
以下の表は、次のオブジェクトの埋め込みフィールドを説明したものです。
statusDetail.mainIndex.synonymMappingStatusDetails.<synonymMapping>
statusDetail.stagedIndex.synonymMappingStatusDetails<synonymMapping>
フィールド | タイプ | 説明 |
---|---|---|
status | string | 対応する mongot プロセス上の シノニム(同意語)マッピング のステータス。 |
queryable | ブール値 | シノニム マッピングが対応する mongot プロセスでのクエリをサポートできるかどうかを示します。 |
message | string | 該当する場合、シノニム マッピングのエラーを説明します。 このシノニム マッピングの status がFAILED の場合にのみ表示されます。 |
Atlas Search インデックス ステータス
getSearchIndexes()
出力のstatus
フィールドは次のいずれかになります。
ステータス | 説明 |
---|---|
BUILDING | 次のシナリオでは、インデックスが
インデックスが
|
DOES_NOT_EXIST | インデックスが存在しません。
|
DELETING | Atlas はインデックスを削除しています。
|
FAILED | インデックスのビルドに失敗しました。 無効なインデックス定義により、インデックスは
|
PENDING | Atlas によるインデックスの構築は開始されていません。
|
READY | インデックスは準備ができており、クエリをサポートできます。
|
STALE | インデックスはクエリ可能ですが、インデックス付きコレクションからのデータの複製は停止されました。 インデックスを検索すると、古いデータが返される場合があります。 レプリケーション エラーにより、インデックスが
|
例
これらの例は、次の方法を示しています。
すべての検索インデックスを返します
次の例では、 movies
コレクションのすべての Atlas Search インデックスを返します。 movies
コレクションには、 default
とsynonym_mappings
の 2 つの検索インデックスが含まれています。
db.movies.getSearchIndexes()
出力例:
[ { id: '6524096020da840844a4c4a7', name: 'default', status: 'BUILDING', queryable: true, latestDefinitionVersion: { version: 2, createdAt: ISODate("2023-10-09T14:51:57.355Z") }, latestDefinition: { mappings: { dynamic: true }, storedSource: { include: [ 'awards.text' ] } }, statusDetail: [ { hostname: 'atlas-n1cm1j-shard-00-02', status: 'BUILDING', queryable: true, mainIndex: { status: 'READY', queryable: true, definitionVersion: { version: 0, createdAt: ISODate("2023-10-09T14:08:32.000Z") }, definition: { mappings: { dynamic: true, fields: {} } } }, stagedIndex: { status: 'PENDING', queryable: false, definitionVersion: { version: 1, createdAt: ISODate("2023-10-09T14:51:29.000Z") }, definition: { mappings: { dynamic: true, fields: {} }, storedSource: true } } }, { hostname: 'atlas-n1cm1j-shard-00-01', status: 'BUILDING', queryable: true, mainIndex: { status: 'READY', queryable: true, definitionVersion: { version: 0, createdAt: ISODate("2023-10-09T14:08:32.000Z") }, definition: { mappings: { dynamic: true, fields: {} } } }, stagedIndex: { status: 'PENDING', queryable: false, definitionVersion: { version: 1, createdAt: ISODate("2023-10-09T14:51:29.000Z") }, definition: { mappings: { dynamic: true, fields: {} }, storedSource: true } } }, { hostname: 'atlas-n1cm1j-shard-00-00', status: 'BUILDING', queryable: true, mainIndex: { status: 'READY', queryable: true, definitionVersion: { version: 0, createdAt: ISODate("2023-10-09T14:08:32.000Z") }, definition: { mappings: { dynamic: true, fields: {} } } } } ] }, { id: '65240be420da840844a4d077', name: 'synonym_mappings', status: 'READY', queryable: true, latestDefinitionVersion: { version: 0, createdAt: ISODate("2023-10-09T14:19:16.305Z") }, latestDefinition: { mappings: { dynamic: true, fields: { fullplot: { type: 'string' } } }, synonyms: [ { name: 'synonym_mapping', analyzer: 'lucene.english', source: { collection: 'synonyms' } } ] }, synonymMappingStatus: 'READY', synonymMappingStatusDetail: [ { synonym_mapping: { status: 'READY', queryable: true } } ], statusDetail: [ { hostname: 'atlas-n1cm1j-shard-00-02', status: 'READY', queryable: true, mainIndex: { status: 'READY', queryable: true, definitionVersion: { version: 0, createdAt: ISODate("2023-10-09T14:19:16.000Z") }, definition: { mappings: { dynamic: true, fields: { fullplot: { type: 'string', indexOptions: 'offsets', store: true, norms: 'include' } } }, synonyms: [ { name: 'synonym_mapping', analyzer: 'lucene.english', source: { collection: 'synonyms' } } ] }, synonymMappingStatus: 'READY', synonymMappingStatusDetail: [ { synonym_mapping: { status: 'READY', queryable: true } } ] } }, { hostname: 'atlas-n1cm1j-shard-00-01', status: 'READY', queryable: true, mainIndex: { status: 'READY', queryable: true, definitionVersion: { version: 0, createdAt: ISODate("2023-10-09T14:19:16.000Z") }, definition: { mappings: { dynamic: true, fields: { fullplot: { type: 'string', indexOptions: 'offsets', store: true, norms: 'include' } } }, synonyms: [ { name: 'synonym_mapping', analyzer: 'lucene.english', source: { collection: 'synonyms' } } ] }, synonymMappingStatus: 'READY', synonymMappingStatusDetail: [ { synonym_mapping: { status: 'READY', queryable: true } } ] } }, { hostname: 'atlas-n1cm1j-shard-00-00', status: 'READY', queryable: true, mainIndex: { status: 'READY', queryable: true, definitionVersion: { version: 0, createdAt: ISODate("2023-10-09T14:19:16.000Z") }, definition: { mappings: { dynamic: true, fields: { fullplot: { type: 'string', indexOptions: 'offsets', store: true, norms: 'include' } } }, synonyms: [ { name: 'synonym_mapping', analyzer: 'lucene.english', source: { collection: 'synonyms' } } ] }, synonymMappingStatus: 'READY', synonymMappingStatusDetail: [ { synonym_mapping: { status: 'READY', queryable: true } } ] } } ] } ]
1 つの検索インデックスを返す
次の例では、 movies
コレクションのsynonym_mappings
インデックスを返します。
db.movies.getSearchIndexes("synonym_mappings")
出力例:
[ { id: '65240be420da840844a4d077', name: 'synonym_mappings', status: 'READY', queryable: true, latestDefinitionVersion: { version: 0, createdAt: ISODate("2023-10-09T14:19:16.305Z") }, latestDefinition: { mappings: { dynamic: true, fields: { fullplot: { type: 'string' } } }, synonyms: [ { name: 'synonym_mapping', analyzer: 'lucene.english', source: { collection: 'synonyms' } } ] }, synonymMappingStatus: 'READY', synonymMappingStatusDetail: [ { synonym_mapping: { status: 'READY', queryable: true } } ], statusDetail: [ { hostname: 'atlas-n1cm1j-shard-00-02', status: 'READY', queryable: true, mainIndex: { status: 'READY', queryable: true, definitionVersion: { version: 0, createdAt: ISODate("2023-10-09T14:19:16.000Z") }, definition: { mappings: { dynamic: true, fields: { fullplot: { type: 'string', indexOptions: 'offsets', store: true, norms: 'include' } } }, synonyms: [ { name: 'synonym_mapping', analyzer: 'lucene.english', source: { collection: 'synonyms' } } ] }, synonymMappingStatus: 'READY', synonymMappingStatusDetail: [ { synonym_mapping: { status: 'READY', queryable: true } } ] } }, { hostname: 'atlas-n1cm1j-shard-00-01', status: 'READY', queryable: true, mainIndex: { status: 'READY', queryable: true, definitionVersion: { version: 0, createdAt: ISODate("2023-10-09T14:19:16.000Z") }, definition: { mappings: { dynamic: true, fields: { fullplot: { type: 'string', indexOptions: 'offsets', store: true, norms: 'include' } } }, synonyms: [ { name: 'synonym_mapping', analyzer: 'lucene.english', source: { collection: 'synonyms' } } ] }, synonymMappingStatus: 'READY', synonymMappingStatusDetail: [ { synonym_mapping: { status: 'READY', queryable: true } } ] } }, { hostname: 'atlas-n1cm1j-shard-00-00', status: 'READY', queryable: true, mainIndex: { status: 'READY', queryable: true, definitionVersion: { version: 0, createdAt: ISODate("2023-10-09T14:19:16.000Z") }, definition: { mappings: { dynamic: true, fields: { fullplot: { type: 'string', indexOptions: 'offsets', store: true, norms: 'include' } } }, synonyms: [ { name: 'synonym_mapping', analyzer: 'lucene.english', source: { collection: 'synonyms' } } ] }, synonymMappingStatus: 'READY', synonymMappingStatusDetail: [ { synonym_mapping: { status: 'READY', queryable: true } } ] } } ] } ]