habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Test run of new docs

Browse Source
This commit is contained in:
Josh Mock
2024-11-19 11:04:35 -06:00
parent f33aa8cccd
commit 8210607de0
503 changed files with 37166 additions and 12056 deletions
Download Patch File Download Diff File Expand all files Collapse all files

69
docs/reference-open_point_in_time.asciidoc Normal file
View File

@ -0,0 +1,69 @@
[[reference-open_point_in_time]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
[discrete]
=== client.openPointInTime
Open a point in time. A search request by default runs against the most recent visible data of the target indices, which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple search requests using the same point in time. For example, if refreshes happen between `search_after` requests, then the results of those requests might not be consistent as changes happening between searches are only visible to the more recent point in time. A point in time must be opened explicitly before being used in search requests. The `keep_alive` parameter tells Elasticsearch how long it should persist.
{ref}/point-in-time-api.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(OpenPointInTimeRequest, options?): Promise<OpenPointInTimeResponse>
----
[discrete]
===== `OpenPointInTimeRequest`
[source,ts]
----
interface OpenPointInTimeRequest extends <<shared-type-request-base, RequestBase>> {
index: <<shared-type-indices, Indices>>
keep_alive: <<shared-type-duration, Duration>>
ignore_unavailable?: boolean
preference?: string
routing?: <<shared-type-routing, Routing>>
expand_wildcards?: <<shared-type-expand-wildcards, ExpandWildcards>>
index_filter?: QueryDslQueryContainer
}
----
[discrete]
===== `OpenPointInTimeResponse`
[source,ts]
----
interface OpenPointInTimeResponse {
_shards: <<shared-type-shard-statistics, ShardStatistics>>
id: <<shared-type-id, Id>>
}
----