From 50ee0331803365adbf9033a623a1794fd6be81c6 Mon Sep 17 00:00:00 2001 From: Leo Antoli <430982+lantoli@users.noreply.github.com> Date: Thu, 11 Jul 2024 12:25:53 +0200 Subject: [PATCH] doc --- website/docs/d/search_index.html.markdown | 4 +- website/docs/d/search_indexes.html.markdown | 4 +- website/docs/r/search_index.html.markdown | 60 ++++++++++++--------- 3 files changed, 37 insertions(+), 31 deletions(-) diff --git a/website/docs/d/search_index.html.markdown b/website/docs/d/search_index.html.markdown index ebe0b7fc81..2eae237422 100644 --- a/website/docs/d/search_index.html.markdown +++ b/website/docs/d/search_index.html.markdown @@ -45,8 +45,6 @@ data "mongodbatlas_search_index" "test" { * `synonyms.#.name` - Name of the [synonym mapping definition](https://docs.atlas.mongodb.com/reference/atlas-search/synonyms/#std-label-synonyms-ref). * `synonyms.#.source_collection` - Name of the source MongoDB collection for the synonyms. * `synonyms.#.analyzer` - Name of the [analyzer](https://docs.atlas.mongodb.com/reference/atlas-search/analyzers/#std-label-analyzers-ref) to use with this synonym mapping. - - - +* `stored_source` - String that can be "true" (store all fields), "false" (default, don't store any field), or a JSON string that contains the list of fields to store (include) or not store (exclude) on Atlas Search. To learn more, see [Stored Source Fields](https://www.mongodb.com/docs/atlas/atlas-search/stored-source-definition/). For more information see: [MongoDB Atlas API Reference.](https://docs.atlas.mongodb.com/atlas-search/) - [and MongoDB Atlas API - Search](https://docs.atlas.mongodb.com/reference/api/atlas-search/) Documentation for more information. diff --git a/website/docs/d/search_indexes.html.markdown b/website/docs/d/search_indexes.html.markdown index 882acdf00c..84b346244b 100644 --- a/website/docs/d/search_indexes.html.markdown +++ b/website/docs/d/search_indexes.html.markdown @@ -51,8 +51,6 @@ data "mongodbatlas_search_indexes" "test" { * `synonyms.#.name` - Name of the [synonym mapping definition](https://docs.atlas.mongodb.com/reference/atlas-search/synonyms/#std-label-synonyms-ref). * `synonyms.#.source_collection` - Name of the source MongoDB collection for the synonyms. * `synonyms.#.analyzer` - Name of the [analyzer](https://docs.atlas.mongodb.com/reference/atlas-search/analyzers/#std-label-analyzers-ref) to use with this synonym mapping. - - - +* `stored_source` - String that can be "true" (store all fields), "false" (default, don't store any field), or a JSON string that contains the list of fields to store (include) or not store (exclude) on Atlas Search. To learn more, see [Stored Source Fields](https://www.mongodb.com/docs/atlas/atlas-search/stored-source-definition/). For more information see: [MongoDB Atlas API Reference.](https://docs.atlas.mongodb.com/atlas-search/) - [and MongoDB Atlas API - Search](https://docs.atlas.mongodb.com/reference/api/atlas-search/) Documentation for more information. diff --git a/website/docs/r/search_index.html.markdown b/website/docs/r/search_index.html.markdown index 6b7d44f4eb..b695c7ca1c 100644 --- a/website/docs/r/search_index.html.markdown +++ b/website/docs/r/search_index.html.markdown @@ -162,35 +162,36 @@ EOF ```terraform mappings_fields = <<-EOF { - "address": { - "type": "document", - "fields": { - "city": { - "type": "string", - "analyzer": "lucene.simple", - "ignoreAbove": 255 - }, - "state": { - "type": "string", - "analyzer": "lucene.english" + "address": { + "type": "document", + "fields": { + "city": { + "type": "string", + "analyzer": "lucene.simple", + "ignoreAbove": 255 + }, + "state": { + "type": "string", + "analyzer": "lucene.english" + } } - } - }, - "company": { - "type": "string", - "analyzer": "lucene.whitespace", - "multi": { - "mySecondaryAnalyzer": { - "type": "string", - "analyzer": "lucene.french" + }, + "company": { + "type": "string", + "analyzer": "lucene.whitespace", + "multi": { + "mySecondaryAnalyzer": { + "type": "string", + "analyzer": "lucene.french" + } } - } - }, - "employees": { - "type": "string", - "analyzer": "lucene.standard" + }, + "employees": { + "type": "string", + "analyzer": "lucene.standard" } } + EOF ``` * `search_analyzer` - [Analyzer](https://docs.atlas.mongodb.com/reference/atlas-search/analyzers/#std-label-analyzers-ref) to use when searching the index. Defaults to [lucene.standard](https://docs.atlas.mongodb.com/reference/atlas-search/analyzers/standard/#std-label-ref-standard-analyzer) @@ -198,6 +199,15 @@ EOF * `fields` - Array of [Fields](https://www.mongodb.com/docs/atlas/atlas-search/field-types/knn-vector/#std-label-fts-data-types-knn-vector) to configure this `vectorSearch` index. It is mandatory for vector searches and it must contain at least one `vector` type field. This field needs to be a JSON string in order to be decoded correctly. +* `stored_source` - String that can be "true" (store all fields), "false" (default, don't store any field), or a JSON string that contains the list of fields to store (include) or not store (exclude) on Atlas Search. To learn more, see [Stored Source Fields](https://www.mongodb.com/docs/atlas/atlas-search/stored-source-definition/). + ```terraform + stored_source = <<-EOF + { + "include": ["field1", "field2"] + } + EOF + ``` + ## Attributes Reference In addition to all arguments above, the following attributes are exported: