70 lines
4.3 KiB
Plaintext
70 lines
4.3 KiB
Plaintext
[[reference-delete]]
|
|
|
|
////////
|
|
===========================================================================================================================
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
|
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
|
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
|
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
|
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
|
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
|
|| ||
|
|
|| ||
|
|
|| 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.delete
|
|
|
|
Delete a document. Removes a JSON document from the specified index.
|
|
|
|
{ref}/docs-delete.html[{es} documentation]
|
|
|
|
[discrete]
|
|
==== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(DeleteRequest, options?): Promise<DeleteResponse>
|
|
----
|
|
|
|
[discrete]
|
|
===== `DeleteRequest`
|
|
|
|
[source,ts]
|
|
----
|
|
interface DeleteRequest extends <<shared-type-request-base, RequestBase>> {
|
|
id: <<shared-type-id, Id>>
|
|
index: <<shared-type-index-name, IndexName>>
|
|
if_primary_term?: <<shared-type-long, long>>
|
|
if_seq_no?: <<shared-type-sequence-number, SequenceNumber>>
|
|
refresh?: <<shared-type-refresh, Refresh>>
|
|
routing?: <<shared-type-routing, Routing>>
|
|
timeout?: <<shared-type-duration, Duration>>
|
|
version?: <<shared-type-version-number, VersionNumber>>
|
|
version_type?: <<shared-type-version-type, VersionType>>
|
|
wait_for_active_shards?: <<shared-type-wait-for-active-shards, WaitForActiveShards>>
|
|
}
|
|
----
|
|
|
|
[discrete]
|
|
===== `DeleteResponse`
|
|
|
|
[source,ts]
|
|
----
|
|
type DeleteResponse = <<shared-type-write-response-base, WriteResponseBase>>
|
|
----
|
|
|