db.コレクション.updateSearchIndex()（mongoshメソッド）

定義

db.collection.updateSearchIndex()

既存の Atlas SearchインデックスまたはAtlas ベクトル検索インデックスを更新します。

互換性

このメソッドは、次の環境でホストされている配置で使用できます。

• MongoDB Atlas はクラウドでの MongoDB 配置のためのフルマネージド サービスです

構文

コマンド構文:

db.<collection>.updateSearchIndex(
   <name>,
   {
      <definition>
   }
)

コマンドフィールド

updateSearchIndex() 次のフィールドを取ります。

{
   analyzer: "<analyzer-for-index>",
   searchAnalyzer: "<analyzer-for-query>",
   mappings: {
      dynamic: <boolean>,
      fields: { <field-definition> }
   },
   analyzers: [ <custom-analyzer> ],
   storedSource: <boolean> | {
      <stored-source-definition>
   },
   synonyms: [ {
      name: "<synonym-mapping-name>",
      source: {
         collection: "<source-collection-name>"
      },
      analyzer: "<synonym-mapping-analyzer>"
   } ]
}

{
  "fields": [
    {
      "type": "vector" | "filter",
      "path": "<field-to-index>",
      "numDimensions": <number-of-dimensions>,
      "similarity": "euclidean" | "cosine" | "dotProduct"
    }
  ]
}

動作

updateSearchIndex() は、新しいインデックス定義でインデックスのビルドをトリガーします。 コマンドから応答を受け取ってから更新されたインデックスが準備完了するまでの間に遅延が発生する可能性があります。

新しいインデックスの構築中も、古いインデックス定義は引き続きクエリをサポートできます。 新しいインデックスの作成が完了すると、古いインデックスは使用できなくなります。 検索インデックスのステータスを確認するには、 $listSearchIndexes集計ステージを使用します。

アクセス制御

配置でアクセス制御を適用する場合、 updateSearchIndex()を実行しているユーザーは、データベースまたはコレクションに対するupdateSearchIndex特権アクションを持っている必要があります。

{
   resource: {
      db : <database>,
      collection: <collection>
   },
   actions: [ "updateSearchIndex" ]
}

組み込みのreadWrite } ロールとrestoreロールによってupdateSearchIndex特権が付与されます。 次の例では、 qaデータベースでreadWriteロールを付与しています。

db.grantRolesToUser(
   "<user>",
   [ { role: "readWrite", db: "qa" } ]
)

例

次の例では、Atlas Search インデックスを新規作成し、そのインデックスを更新します。

1. moviesコレクションにsearchIndex01という名前の検索インデックスを作成します。

   db.movies.createSearchIndex(
      "searchIndex01",
      {
         mappings: { dynamic: true },
         storedSource: {
            exclude: [ "imdb.rating" ]
         }
      }
   )

2. searchIndex01インデックスを更新します。

   db.movies.updateSearchIndex(
      "searchIndex01",
      {
         mappings: { dynamic: true },
         storedSource: {
            exclude: [ "movies" ]
         }
      }
   )