honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/java-rest/high-level/document/exists.asciidoc

38 lines
1.2 KiB
Plaintext
Raw Normal View History

Docs: DRY up CRUD docs (#34203) This further applies the pattern set in #34125 to reduce copy-and-paste in the single document CRUD portion of the High Level REST Client docs. It also adds line wraps to snippets that are too wide to fit into the box when rendered in the docs, following up on the work started in #34163.
2018-10-05 11:41:03 -04:00
--
:api: exists
:request: GetRequest
:response: boolean
--
[id="{upid}-{api}"]
Docs: HighLevelRestClient#exists (#29073) Docs: HighLevelRestClient#exists Add documentation for `HighLevelRestClient#exists`. Relates to #28389
2018-03-15 12:10:30 -04:00
=== Exists API
The exists API returns `true` if a document exists, and `false` otherwise.
Docs: DRY up CRUD docs (#34203) This further applies the pattern set in #34125 to reduce copy-and-paste in the single document CRUD portion of the High Level REST Client docs. It also adds line wraps to snippets that are too wide to fit into the box when rendered in the docs, following up on the work started in #34163.
2018-10-05 11:41:03 -04:00
[id="{upid}-{api}-request"]
Docs: HighLevelRestClient#exists (#29073) Docs: HighLevelRestClient#exists Add documentation for `HighLevelRestClient#exists`. Relates to #28389
2018-03-15 12:10:30 -04:00
==== Exists Request
Docs: DRY up CRUD docs (#34203) This further applies the pattern set in #34125 to reduce copy-and-paste in the single document CRUD portion of the High Level REST Client docs. It also adds line wraps to snippets that are too wide to fit into the box when rendered in the docs, following up on the work started in #34163.
2018-10-05 11:41:03 -04:00
It uses +{request}+ just like the <<java-rest-high-document-get>>.
Docs: HighLevelRestClient#exists (#29073) Docs: HighLevelRestClient#exists Add documentation for `HighLevelRestClient#exists`. Relates to #28389
2018-03-15 12:10:30 -04:00
All of its <<java-rest-high-document-get-request-optional-arguments, optional arguments>>
are supported. Since `exists()` only returns `true` or `false`, we recommend
turning off fetching `_source` and any stored fields so the request is
slightly lighter:
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
Docs: DRY up CRUD docs (#34203) This further applies the pattern set in #34125 to reduce copy-and-paste in the single document CRUD portion of the High Level REST Client docs. It also adds line wraps to snippets that are too wide to fit into the box when rendered in the docs, following up on the work started in #34163.
2018-10-05 11:41:03 -04:00
include-tagged::{doc-tests-file}[{api}-request]
Docs: HighLevelRestClient#exists (#29073) Docs: HighLevelRestClient#exists Add documentation for `HighLevelRestClient#exists`. Relates to #28389
2018-03-15 12:10:30 -04:00
--------------------------------------------------
<1> Index
Deprecate types in get, exists, and multi get. (#35930) For each API, the following updates were made: - Add deprecation warnings to `Rest*Action`, plus tests in `Rest*ActionTests`. - For each REST yml test, make sure there is one version without types, and another legacy version that retains types (called *_with_types.yml). - Deprecate relevant methods on the Java HLRC requests/ responses. - Update documentation (for both the REST API and Java HLRC).
2018-12-10 20:22:48 -05:00
<2> Document id
<3> Disable fetching `_source`.
<4> Disable fetching stored fields.
Docs: HighLevelRestClient#exists (#29073) Docs: HighLevelRestClient#exists Add documentation for `HighLevelRestClient#exists`. Relates to #28389
2018-03-15 12:10:30 -04:00
Docs: DRY up CRUD docs (#34203) This further applies the pattern set in #34125 to reduce copy-and-paste in the single document CRUD portion of the High Level REST Client docs. It also adds line wraps to snippets that are too wide to fit into the box when rendered in the docs, following up on the work started in #34163.
2018-10-05 11:41:03 -04:00
include::../execution.asciidoc[]
HLRC - add support for source exists API (#34519) HLRC - add support for source exists API API re-uses the GetRequest object (following the precedent set by the plain “exists” api). Relates to #27205
2018-10-26 09:21:35 -04:00
==== Source exists request
A variant of the exists request is `existsSource` method which has the additional check
that the document in question has stored the `source`. If the mapping for the index has opted
to remove support for storing JSON source in documents then this method will return false
for documents in this index.