diff --git a/client/rest-high-level/src/main/java/org/elasticsearch/client/IndicesClient.java b/client/rest-high-level/src/main/java/org/elasticsearch/client/IndicesClient.java index 584bdad74502..42791b719c4e 100644 --- a/client/rest-high-level/src/main/java/org/elasticsearch/client/IndicesClient.java +++ b/client/rest-high-level/src/main/java/org/elasticsearch/client/IndicesClient.java @@ -569,7 +569,7 @@ public final class IndicesClient { /** * Initiate a synced flush manually using the synced flush API. - * See + * See * Synced flush API on elastic.co * @param syncedFlushRequest the request * @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized @@ -583,7 +583,7 @@ public final class IndicesClient { /** * Asynchronously initiate a synced flush manually using the synced flush API. - * See + * See * Synced flush API on elastic.co * @param syncedFlushRequest the request * @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized diff --git a/client/rest-high-level/src/main/java/org/elasticsearch/client/RestHighLevelClient.java b/client/rest-high-level/src/main/java/org/elasticsearch/client/RestHighLevelClient.java index 35abf5e85180..4e1a571ec656 100644 --- a/client/rest-high-level/src/main/java/org/elasticsearch/client/RestHighLevelClient.java +++ b/client/rest-high-level/src/main/java/org/elasticsearch/client/RestHighLevelClient.java @@ -1010,8 +1010,9 @@ public class RestHighLevelClient implements Closeable { /** * Executes a search using the Search Scroll API. - * See Search Scroll - * API on elastic.co + * See Search + * Scroll API on elastic.co * @param searchScrollRequest the request * @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized * @return the response @@ -1024,8 +1025,9 @@ public class RestHighLevelClient implements Closeable { /** * Executes a search using the Search Scroll API. - * See Search Scroll - * API on elastic.co + * See Search + * Scroll API on elastic.co * @param searchScrollRequest the request * @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized * @return the response @@ -1037,8 +1039,9 @@ public class RestHighLevelClient implements Closeable { /** * Asynchronously executes a search using the Search Scroll API. - * See Search Scroll - * API on elastic.co + * See Search + * Scroll API on elastic.co * @param searchScrollRequest the request * @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized * @param listener the listener to be notified upon request completion @@ -1052,8 +1055,9 @@ public class RestHighLevelClient implements Closeable { /** * Asynchronously executes a search using the Search Scroll API. - * See Search Scroll - * API on elastic.co + * See Search + * Scroll API on elastic.co * @param searchScrollRequest the request * @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized * @param listener the listener to be notified upon request completion @@ -1066,7 +1070,8 @@ public class RestHighLevelClient implements Closeable { /** * Clears one or more scroll ids using the Clear Scroll API. - * See + * See * Clear Scroll API on elastic.co * @param clearScrollRequest the request * @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized @@ -1079,7 +1084,8 @@ public class RestHighLevelClient implements Closeable { /** * Asynchronously clears one or more scroll ids using the Clear Scroll API. - * See + * See * Clear Scroll API on elastic.co * @param clearScrollRequest the request * @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized diff --git a/docs/java-rest/high-level/document/multi-get.asciidoc b/docs/java-rest/high-level/document/multi-get.asciidoc index ca26139d2305..1cf487dec139 100644 --- a/docs/java-rest/high-level/document/multi-get.asciidoc +++ b/docs/java-rest/high-level/document/multi-get.asciidoc @@ -65,7 +65,7 @@ include-tagged::{doc-tests-file}[{api}-request-item-extras] <2> Version <3> Version type -{ref}/search-request-preference.html[`preference`], +{ref}/search-request-body.html#request-body-search-preference[`preference`], {ref}/docs-get.html#realtime[`realtime`] and {ref}/docs-get.html#get-refresh[`refresh`] can be set on the main request but diff --git a/docs/java-rest/high-level/search/search.asciidoc b/docs/java-rest/high-level/search/search.asciidoc index 1c454ce6ba14..2ec7c3122b7a 100644 --- a/docs/java-rest/high-level/search/search.asciidoc +++ b/docs/java-rest/high-level/search/search.asciidoc @@ -430,7 +430,7 @@ include-tagged::{doc-tests-file}[{api}-request-profiling-queries-results] <3> Retrieve the time in millis spent executing the Lucene query <4> Retrieve the profile results for the sub-queries (if any) -The Rest API documentation contains more information about {ref}/search-profile-queries.html[Profiling Queries] with +The Rest API documentation contains more information about {ref}/search-profile.html#profiling-queries[Profiling Queries] with a description of the query profiling information. The `QueryProfileShardResult` also gives access to the profiling information for the Lucene collectors: @@ -445,7 +445,7 @@ include-tagged::{doc-tests-file}[{api}-request-profiling-queries-collectors] <4> Retrieve the profile results for the sub-collectors (if any) The Rest API documentation contains more information about profiling information -for Lucene collectors. See {ref}/search-profile-queries.html[Profiling queries]. +for Lucene collectors. See {ref}/search-profile.html#profiling-queries[Profiling queries]. In a very similar manner to the query tree execution, the `QueryProfileShardResult` objects gives access to the detailed aggregations tree execution: @@ -461,4 +461,4 @@ include-tagged::{doc-tests-file}[{api}-request-profiling-aggs] <5> Retrieve the profile results for the sub-aggregations (if any) The Rest API documentation contains more information about -{ref}/search-profile-aggregations.html[Profiling aggregations]. +{ref}/search-profile.html#profiling-aggregations[Profiling aggregations]. diff --git a/docs/painless/painless-contexts.asciidoc b/docs/painless/painless-contexts.asciidoc index ccc9e3ac4db2..3bb3fc7d97e2 100644 --- a/docs/painless/painless-contexts.asciidoc +++ b/docs/painless/painless-contexts.asciidoc @@ -23,7 +23,7 @@ specialized code may define new ways to use a Painless script. | Reindex | <> | {ref}/docs-reindex.html[Elasticsearch Documentation] | Sort | <> - | {ref}/search-request-sort.html[Elasticsearch Documentation] + | {ref}/search-request-body.html#request-body-search-sort[Elasticsearch Documentation] | Similarity | <> | {ref}/index-modules-similarity.html[Elasticsearch Documentation] | Weight | <> @@ -31,7 +31,7 @@ specialized code may define new ways to use a Painless script. | Score | <> | {ref}/query-dsl-function-score-query.html[Elasticsearch Documentation] | Field | <> - | {ref}/search-request-script-fields.html[Elasticsearch Documentation] + | {ref}/search-request-body.html#request-body-search-script-fields[Elasticsearch Documentation] | Filter | <> | {ref}/query-dsl-script-query.html[Elasticsearch Documentation] | Minimum should match | <> diff --git a/docs/painless/painless-contexts/painless-field-context.asciidoc b/docs/painless/painless-contexts/painless-field-context.asciidoc index 5a95e88c6846..3a3e9fe0adb9 100644 --- a/docs/painless/painless-contexts/painless-field-context.asciidoc +++ b/docs/painless/painless-contexts/painless-field-context.asciidoc @@ -2,7 +2,7 @@ === Field context Use a Painless script to create a -{ref}/search-request-script-fields.html[script field] to return +{ref}/search-request-body.html#request-body-search-script-fields[script field] to return a customized value for each document in the results of a query. *Variables* diff --git a/docs/painless/painless-contexts/painless-sort-context.asciidoc b/docs/painless/painless-contexts/painless-sort-context.asciidoc index 4a7743dc4880..74bce44c800f 100644 --- a/docs/painless/painless-contexts/painless-sort-context.asciidoc +++ b/docs/painless/painless-contexts/painless-sort-context.asciidoc @@ -2,7 +2,7 @@ === Sort context Use a Painless script to -{ref}/search-request-sort.html[sort] the documents in a query. +{ref}/search-request-body.html#request-body-search-sort[sort] the documents in a query. *Variables* diff --git a/docs/reference/aggregations/bucket/composite-aggregation.asciidoc b/docs/reference/aggregations/bucket/composite-aggregation.asciidoc index 0a75c5809606..44a0ac79929c 100644 --- a/docs/reference/aggregations/bucket/composite-aggregation.asciidoc +++ b/docs/reference/aggregations/bucket/composite-aggregation.asciidoc @@ -6,7 +6,7 @@ A multi-bucket aggregation that creates composite buckets from different sources Unlike the other `multi-bucket` aggregation the `composite` aggregation can be used to paginate **all** buckets from a multi-level aggregation efficiently. This aggregation provides a way to stream **all** buckets of a specific aggregation similarly to what -<> does for documents. +<> does for documents. The composite buckets are built from the combinations of the values extracted/created for each document and each combination is considered as diff --git a/docs/reference/aggregations/metrics/tophits-aggregation.asciidoc b/docs/reference/aggregations/metrics/tophits-aggregation.asciidoc index 1ea38fec9657..29949bd3582c 100644 --- a/docs/reference/aggregations/metrics/tophits-aggregation.asciidoc +++ b/docs/reference/aggregations/metrics/tophits-aggregation.asciidoc @@ -17,15 +17,15 @@ One or more bucket aggregators determines by which properties a result set get s The top_hits aggregation returns regular search hits, because of this many per hit features can be supported: -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> ==== Example diff --git a/docs/reference/aggregations/pipeline/bucket-sort-aggregation.asciidoc b/docs/reference/aggregations/pipeline/bucket-sort-aggregation.asciidoc index d219e005d75d..a11da760edd0 100644 --- a/docs/reference/aggregations/pipeline/bucket-sort-aggregation.asciidoc +++ b/docs/reference/aggregations/pipeline/bucket-sort-aggregation.asciidoc @@ -38,7 +38,7 @@ is ascending. [options="header"] |=== |Parameter Name |Description |Required |Default Value -|`sort` |The list of fields to sort on. See <> for more details. |Optional | +|`sort` |The list of fields to sort on. See <> for more details. |Optional | |`from` |Buckets in positions prior to the set value will be truncated. |Optional | `0` |`size` |The number of buckets to return. Defaults to all buckets of the parent aggregation. |Optional | |`gap_policy` |The policy to apply when gaps are found in the data (see <> for more diff --git a/docs/reference/analysis/tokenizers/edgengram-tokenizer.asciidoc b/docs/reference/analysis/tokenizers/edgengram-tokenizer.asciidoc index 2e3ae8b036c3..94f5930e88cf 100644 --- a/docs/reference/analysis/tokenizers/edgengram-tokenizer.asciidoc +++ b/docs/reference/analysis/tokenizers/edgengram-tokenizer.asciidoc @@ -10,7 +10,7 @@ Edge N-Grams are useful for _search-as-you-type_ queries. TIP: When you need _search-as-you-type_ for text which has a widely known order, such as movie or song titles, the -<> is a much more efficient +<> is a much more efficient choice than edge N-grams. Edge N-grams have the advantage when trying to autocomplete words that can appear in any order. diff --git a/docs/reference/docs/concurrency-control.asciidoc b/docs/reference/docs/concurrency-control.asciidoc index eeb5aca4ed03..fccdbe46bbd6 100644 --- a/docs/reference/docs/concurrency-control.asciidoc +++ b/docs/reference/docs/concurrency-control.asciidoc @@ -87,7 +87,7 @@ returns: Note: The <> can return the `_seq_no` and `_primary_term` -for each search hit by setting <>. +for each search hit by setting <>. The sequence number and the primary term uniquely identify a change. By noting down the sequence number and primary term returned, you can make sure to only change the diff --git a/docs/reference/docs/update.asciidoc b/docs/reference/docs/update.asciidoc index af2bf8e9b0cc..23470ccdaef3 100644 --- a/docs/reference/docs/update.asciidoc +++ b/docs/reference/docs/update.asciidoc @@ -330,7 +330,7 @@ Control when the changes made by this request are visible to search. See Allows to control if and how the updated source should be returned in the response. By default the updated source is not returned. -See <> for details. +See <> for details. `if_seq_no` and `if_primary_term`:: diff --git a/docs/reference/getting-started.asciidoc b/docs/reference/getting-started.asciidoc index 0477b4acd727..f68ebd05093b 100755 --- a/docs/reference/getting-started.asciidoc +++ b/docs/reference/getting-started.asciidoc @@ -722,7 +722,7 @@ The accuracy of `hits.total` is controlled by the request parameter `track_total the request will track the total hits accurately (`"relation": "eq"`). It defaults to `10,000` which means that the total hit count is accurately tracked up to `10,000` documents. You can force an accurate count by setting `track_total_hits` to true explicitly. -See the <> documentation +See the <> documentation for more details. Here is the same exact search above using the alternative request body method: diff --git a/docs/reference/how-to/general.asciidoc b/docs/reference/how-to/general.asciidoc index b78ef63b4c81..9633c7fe843f 100644 --- a/docs/reference/how-to/general.asciidoc +++ b/docs/reference/how-to/general.asciidoc @@ -9,7 +9,7 @@ Elasticsearch is designed as a search engine, which makes it very good at getting back the top documents that match a query. However, it is not as good for workloads that fall into the database domain, such as retrieving all documents that match a particular query. If you need to do this, make sure to -use the <> API. +use the <> API. [float] [[maximum-document-size]] @@ -27,7 +27,7 @@ needs to fetch the `_id` of the document in all cases, and the cost of getting this field is bigger for large documents due to how the filesystem cache works. Indexing this document can use an amount of memory that is a multiplier of the original size of the document. Proximity search (phrase queries for instance) -and <> also become more expensive +and <> also become more expensive since their cost directly depends on the size of the original document. It is sometimes useful to reconsider what the unit of information should be. diff --git a/docs/reference/how-to/recipes/scoring.asciidoc b/docs/reference/how-to/recipes/scoring.asciidoc index 25425277839f..90bff3098571 100644 --- a/docs/reference/how-to/recipes/scoring.asciidoc +++ b/docs/reference/how-to/recipes/scoring.asciidoc @@ -29,7 +29,7 @@ are different too. The recommended way to work around this issue is to use a string that identifies the user that is logged is (a user id or session id for instance) as a -<>. This ensures that all queries of a +<>. This ensures that all queries of a given user are always going to hit the same shards, so scores remain more consistent across queries. diff --git a/docs/reference/index-modules.asciidoc b/docs/reference/index-modules.asciidoc index e34a4483ab6e..aa95bb8fa2e3 100644 --- a/docs/reference/index-modules.asciidoc +++ b/docs/reference/index-modules.asciidoc @@ -124,7 +124,7 @@ specific index module: The maximum value of `from + size` for searches to this index. Defaults to `10000`. Search requests take heap memory and time proportional to `from + size` and this limits that memory. See - <> or <> for a more efficient alternative + <> or <> for a more efficient alternative to raising this. `index.max_inner_result_window`:: diff --git a/docs/reference/index-modules/allocation/delayed.asciidoc b/docs/reference/index-modules/allocation/delayed.asciidoc index 907d927fd68d..c6626a9dec32 100644 --- a/docs/reference/index-modules/allocation/delayed.asciidoc +++ b/docs/reference/index-modules/allocation/delayed.asciidoc @@ -28,7 +28,7 @@ this scenario: If the master had just waited for a few minutes, then the missing shards could have been re-allocated to Node 5 with the minimum of network traffic. This process would be even quicker for idle shards (shards not receiving indexing -requests) which have been automatically <>. +requests) which have been automatically <>. The allocation of replica shards which become unassigned because a node has left can be delayed with the `index.unassigned.node_left.delayed_timeout` diff --git a/docs/reference/mapping.asciidoc b/docs/reference/mapping.asciidoc index d0a3c6e06cd6..8b6b1af3e589 100644 --- a/docs/reference/mapping.asciidoc +++ b/docs/reference/mapping.asciidoc @@ -47,7 +47,7 @@ Each field has a data `type` which can be: * a type which supports the hierarchical nature of JSON such as <> or <>. * or a specialised type like <>, - <>, or <>. + <>, or <>. It is often useful to index the same field in different ways for different purposes. For instance, a `string` field could be <> as diff --git a/docs/reference/mapping/fields/source-field.asciidoc b/docs/reference/mapping/fields/source-field.asciidoc index c9fd2cf18690..78cef20ea81b 100644 --- a/docs/reference/mapping/fields/source-field.asciidoc +++ b/docs/reference/mapping/fields/source-field.asciidoc @@ -36,7 +36,7 @@ available then a number of features are not supported: * The <>, <>, and <> APIs. -* On the fly <>. +* On the fly <>. * The ability to reindex from one Elasticsearch index to another, either to change mappings or analysis, or to upgrade an index to a new major @@ -77,7 +77,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 -<> instead. +<> instead. The `includes`/`excludes` parameters (which also accept wildcards) can be used as follows: diff --git a/docs/reference/mapping/params/store.asciidoc b/docs/reference/mapping/params/store.asciidoc index d3ebe13d4ad6..7316499b6a42 100644 --- a/docs/reference/mapping/params/store.asciidoc +++ b/docs/reference/mapping/params/store.asciidoc @@ -9,7 +9,7 @@ Usually this doesn't matter. The field value is already part of the <>, 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 -<>. +<>. 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` diff --git a/docs/reference/mapping/types.asciidoc b/docs/reference/mapping/types.asciidoc index b3ad39677d86..4d97e4b40aad 100644 --- a/docs/reference/mapping/types.asciidoc +++ b/docs/reference/mapping/types.asciidoc @@ -30,7 +30,7 @@ string:: <> and <> === Specialised datatypes <>:: `ip` for IPv4 and IPv6 addresses -<>:: +<>:: `completion` to provide auto-complete suggestions <>:: `token_count` to count the number of tokens in a string {plugins}/mapper-murmur3.html[`mapper-murmur3`]:: `murmur3` to compute hashes of values at index-time and store them in the index diff --git a/docs/reference/mapping/types/nested.asciidoc b/docs/reference/mapping/types/nested.asciidoc index 63bb4591369e..1f9ad2e2d2cd 100644 --- a/docs/reference/mapping/types/nested.asciidoc +++ b/docs/reference/mapping/types/nested.asciidoc @@ -171,8 +171,8 @@ For instance, if a string field within a nested document has during the highlighting, these offsets will not be available during the main highlighting phase. Instead, highlighting needs to be performed via <>. The same consideration applies when loading -fields during a search through <> -or <>. +fields during a search through <> +or <>. ============================================= diff --git a/docs/reference/ml/anomaly-detection/apis/put-datafeed.asciidoc b/docs/reference/ml/anomaly-detection/apis/put-datafeed.asciidoc index 385476b12c0b..fa99d311ff01 100644 --- a/docs/reference/ml/anomaly-detection/apis/put-datafeed.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/put-datafeed.asciidoc @@ -94,7 +94,7 @@ those same roles. returns script fields to the {dfeed}. The <> in a job can contain functions that use these script fields. For more information, see - <>. + <>. `scroll_size`:: (Optional, unsigned integer) The `size` parameter that is used in {es} diff --git a/docs/reference/ml/anomaly-detection/apis/update-datafeed.asciidoc b/docs/reference/ml/anomaly-detection/apis/update-datafeed.asciidoc index 1e4ca70aa877..f6b835cda281 100644 --- a/docs/reference/ml/anomaly-detection/apis/update-datafeed.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/update-datafeed.asciidoc @@ -86,7 +86,7 @@ The following properties can be updated after the {dfeed} is created: returns script fields to the {dfeed}. The <> in a job can contain functions that use these script fields. For more information, see - <>. + <>. `scroll_size`:: (Optional, unsigned integer) The `size` parameter that is used in {es} diff --git a/docs/reference/ml/anomaly-detection/transforms.asciidoc b/docs/reference/ml/anomaly-detection/transforms.asciidoc index cfbbfb19537b..9c11206f8bf2 100644 --- a/docs/reference/ml/anomaly-detection/transforms.asciidoc +++ b/docs/reference/ml/anomaly-detection/transforms.asciidoc @@ -151,7 +151,7 @@ function. The `datafeed-test1` {dfeed} defines the script field. It contains a script that adds two fields in the document to produce a "total" error count. The syntax for the `script_fields` property is identical to that used by {es}. -For more information, see {ref}/search-request-script-fields.html[Script Fields]. +For more information, see {ref}/search-request-body.html#request-body-search-script-fields[Script Fields]. You can preview the contents of the {dfeed} by using the following API: diff --git a/docs/reference/modules/cross-cluster-search.asciidoc b/docs/reference/modules/cross-cluster-search.asciidoc index f9a5e1617474..5f1f595ad058 100644 --- a/docs/reference/modules/cross-cluster-search.asciidoc +++ b/docs/reference/modules/cross-cluster-search.asciidoc @@ -305,7 +305,7 @@ is located. Once each cluster has responded to such request, the search executes as if all shards were part of the same cluster. The coordinating node sends one request to each shard involved, each shard executes the query and returns its own results which are then reduced (and fetched, depending on the -<>) by the CCS coordinating node. +<>) by the CCS coordinating node. This strategy may be beneficial whenever there is very low network latency between the CCS coordinating node and the remote clusters involved, as it treats all shards the same, at the cost of sending many requests to each remote diff --git a/docs/reference/query-dsl/bool-query.asciidoc b/docs/reference/query-dsl/bool-query.asciidoc index 4a9a3a557e94..1d6edfdbd0c6 100644 --- a/docs/reference/query-dsl/bool-query.asciidoc +++ b/docs/reference/query-dsl/bool-query.asciidoc @@ -137,5 +137,5 @@ GET _search If you need to know which of the clauses in the bool query matched the documents returned from the query, you can use -<> to assign a name to +<> to assign a name to each clause. diff --git a/docs/reference/query-dsl/has-child-query.asciidoc b/docs/reference/query-dsl/has-child-query.asciidoc index 90e732a07965..0b3941ea3197 100644 --- a/docs/reference/query-dsl/has-child-query.asciidoc +++ b/docs/reference/query-dsl/has-child-query.asciidoc @@ -133,7 +133,7 @@ Add together the relevance scores of all matching child documents. [[has-child-query-performance]] ===== Sorting You cannot sort the results of a `has_child` query using standard -<>. +<>. If you need to sort returned documents by a field in their child documents, use a `function_score` query and sort by `_score`. For example, the following query diff --git a/docs/reference/query-dsl/match-phrase-prefix-query.asciidoc b/docs/reference/query-dsl/match-phrase-prefix-query.asciidoc index f4eb386186ea..72fc506016ac 100644 --- a/docs/reference/query-dsl/match-phrase-prefix-query.asciidoc +++ b/docs/reference/query-dsl/match-phrase-prefix-query.asciidoc @@ -61,7 +61,7 @@ the user will continue to type more letters until the word they are looking for appears. For better solutions for _search-as-you-type_ see the -<> and +<> and the <>. =================================================== diff --git a/docs/reference/query-dsl/query_filter_context.asciidoc b/docs/reference/query-dsl/query_filter_context.asciidoc index 6e7177ed19c1..c7065948a50d 100644 --- a/docs/reference/query-dsl/query_filter_context.asciidoc +++ b/docs/reference/query-dsl/query_filter_context.asciidoc @@ -13,7 +13,7 @@ document matches, the query clause also calculates a `_score` representing how well the document matches, relative to other documents. Query context is in effect whenever a query clause is passed to a `query` parameter, -such as the `query` parameter in the <> API. +such as the `query` parameter in the <> API. -- Filter context:: diff --git a/docs/reference/query-dsl/terms-query.asciidoc b/docs/reference/query-dsl/terms-query.asciidoc index 9e5aa00da61c..79b2dcb1afed 100644 --- a/docs/reference/query-dsl/terms-query.asciidoc +++ b/docs/reference/query-dsl/terms-query.asciidoc @@ -69,7 +69,7 @@ increases the relevance score. [[query-dsl-terms-query-highlighting]] ===== Highlighting `terms` queries -<> is best-effort only. {es} may not +<> is best-effort only. {es} may not return highlight results for `terms` queries depending on: * Highlighter type diff --git a/docs/reference/scripting/fields.asciidoc b/docs/reference/scripting/fields.asciidoc index cf8905189f79..ef8aee98ced7 100644 --- a/docs/reference/scripting/fields.asciidoc +++ b/docs/reference/scripting/fields.asciidoc @@ -19,7 +19,7 @@ API will have access to the `ctx` variable which exposes: [float] == Search and aggregation scripts -With the exception of <> which are +With the exception of <> which are executed once per search hit, scripts used in search and aggregations will be executed once for every document which might match a query or an aggregation. Depending on how many documents you have, this could mean millions or billions @@ -34,7 +34,7 @@ Field values can be accessed from a script using === Accessing the score of a document within a script Scripts used in the <>, -in <>, or in +in <>, or in <> have access to the `_score` variable which represents the current relevance score of a document. @@ -162,7 +162,7 @@ many documents. It makes sense to use `_source` or stored fields when generating a -<> for the top ten hits from a search +<> for the top ten hits from a search result but, for other search and aggregation use cases, always prefer using doc values. ========================================================= diff --git a/docs/reference/scripting/using.asciidoc b/docs/reference/scripting/using.asciidoc index 6da631ac9f59..a9646f2f3c8c 100644 --- a/docs/reference/scripting/using.asciidoc +++ b/docs/reference/scripting/using.asciidoc @@ -18,7 +18,7 @@ the same pattern: <3> Any named parameters that should be passed into the script. For example, the following script is used in a search request to return a -<>: +<>: [source,js] ------------------------------------- diff --git a/docs/reference/search/request-body.asciidoc b/docs/reference/search/request-body.asciidoc index aa67ffec5918..b5c57153698c 100644 --- a/docs/reference/search/request-body.asciidoc +++ b/docs/reference/search/request-body.asciidoc @@ -82,7 +82,7 @@ And here is a sample response: The type of the search operation to perform. Can be `dfs_query_then_fetch` or `query_then_fetch`. Defaults to `query_then_fetch`. - See <> for more. + See <> for more. `request_cache`:: diff --git a/docs/reference/search/request/collapse.asciidoc b/docs/reference/search/request/collapse.asciidoc index 8de0450a4d58..c067b1c18d72 100644 --- a/docs/reference/search/request/collapse.asciidoc +++ b/docs/reference/search/request/collapse.asciidoc @@ -68,7 +68,7 @@ GET /twitter/_search <4> how to sort the document inside each group <5> the number of concurrent requests allowed to retrieve the inner_hits` per group -See <> for the complete list of supported options and the format of the response. +See <> for the complete list of supported options and the format of the response. It is also possible to request multiple `inner_hits` for each collapsed hit. This can be useful when you want to get multiple representations of the collapsed hits. @@ -114,8 +114,8 @@ The `max_concurrent_group_searches` request parameter can be used to control the maximum number of concurrent searches allowed in this phase. The default is based on the number of data nodes and the default search thread pool size. -WARNING: `collapse` cannot be used in conjunction with <>, -<> or <>. +WARNING: `collapse` cannot be used in conjunction with <>, +<> or <>. ==== Second level of collapsing diff --git a/docs/reference/search/request/docvalue-fields.asciidoc b/docs/reference/search/request/docvalue-fields.asciidoc index 7706e9c57b05..e5970c73a785 100644 --- a/docs/reference/search/request/docvalue-fields.asciidoc +++ b/docs/reference/search/request/docvalue-fields.asciidoc @@ -70,4 +70,4 @@ with the configured `date` format, etc. NOTE: On its own, `docvalue_fields` cannot be used to load fields in nested objects -- if a field contains a nested object in its path, then no data will be returned for that docvalue field. To access nested fields, `docvalue_fields` -must be used within an <> block. \ No newline at end of file +must be used within an <> block. \ No newline at end of file diff --git a/docs/reference/search/request/from-size.asciidoc b/docs/reference/search/request/from-size.asciidoc index 6e249f700e0b..5e13b59c63b6 100644 --- a/docs/reference/search/request/from-size.asciidoc +++ b/docs/reference/search/request/from-size.asciidoc @@ -24,5 +24,5 @@ GET /_search Note that `from` + `size` can not be more than the `index.max_result_window` -index setting which defaults to 10,000. See the <> or <> +index setting which defaults to 10,000. See the <> or <> API for more efficient ways to do deep scrolling. diff --git a/docs/reference/search/request/inner-hits.asciidoc b/docs/reference/search/request/inner-hits.asciidoc index d26bcc9ba3c8..3f57efb8ab43 100644 --- a/docs/reference/search/request/inner-hits.asciidoc +++ b/docs/reference/search/request/inner-hits.asciidoc @@ -70,13 +70,13 @@ Inner hits support the following options: Inner hits also supports the following per document features: -* <> -* <> -* <> -* <> -* <> -* <> -* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> [[nested-inner-hits]] ==== Nested inner hits diff --git a/docs/reference/search/request/rescore.asciidoc b/docs/reference/search/request/rescore.asciidoc index 4c8f8776c084..c78865667f47 100644 --- a/docs/reference/search/request/rescore.asciidoc +++ b/docs/reference/search/request/rescore.asciidoc @@ -3,8 +3,8 @@ Rescoring can help to improve precision by reordering just the top (eg 100 - 500) documents returned by the -<> and -<> phases, using a +<> and +<> phases, using a secondary (usually more costly) algorithm, instead of applying the costly algorithm to all documents in the index. @@ -15,7 +15,7 @@ Currently the rescore API has only one implementation: the query rescorer, which uses a query to tweak the scoring. In the future, alternative rescorers may be made available, for example, a pair-wise rescorer. -NOTE: An error will be thrown if an explicit <> +NOTE: An error will be thrown if an explicit <> (other than `_score` in descending order) is provided with a `rescore` query. NOTE: when exposing pagination to your users, you should not change @@ -26,8 +26,8 @@ confusingly shift as the user steps through pages. ==== Query rescorer The query rescorer executes a second query only on the Top-K results -returned by the <> and -<> phases. The +returned by the <> and +<> phases. The number of docs which will be examined on each shard can be controlled by the `window_size` parameter, which defaults to 10. diff --git a/docs/reference/search/request/search-after.asciidoc b/docs/reference/search/request/search-after.asciidoc index 663212d1c89e..fb2bf6b87a92 100644 --- a/docs/reference/search/request/search-after.asciidoc +++ b/docs/reference/search/request/search-after.asciidoc @@ -3,7 +3,7 @@ Pagination of results can be done by using the `from` and `size` but the cost becomes prohibitive when the deep pagination is reached. The `index.max_result_window` which defaults to 10,000 is a safeguard, search requests take heap memory and time proportional to `from + size`. -The <> api is recommended for efficient deep scrolling but scroll contexts are costly and it is not +The <> api is recommended for efficient deep scrolling but scroll contexts are costly and it is not recommended to use it for real time user requests. The `search_after` parameter circumvents this problem by providing a live cursor. The idea is to use the results from the previous page to help the retrieval of the next page. diff --git a/docs/reference/search/request/sort.asciidoc b/docs/reference/search/request/sort.asciidoc index 48e7aa654c9c..986adb53c3c2 100644 --- a/docs/reference/search/request/sort.asciidoc +++ b/docs/reference/search/request/sort.asciidoc @@ -48,7 +48,7 @@ GET /my_index/_search NOTE: `_doc` has no real use-case besides being the most efficient sort order. So if you don't care about the order in which documents are returned, then you -should sort by `_doc`. This especially helps when <>. +should sort by `_doc`. This especially helps when <>. ==== Sort Values diff --git a/docs/reference/search/request/stored-fields.asciidoc b/docs/reference/search/request/stored-fields.asciidoc index 5cc8300afe66..6209eaf0808d 100644 --- a/docs/reference/search/request/stored-fields.asciidoc +++ b/docs/reference/search/request/stored-fields.asciidoc @@ -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 <> instead to select +Use <> instead to select subsets of the original source document to be returned. Allows to selectively load specific stored fields for each document represented @@ -52,7 +52,7 @@ things like `_source.obj1.field1` can be used, though not recommended, as NOTE: On its own, `stored_fields` cannot be used to load fields in nested objects -- if a field contains a nested object in its path, then no data will be returned for that stored field. To access nested fields, `stored_fields` -must be used within an <> block. +must be used within an <> block. ==== Disable stored fields entirely @@ -70,5 +70,5 @@ GET /_search -------------------------------------------------- // CONSOLE -NOTE: <> and <> parameters cannot be activated if `_none_` is used. +NOTE: <> and <> parameters cannot be activated if `_none_` is used. diff --git a/docs/reference/search/search-shards.asciidoc b/docs/reference/search/search-shards.asciidoc index 90ee35afa617..fc5507f48a28 100644 --- a/docs/reference/search/search-shards.asciidoc +++ b/docs/reference/search/search-shards.asciidoc @@ -159,7 +159,7 @@ routing values have been specified. `preference`:: Controls a `preference` of which shard replicas to execute the search request on. By default, the operation is randomized between the shard - replicas. See the link:search-request-preference.html[preference] + replicas. See the link:search-request-body.html#request-body-search-preference[preference] documentation for a list of all acceptable values. `local`:: diff --git a/docs/reference/search/suggesters/completion-suggest.asciidoc b/docs/reference/search/suggesters/completion-suggest.asciidoc index e72d0e16eacc..e7040617099f 100644 --- a/docs/reference/search/suggesters/completion-suggest.asciidoc +++ b/docs/reference/search/suggesters/completion-suggest.asciidoc @@ -214,7 +214,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 <> to minimize +using <> to minimize `_source` size. Note that the _suggest endpoint doesn't support source filtering but using suggest on the `_search` endpoint does: @@ -291,7 +291,7 @@ The basic completion suggester query supports the following parameters: `skip_duplicates`:: Whether duplicate suggestions should be filtered out (defaults to `false`). NOTE: The completion suggester considers all documents in the index. -See <> for an explanation of how to query a subset of +See <> for an explanation of how to query a subset of documents instead. NOTE: In case of completion queries spanning more than one shard, the suggest diff --git a/docs/reference/search/uri-request.asciidoc b/docs/reference/search/uri-request.asciidoc index 7bf769c6d7f4..0fdbd75c46db 100644 --- a/docs/reference/search/uri-request.asciidoc +++ b/docs/reference/search/uri-request.asciidoc @@ -86,7 +86,7 @@ providing text to a numeric field) to be ignored. Defaults to false. hits was computed. |`_source`|Set to `false` to disable retrieval of the `_source` field. You can also retrieve -part of the document by using `_source_includes` & `_source_excludes` (see the <> +part of the document by using `_source_includes` & `_source_excludes` (see the <> documentation for more details) |`stored_fields` |The selective stored fields of the document to return for each hit, @@ -105,7 +105,7 @@ scores and return them as part of each hit. of the total number of hits that match the query. It also accepts an integer which in this case represents the number of hits to count accurately. -(See the <> documentation +(See the <> documentation for more details). |`timeout` |A search timeout, bounding the search request to be executed @@ -125,7 +125,7 @@ Defaults to no terminate_after. |`search_type` |The type of the search operation to perform. Can be `dfs_query_then_fetch` or `query_then_fetch`. Defaults to `query_then_fetch`. See -<> for +<> for more details on the different types of search that can be performed. |`allow_partial_search_results` |Set to `false` to return an overall failure if the request would produce diff --git a/docs/reference/sql/endpoints/rest.asciidoc b/docs/reference/sql/endpoints/rest.asciidoc index 8140fe162d9d..4fb644a62ba5 100644 --- a/docs/reference/sql/endpoints/rest.asciidoc +++ b/docs/reference/sql/endpoints/rest.asciidoc @@ -310,7 +310,7 @@ Which looks like: Note that the `columns` object is only part of the first page. You've reached the last page when there is no `cursor` returned -in the results. Like Elasticsearch's <>, +in the results. Like Elasticsearch's <>, SQL may keep state in Elasticsearch to support the cursor. Unlike scroll, receiving the last page is enough to guarantee that the Elasticsearch state is cleared. diff --git a/docs/reference/sql/endpoints/translate.asciidoc b/docs/reference/sql/endpoints/translate.asciidoc index 6a347ff614af..ca6228ac66f0 100644 --- a/docs/reference/sql/endpoints/translate.asciidoc +++ b/docs/reference/sql/endpoints/translate.asciidoc @@ -53,7 +53,7 @@ Which returns: // TESTRESPONSE Which is the request that SQL will run to provide the results. -In this case, SQL will use the <> +In this case, SQL will use the <> API. If the result contained an aggregation then SQL would use the normal <> API. diff --git a/docs/reference/upgrade/cluster_restart.asciidoc b/docs/reference/upgrade/cluster_restart.asciidoc index 52b14d642b62..d5d78bc04c91 100644 --- a/docs/reference/upgrade/cluster_restart.asciidoc +++ b/docs/reference/upgrade/cluster_restart.asciidoc @@ -20,7 +20,7 @@ include::disable-shard-alloc.asciidoc[] . *Stop indexing and perform a synced flush.* + -- -Performing a <> speeds up shard +Performing a <> speeds up shard recovery. include::synced-flush.asciidoc[] diff --git a/docs/reference/upgrade/rolling_upgrade.asciidoc b/docs/reference/upgrade/rolling_upgrade.asciidoc index 7ad4a0bb904c..5ee75dd62b89 100644 --- a/docs/reference/upgrade/rolling_upgrade.asciidoc +++ b/docs/reference/upgrade/rolling_upgrade.asciidoc @@ -30,7 +30,7 @@ include::disable-shard-alloc.asciidoc[] -- While you can continue indexing during the upgrade, shard recovery is much faster if you temporarily stop non-essential indexing and perform a -<>. +<>. include::synced-flush.asciidoc[] @@ -133,7 +133,7 @@ As soon as another node is upgraded, the replicas can be assigned and the status will change to `green`. ==================================================== -Shards that were not <> might take longer to +Shards that were not <> might take longer to recover. You can monitor the recovery status of individual shards by submitting a <> request: diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/clear_scroll.json b/rest-api-spec/src/main/resources/rest-api-spec/api/clear_scroll.json index eb01710fd841..027448754465 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/clear_scroll.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/clear_scroll.json @@ -1,6 +1,6 @@ { "clear_scroll": { - "documentation": "http://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-scroll.html", + "documentation": "http://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-body.html#request-body-search-scroll", "stability": "stable", "methods": ["DELETE"], "url": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.flush_synced.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.flush_synced.json index 059bba28ccca..1383224b92f8 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.flush_synced.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.flush_synced.json @@ -1,6 +1,6 @@ { "indices.flush_synced": { - "documentation": "http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-flush.html#indices-synced-flush", + "documentation": "http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-flush.html#synced-flush-api", "stability": "stable", "methods": ["POST", "GET"], "url": { diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/scroll.json b/rest-api-spec/src/main/resources/rest-api-spec/api/scroll.json index 88851b2db1e3..42329aae46c4 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/scroll.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/scroll.json @@ -1,6 +1,6 @@ { "scroll": { - "documentation": "http://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-scroll.html", + "documentation": "http://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-body.html#request-body-search-scroll", "stability": "stable", "methods": ["GET", "POST"], "url": { diff --git a/x-pack/docs/en/watcher/customizing-watches.asciidoc b/x-pack/docs/en/watcher/customizing-watches.asciidoc index 895e9a89cc01..dac78450e6a4 100644 --- a/x-pack/docs/en/watcher/customizing-watches.asciidoc +++ b/x-pack/docs/en/watcher/customizing-watches.asciidoc @@ -47,7 +47,7 @@ You can use the `search` input to load Elasticsearch search results as the watch initial payload. A <> input contains a `request` object that specifies the -indices you want to search, the {ref}/search-request-search-type.html[search type], +indices you want to search, the {ref}/search-request-body.html#request-body-search-search-type[search type], and the search request body. The `body` field of a search input is the same as the body of an Elasticsearch `_search` request, making the full Elasticsearch Query DSL available for you to use. diff --git a/x-pack/docs/en/watcher/input/search.asciidoc b/x-pack/docs/en/watcher/input/search.asciidoc index d4548a159a64..1d21de7b8c1e 100644 --- a/x-pack/docs/en/watcher/input/search.asciidoc +++ b/x-pack/docs/en/watcher/input/search.asciidoc @@ -9,7 +9,7 @@ supported attributes. In the search input's `request` object, you specify: * The indices you want to search -* The {ref}/search-request-search-type.html[search type] +* The {ref}/search-request-body.html#request-body-search-search-type[search type] * The search request body The search request body supports the full Elasticsearch Query DSL--it's the diff --git a/x-pack/docs/en/watcher/transform/search.asciidoc b/x-pack/docs/en/watcher/transform/search.asciidoc index d7f468f18318..439164429c03 100644 --- a/x-pack/docs/en/watcher/transform/search.asciidoc +++ b/x-pack/docs/en/watcher/transform/search.asciidoc @@ -52,7 +52,7 @@ The following table lists all available settings for the search transform: |====== | Name |Required | Default | Description -| `request.search_type` | no | query_then_fetch | The search {ref}/search-request-search-type.html[type]. +| `request.search_type` | no | query_then_fetch | The search {ref}/search-request-body.html#request-body-search-search-type[type]. | `request.indices` | no | all indices | One or more indices to search on.