github-mirrors/elasticsearch
1
0
Fork 0
mirror of https://github.com/elastic/elasticsearch.git synced 2025-06-28 09:28:55 -04:00
Code Issues Projects Releases Packages Wiki Activity

Fix HLRC doc link for point in time API (#73874)

Browse source 
The PIT's docs in HLRC wasn't linked properly.
This commit is contained in:
Nhat Nguyen 2021-06-09 12:32:30 -04:00 • committed by GitHub
parent cb84769d6d
commit 1211b9d5e4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 8 additions and 55 deletions
Download patch file Download diff file Expand all files Collapse all files

13
docs/java-rest/high-level/search/point-in-time.asciidoc
View file

@ -1,4 +1,4 @@
[[java-rest-high-search-point-in-time]]
[[java-rest-high-point-in-time]]
=== Open a point in time
@ -53,19 +53,8 @@ include-tagged::{doc-tests}/SearchDocumentationIT.java[search-point-in-time]
A search request with a point in time does not accept these parameters:
`indices`, `indicesOptions` `routing`, `preference`, and `ccsMinimizeRoundtrips`.
==== Paginate search results with point in time
A point in time can be used in search after requests to paginate search results.
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests}/SearchDocumentationIT.java[search-after-with-point-in-time]
--------------------------------------------------
<1> Open a point in time that will be used in multiple search_after requests
<2> Create a search request with the sort parameter
<3> Set the search_after parameter using the sort values from the previous page
<4> Pass a point in time to a search request
<5> Close the point in time
=== Close point in time
Point in time should be closed as soon as they are no longer used in search requests.

2
docs/java-rest/high-level/supported-apis.asciidoc
View file

@ -60,6 +60,7 @@ The Java High Level REST Client supports the following Search APIs:
* <<{upid}-rank-eval>>
* <<{upid}-explain>>
* <<{upid}-count>>
* <<{upid}-point-in-time>>
include::search/search.asciidoc[]
include::search/scroll.asciidoc[]
@ -70,6 +71,7 @@ include::search/field-caps.asciidoc[]
include::search/rank-eval.asciidoc[]
include::search/explain.asciidoc[]
include::search/count.asciidoc[]
include::search/point-in-time.asciidoc[]
[role="xpack"]
== Async Search APIs