Files
elasticsearch-js/docs/reference-exists.asciidoc
2024-12-05 14:46:46 -06:00

72 lines
4.2 KiB
Plaintext

[[reference-exists]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.exists
Check a document. Checks if a specified document exists.
{ref}/docs-get.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(ExistsRequest, options?): Promise<ExistsResponse>
----
[discrete]
===== `ExistsRequest`
[source,ts]
----
interface ExistsRequest extends <<shared-type-request-base, RequestBase>> {
id: <<shared-type-id, Id>>
index: <<shared-type-index-name, IndexName>>
preference?: string
realtime?: boolean
refresh?: boolean
routing?: <<shared-type-routing, Routing>>
_source?: SearchSourceConfigParam
_source_excludes?: <<shared-type-fields, Fields>>
_source_includes?: <<shared-type-fields, Fields>>
stored_fields?: <<shared-type-fields, Fields>>
version?: <<shared-type-version-number, VersionNumber>>
version_type?: <<shared-type-version-type, VersionType>>
}
----
[discrete]
===== `ExistsResponse`
[source,ts]
----
type ExistsResponse = boolean
----