mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-25 07:37:19 -04:00
33a71e3289
* Remove `es-test-dir` book-scoped variable * Remove `plugins-examples-dir` book-scoped variable * Remove `:dependencies-dir:` and `:xes-repo-dir:` book-scoped variables - In `index.asciidoc`, two variables (`:dependencies-dir:` and `:xes-repo-dir:`) were removed. - In `sql/index.asciidoc`, the `:sql-tests:` path was updated to fuller path - In `esql/index.asciidoc`, the `:esql-tests:` path was updated idem * Replace `es-repo-dir` with `es-ref-dir` * Move `:include-xpack: true` to few files that use it, remove from index.asciidoc
65 lines
1.7 KiB
Text
65 lines
1.7 KiB
Text
[role="xpack"]
|
|
[[delete-transform]]
|
|
= Delete {transform} API
|
|
|
|
[subs="attributes"]
|
|
++++
|
|
<titleabbrev>Delete {transform}</titleabbrev>
|
|
++++
|
|
|
|
Deletes an existing {transform}.
|
|
|
|
[[delete-transform-request]]
|
|
== {api-request-title}
|
|
|
|
`DELETE _transform/<transform_id>`
|
|
|
|
[[delete-transform-prereqs]]
|
|
== {api-prereq-title}
|
|
|
|
* Requires the `manage_transform` cluster privilege. This privilege is included
|
|
in the `transform_admin` built-in role.
|
|
* Before you can delete the {transform}, you must stop it.
|
|
|
|
[[delete-transform-path-parms]]
|
|
== {api-path-parms-title}
|
|
|
|
`<transform_id>`::
|
|
(Required, string)
|
|
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=transform-id]
|
|
|
|
[[delete-transform-query-parms]]
|
|
== {api-query-parms-title}
|
|
|
|
`force`::
|
|
(Optional, Boolean) When `true`, the {transform} is deleted regardless of its
|
|
current state. The default value is `false`, meaning that the {transform} must be
|
|
`stopped` before it can be deleted.
|
|
|
|
`delete_dest_index`::
|
|
(Optional, Boolean) When `true`, the destination index is deleted together with
|
|
the {transform}. The default value is `false`, meaning that the destination
|
|
index will not be deleted.
|
|
|
|
`timeout`::
|
|
(Optional, time)
|
|
Period to wait for a response. If no response is received before the timeout
|
|
expires, the request fails and returns an error. Defaults to `30s`.
|
|
|
|
[[delete-transform-examples]]
|
|
== {api-examples-title}
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
DELETE _transform/ecommerce_transform
|
|
--------------------------------------------------
|
|
// TEST[skip:setup kibana sample data]
|
|
|
|
When the {transform} is deleted, you receive the following results:
|
|
|
|
[source,console-result]
|
|
----
|
|
{
|
|
"acknowledged" : true
|
|
}
|
|
----
|