Skip to content

Commit

Permalink
[DOCS] Fix source filtering xrefs (#57720) (#57727)
Browse files Browse the repository at this point in the history
  • Loading branch information
jrodewig authored Jun 5, 2020
1 parent 4acbdd0 commit 58ed754
Show file tree
Hide file tree
Showing 7 changed files with 9 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The top_hits aggregation returns regular search hits, because of this many per h
* <<request-body-search-highlighting,Highlighting>>
* <<request-body-search-explain,Explain>>
* <<request-body-search-queries-and-filters,Named filters and queries>>
* <<request-body-search-source-filtering,Source filtering>>
* <<search-fields,Source filtering>>
* <<request-body-search-stored-fields,Stored fields>>
* <<request-body-search-script-fields,Script fields>>
* <<request-body-search-docvalue-fields,Doc value fields>>
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/mapping/fields/source-field.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ stored.
WARNING: Removing fields from the `_source` has similar downsides to disabling
`_source`, especially the fact that you cannot reindex documents from one
Elasticsearch index to another. Consider using
<<request-body-search-source-filtering,source filtering>> instead.
<<search-fields,source filtering>> instead.

The `includes`/`excludes` parameters (which also accept wildcards) can be used
as follows:
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/mapping/params/store.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Usually this doesn't matter. The field value is already part of the
<<mapping-source-field,`_source` field>>, which is stored by default. If you
only want to retrieve the value of a single field or of a few fields, instead
of the whole `_source`, then this can be achieved with
<<request-body-search-source-filtering,source filtering>>.
<<search-fields,source filtering>>.

In certain situations it can make sense to `store` a field. For instance, if
you have a document with a `title`, a `date`, and a very large `content`
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/search/request/stored-fields.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

WARNING: The `stored_fields` parameter is about fields that are explicitly marked as
stored in the mapping, which is off by default and generally not recommended.
Use <<request-body-search-source-filtering,source filtering>> instead to select
Use <<search-fields,source filtering>> instead to select
subsets of the original source document to be returned.

Allows to selectively load specific stored fields for each document represented
Expand Down Expand Up @@ -62,5 +62,5 @@ GET /_search
}
--------------------------------------------------

NOTE: <<request-body-search-source-filtering,`_source`>> and <<request-body-search-version, `version`>> parameters cannot be activated if `_none_` is used.
NOTE: <<search-fields,`_source`>> and <<request-body-search-version, `version`>> parameters cannot be activated if `_none_` is used.

5 changes: 2 additions & 3 deletions docs/reference/search/search-fields.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,8 @@
By default, each hit in the search response includes the document
<<mapping-source-field,`_source`>>, which is the entire JSON object that was
provided when indexing the document. If you only need certain fields in the
search response, you can use the
<<request-body-search-source-filtering,`_source`>> parameter to restrict what
parts of the source are returned. This is called _source filtering_.
search response, you can use the `_source` parameter to restrict what parts of
the source are returned. This is called _source filtering_.

.*Example*
[%collapsible]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ The configured weight for a suggestion is returned as `_score`. The
return the full document `_source` by default. The size of the `_source`
can impact performance due to disk fetch and network transport overhead.
To save some network overhead, filter out unnecessary fields from the `_source`
using <<request-body-search-source-filtering, source filtering>> to minimize
using <<search-fields, source filtering>> to minimize
`_source` size. Note that the _suggest endpoint doesn't support source
filtering but using suggest on the `_search` endpoint does:

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/snapshot-restore/apis/put-repo-api.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ source-only snapshots that take up to 50% less space on disk.
+
Source-only snapshots are only supported if the <<mapping-source-field,`_source`
field>> is enabled and no
<<request-body-search-source-filtering,source-filtering>> is applied.
<<search-fields,source-filtering>> is applied.
+
WARNING: Source-only snapshots contain stored fields and index metadata. They do
not include index or doc values structures and are not searchable when restored.
Expand Down

0 comments on commit 58ed754

Please sign in to comment.