検索インデックスを作成します

項目一覧

定義

構文
コマンドフィールド
検索インデックス定義構文
ベクトル検索インデックスの定義構文
動作
アクセス制御
出力
例
すべてのフィールドに検索インデックスを作成する
言語アナライザによる検索インデックスの作成
複数の検索インデックスの作成
ベクトル検索インデックスの作成
詳細

定義

createSearchIndexes

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

指定されたコレクションに 1 つ以上の Atlas Search インデックスまたはVector Search インデックスを作成します。

mongoshメソッド db.collection.createSearchIndex()はcreateSearchIndexesデータベースコマンドを囲むラッパーを提供します。

重要

このコマンドは、 MongoDB Atlas でホストされている配置でのみ実行でき、サーバーレスインスタンスで はサポートされていません 。

構文

コマンド構文:

db.runCommand(
   {
      createSearchIndexes: "<collection name>",
      indexes: [
         {
            name: "<index name>",
            type: "<search index type>",
            definition: {
               /* search index definition fields */
            }
        },
        ...
      ]
   }
)

コマンドフィールド

createSearchIndexes コマンドは、次のフィールドがあります。

フィールド	タイプ	必要性	説明
`createSearchIndexes`	string	必須	検索インデックスを作成するコレクションの名前。
`indexes`	配列	必須	作成するインデックスを説明するドキュメントの配列。
`indexes.name`	string	任意	作成する検索インデックスの名前。単一のコレクションに同じ名前で複数のインデックスを作成することはできません。 `name`を指定しない場合、インデックスの名前は`default`になります。
`indexes.type`	string	任意	Type of search index to create. 次のいずれかを指定できます。 `search` `vectorSearch` `type`フィールドを省略した場合、インデックスタイプは`search`です。
`indexes.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`	ブール値	任意	このインデックスの動的フィールドマッピングを有効または無効にします。 `true`に設定されている場合、インデックスにはサポートされているデータ型を含むすべてのフィールドが含まれます。 `false`に設定されている場合は、 `mappings.fields`を使用してインデックスを作成するフィールドを個別に指定する必要があります。省略した場合、デフォルトは `false` になります。
`mappings.fields`	ドキュメント	条件付き	動的マッピングが無効になっている場合にのみ必要です。インデックスを作成するフィールドを指定します。詳しくは「フィールドマッピングの定義」を参照してください。
`analyzers`	配列	任意	このインデックスで使用するカスタムアナライザを指定します。
`storedSource`	ブール値または保存されたソース定義	任意	返された StoredSource オプションを使用して実行されるクエリに保存するドキュメントフィールドを指定します。 Atlas Search ではすべてのデータ型のフィールドを保存できます。 `storedSource`の値は次のいずれかになります。 `true`: すべてのフィールドを保存 `false`、フィールドを保存しない場合ストレージから`include`または`exclude`にフィールドを指定するオブジェクト省略した場合、デフォルトは `false` になります。詳しくは、「 Atlas Search インデックスに保存されたソースフィールドの定義」を参照してください。
`synonyms`	シノニム（同意語）マッピングの定義の配列	任意	インデックスで使用するシノニムマッピングを指定します。シノニム（同意語）を設定すると、同じ意味または似た意味を持つ単語をインデックスして検索できます。詳しくは、「 Atlas Search インデックスでのシノニムマッピングの定義」を参照してください。

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

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

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

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

動作

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

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

アクセス制御

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

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

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

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

出力

createSearchIndexesコマンドの出力は次のようになります。

{
   ok: 1,
   indexesCreated: [
      {
         id: "<index Id>",
         name: "<index name>"
      }
   ]
}

重要

応答フィールドok: 1は、コマンドが成功したことを示します。ただし、応答を受け取ってから作成されたインデックスが使用可能になるまでの間にタイムラグが生じる可能性があります。

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

例

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

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

db.runCommand( {
   createSearchIndexes: "contacts",
   indexes: [
      {
         name: "searchIndex01",
         definition: { mappings: { dynamic: true } }
      }
   ]
} )

インデックス定義でmappings: { dynamic: true }が指定されています。つまり、インデックスにはコレクション内のデータ型をサポートしているすべてのフィールドが含まれています。

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

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

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

db.runCommand( {
   createSearchIndexes: "cars",
   indexes: [
      {
         name: "frenchIndex01",
         definition: {
            mappings: {
              fields: {
                subject: {
                  fields: {
                    fr: {
                      analyzer: "lucene.french",
                      type: "string"
                    }
                  },
                  type: "document"
                }
              }
            }
          }
      }
   ]
} )

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

複数の検索インデックスの作成

次のコマンドは、 productsコレクションに 2 つの検索インデックス（ searchIndex02とsearchIndex03を作成します。

db.runCommand( {
   createSearchIndexes: "products",
   indexes: [
      {
         name: "searchIndex02",
         definition: {
            mappings: {
               fields: {
                  title: {
                     type: "string",
                     analyzer: "lucene.simple"
                  }
               }
            }
         }
      },
      {
         name: "searchIndex03",
         definition:
            {
               mappings: { dynamic: true }
            }
      }
   ]
} )

searchIndex02 は、 titleフィールドで単純なアナライザを使用します。単純なアナライザは、空白、句読点、数字など、文字以外の文字に基づいてテキストを検索可能なタームに分割します。

searchIndex03 は動的フィールドマッピングを使用するため、インデックスにはコレクション内のデータ型をサポートしたすべてのフィールドが含まれています。

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

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

db.runCommand( {
   createSearchIndexes: "movies",
   indexes: [
      {
         name: "vectorSearchIndex01",
         type: "vectorSearch",
         definition: {
            fields: [
               {
                  type: "vector",
                  numDimensions: 1,
                  path: "genre",
                  similarity: "cosine"
               }
            ]
         }
      }
   ]
} )

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

詳細

戻る

Atlas Search

dropSearchIndex