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

定義

db.collection.createSearchIndex()

バージョン 7.0 の新機能 （6.0.7 以降でも利用可能）

指定されたコレクションまたはビューに、MongoDB Search インデックスまたは MongoDB Vector Search インデックスを作成します。

重要

mongosh メソッド

This page documents a mongosh method. This is not the documentation for database commands or language-specific drivers, such as Node.js.

データベースコマンドについては、createSearchIndexes コマンドを参照してください。

MongoDB API ドライバーについては、各言語の「MongoDB ドライバーのドキュメント」を参照してください。

互換性

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

MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud

MongoDB Enterprise 配置を実行中バージョン 8.2 以降の Kubernetes Operator
MongoDB Community 配置バージョン 8.2 以降を実行中

自己管理型配置の詳細については、「自己管理型配置に関するMongoDB Search 」を参照してください。

構文

コマンド構文:

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

コマンドフィールド

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

フィールド	タイプ	必要性	説明
`name`	string	任意	作成する検索インデックスの名前。単一のコレクションに同じ名前で複数のインデックスを作成することはできません。 `name`を指定しない場合、インデックスの名前は`default`になります。
`type`	string	任意	Type of search index to create. 次のいずれかを指定できます。 `search` `vectorSearch` `type`フィールドを省略した場合、インデックスタイプは`search`です。
`definition`	ドキュメント	必須	作成するインデックスを説明するドキュメント。 `definition`の構文は、標準検索インデックスを作成するか、ベクトル検索インデックスを作成するかによって異なります。 `definition`の構文については、以下を参照してください。検索インデックス定義構文ベクトル検索インデックスの定義構文

検索インデックス定義構文

検索インデックスの定義には、次のフィールドがあります。

{
   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>"
   } ]
}

フィールド	タイプ	必要性	説明
`analyzer`	string	任意	インデックス作成時に string フィールドに適用するアナライザを指定します。このフィールドを省略すると、インデックスは標準アナライザを使用します。
`searchAnalyzer`	string	任意	テキストが検索される前にクエリテキストに適用するアナライザを指定します。このフィールドを省略すると、インデックスは`analyzer`フィールドに指定されているのと同じアナライザを使用します。 `searchAnalyzer`フィールドと`analyzer` フィールドの両方を省略すると、インデックスは標準アナライザを使用します。
`mappings`	オブジェクト	必須	このインデックスの異なるパスにあるフィールドのインデックス方法を指定します。
`mappings.dynamic`	ブール値	任意	このインデックスの動的フィールドマッピングを有効または無効にします。 If set to `true`, the index contains all fields containing supported data types. `false`に設定されている場合は、 `mappings.fields`を使用してインデックスを作成するフィールドを個別に指定する必要があります。省略した場合、デフォルトは `false` になります。
`mappings.fields`	ドキュメント	条件付き	動的マッピングが無効になっている場合にのみ必要です。 Specifies the fields to index. To learn more, see Define Field Mappings for a MongoDB Search Index.
`analyzers`	配列	任意	このインデックスで使用するカスタムアナライザを指定します。
`storedSource`	ブール値または保存されたソース定義	任意	Specifies document fields to store for queries performed using the returnedStoredSource option. You can store fields of all MongoDB Search Field Types on MongoDB Search. The `storedSource` value can be one of these: `true`: すべてのフィールドを保存 `false`、フィールドを保存しない場合 An object that specifies the fields to `include` or `exclude` from storage 省略した場合、デフォルトは `false` になります。詳しくは、 MongoDB Search インデックスに保存されたソースフィールドの定義を参照してください。
`synonyms`	シノニム（同意語）マッピングの定義の配列	任意	インデックスで使用するシノニムマッピングを指定します。シノニム（同意語）を設定すると、同じ意味または似た意味を持つ単語をインデックスして検索できます。詳しくは、「 MongoDB Search インデックスでのシノニムマッピングの定義」を参照してください。

ベクトル検索インデックスの定義構文

ベクトル検索のインデックス定義には次のフィールドが含まれます。

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

ベクトル検索のインデックス定義フィールドの説明については、「ベクトル検索のフィールドにインデックスを作成する方法」を参照してください。

動作

createSearchIndex() インデックスの構築をトリガーします。コマンドからの応答を受け取ってから、インデックスが準備完了するまでの間に遅延が発生する可能性があります。

検索インデックスのステータスを確認するには、 $listSearchIndexes集計ステージを使用します。

アクセス制御

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

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

組み込みのreadWriteロールにはcreateSearchIndexes特権が付与されます。次の例では、 productsデータベースでaccountUser01にreadWriteロールを付与しています。

db.grantRolesToUser(
   "accountUser01",
   [ { role: "readWrite", db: "products" } ]
)

例

すべてのフィールドに検索インデックスを作成する

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

db.movies.createSearchIndex(
   "searchIndex01",
   { mappings: { dynamic: true } }
)

The index definition specifies mappings: { dynamic: true }, which means that the index contains all fields in the collection that have supported data types.

言語アナライザによる検索インデックスの作成

言語アナライザは、インデックスを作成するのに十分な重要ではない単語であるストップワードを導入します。

次の例では、 carsコレクションにfrenchIndex01という名前の検索インデックスを作成し、 frフィールドにlucene.frenchアナライザを指定します。

db.cars.createSearchIndex(
   "frenchIndex01",
   {
      mappings: {
         fields: {
            subject: {
               fields: {
                  fr: {
                     analyzer: "lucene.french",
                     type: "string"
                  }
               },
               type: "document"
            }
         }
      }
   }
)

言語アナライザの詳細については、「言語アナライザ」を参照してください。

デフォルト名で検索インデックスを作成

次のcreateSearchIndex()メソッドでは、インデックス定義のみを指定し、インデックス名を省略します。コマンドは、 foodコレクションにdefaultという名前の検索インデックスを作成します。

db.food.createSearchIndex(
   {
      mappings: {
         fields: {
            title: {
               type: "string"
            }
         }
      }
   }
)

ベクトル検索インデックスの作成

次の例では、 moviesコレクションにvectorSearchIndex01という名前のベクトル検索インデックスを作成します。

db.movies.createSearchIndex(
   "vectorSearchIndex01",
   "vectorSearch",
   {
      fields: [
         {
            type: "vector",
            numDimensions: 1,
            path: "genre",
            similarity: "cosine"
         }
      ]
   }
)

ベクトル検索インデックスには 1 つの次元が含まれており、 genreフィールドにインデックスが作成されます。

詳細

戻る

mongosh メソッド

db.collection.dropSearchIndex