Atlas Search インデックス構文規則の確認

項目一覧

構文

オプション

Atlas Search はさまざまな方法でデータをインデックス化できます。 Atlas Search インデックスを定義するときに、特定のフィールドにインデックスを付けるための特定のアナライザまたは複数のアナライザを指定できます。詳しくは、「アナライザによるデータ処理」を参照してください。また、特定のフィールドにインデックスを付けて他のフィールドを省略したり、コレクション内のすべてのフィールドに動的にインデックスを付けることもできます。詳しくは「フィールドマッピングの定義」を参照してください。 Atlas Search インデックスは、 Atlas UI 、 Atlas Search API 、 Atlas CLI 、 mongosh 、またはドライバーを使用して定義できます。

このページでは、Atlas Search インデックスの JSON構文とフィールドについて説明します。

重要

$out 集計ステージを使用して Atlas Search インデックスを持つコレクションを変更する場合は、その検索インデックスを削除して再作成する必要があります。可能であれば、$out の代わりに $merge を使用することを検討してください。

構文

1 { 
2   "mappings": { 
3     "dynamic": <boolean>, 
4     "fields": { <field-definition> } 
5   }
6 }
7

1 {  
2   "analyzer": "<analyzer-for-index>", 
3   "searchAnalyzer": "<analyzer-for-query>", 
4   "mappings": { 
5     "dynamic": <boolean>, 
6     "fields": { <field-definition> } 
7   }, 
8   "analyzers": [ <custom-analyzer> ],
9   "storedSource": <boolean> | {
10     <stored-source-definition>
11   },
12   "synonyms": [
13     {
14       "name": "<synonym-mapping-name>",
15       "source": {
16         "collection": "<source-collection-name>"
17       },
18       "analyzer": "<synonym-mapping-analyzer>"
19     }
20   ] 
21 }
22

オプション

フィールド	タイプ	必要性	説明
`analyzer`	string	任意	インデックス作成時に string フィールドに適用するアナライザを指定します。これを上部のみに設定し、インデックス定義のフィールドのアナライザを指定しない場合、Atlas Search はこのアナライザをすべてのフィールドに適用します。各フィールドに異なるアナライザを使用するには、フィールドに異なるアナライザを指定する必要があります。省略した場合、デフォルトは標準アナライザになります。
`analyzers`	カスタムアナライザの配列	任意	このインデックスで使用するカスタムアナライザを指定します。
`mappings`	ドキュメントフィールドの定義	必須	このインデックスの異なるパスにあるフィールドのインデックス方法を指定します。
`mappings.dynamic`	ブール値	任意	このインデックスのフィールドの動的マッピングを有効または無効にします。 `true`に設定すると、Atlas Search はすべての動的にインデックス付け可能なフィールドを再帰的にインデックス化します。 `false`に設定されている場合は、 `mappings.fields`を使用してインデックスを作成するフィールドを個別に指定する必要があります。省略した場合、デフォルトは `false` になります。重要 Atlas Search は、検出されたデータ型のデフォルト設定を使用して、 `document`内のすべてのフィールドを動的にインデックス化します。 Atlas Search は、 `dynamic`を`false`に設定して明示的にオーバーライドしない限り、 `document`下にネストされたすべてのドキュメントを動的にインデックス化します。インデックス構成の例については、「静的マッピングの例」または「組み合わせマッピングの例」を参照してください
`mappings.fields`	ドキュメント	条件付き	インデックスを作成するフィールドを指定します。動的マッピングが無効になっている場合にのみ必要です。フィールド名の先頭にドル記号（`$`）が含まれるフィールドにはインデックスを付けられません。詳しくは「フィールドマッピングの定義」を参照してください。
`searchAnalyzer`	string	任意	クエリテキストで検索する前にクエリテキストに適用するアナライザを指定します。省略した場合、 `analyzer`オプションに指定したアナライザがデフォルトで使用されます。 `searchAnalyzer`オプションと`analyzer` オプションの両方を省略すると、はデフォルトで標準アナライザを使用します。
`storedSource`	ブール値または保存されたソース定義	任意	returnStoredSourceオプションを使用して、クエリ時検索用に保存するドキュメント内のフィールドを指定します。 Atlas Search ではすべてのデータ型のフィールドを保存できます。値は次のいずれかになります。 `true`: すべてのフィールドを保存 `false`、フィールドを保存しない場合ストレージから`include`または`exclude`にフィールドを指定するオブジェクト `storedSource` 次のいずれかのバージョンを実行している Atlas クラスターでのみ使用できます。 MongoDB 5.0.6+ MongoDB 6.0+ MongoDB 7.0+ 省略した場合、デフォルトは `false` になります。詳しくは、「 Atlas Search インデックスに保存されたソースフィールドの定義」を参照してください。
`synonyms`	シノニムマッピング定義の配列	任意	インデックスで使用するシノニムマッピング。インデックス定義には、シノニムマッピングを 1 つだけ含めることができます。詳しくは、「Atlas Search インデックスでのシノニムマッピングの定義」を参照してください。

戻る

4 : シノニムマッピングを構成する

下書きを再開または削除する

1	{
2	"mappings": {
3	"dynamic": <boolean>,
4	"fields": { <field-definition> }
5	}
6	}
7

1	{
2	"analyzer": "<analyzer-for-index>",
3	"searchAnalyzer": "<analyzer-for-query>",
4	"mappings": {
5	"dynamic": <boolean>,
6	"fields": { <field-definition> }
7	},
8	"analyzers": [ <custom-analyzer> ],
9	"storedSource": <boolean> \| {
10	<stored-source-definition>
11	},
12	"synonyms": [
13	{
14	"name": "<synonym-mapping-name>",
15	"source": {
16	"collection": "<source-collection-name>"
17	},
18	"analyzer": "<synonym-mapping-analyzer>"
19	}
20	]
21	}
22