OpenSearch/docs/reference/search/request/seq-no.asciidoc

[[request-body-search-seq-no-primary-term]]
==== Sequence Numbers and Primary Term

Returns the sequence number and primary term of the last modification to each search hit.
See <<optimistic-concurrency-control>> for more details.

[source,js]
--------------------------------------------------
GET /_search
{
    "seq_no_primary_term": true,
    "query" : {
        "term" : { "user" : "kimchy" }
    }
}
--------------------------------------------------
// CONSOLE
[DOCS] Move Elasticsearch APIs to REST APIs section. (#44238) (#44372) Moves the following API sections under the REST APIs navigations: - API Conventions - Document APIs - Search APIs - Index APIs (previously named Indices APIs) - cat APIs - Cluster APIs Other supporting changes: - Removes the previous index APIs page under REST APIs. Adds a redirect for the removed page. - Removes several [partintro] macros so the docs build correctly. - Changes anchors for pages that become sections of a parent page. - Adds several redirects for existing pages that become sections of a parent page. This commit re-applies changes from #44238. Changes from that PR were reverted due to broken links in several repos. This commit adds redirects for those broken links. 2019-07-17 08:49:22 -04:00			`[[request-body-search-seq-no-primary-term]]`
[DOCS] Remove heading offsets for REST APIs (#44568) Several files in the REST APIs nav section are included using :leveloffset: tags. This increments headings (h2 -> h3, h3 -> h4, etc.) in those files and removes the :leveloffset: tags. Other supporting changes: * Alphabetizes top-level REST API nav items. * Change 'indices APIs' heading to 'index APIs.' * Changes 'Snapshot lifecycle management' heading to sentence case. 2019-07-19 14:35:36 -04:00			`==== Sequence Numbers and Primary Term`
Expose sequence number and primary terms in search responses (#37639) Users may require the sequence number and primary terms to perform optimistic concurrency control operations. Currently, you can get the sequence number via the `docvalues_fields` API but the primary term is not accessible because it is maintained by the `SeqNoFieldMapper` and the infrastructure can't find it. This commit adds a dedicated sub fetch phase to return both numbers that is connected to a new `seq_no_primary_term` parameter. 2019-01-23 09:01:58 +01:00
			`Returns the sequence number and primary term of the last modification to each search hit.`
			`See <<optimistic-concurrency-control>> for more details.`

			`[source,js]`
			`--------------------------------------------------`
			`GET /_search`
			`{`
			`"seq_no_primary_term": true,`
			`"query" : {`
			`"term" : { "user" : "kimchy" }`
			`}`
			`}`
			`--------------------------------------------------`
			`// CONSOLE`