mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-17 02:14:54 +00:00
[DOCS] Adds placeholder for create and delete data frame transform APIs (#40233)
This commit is contained in:
parent
0e712d476e
commit
caa0129d44
43
docs/reference/data-frames/apis/delete-transform.asciidoc
Normal file
43
docs/reference/data-frames/apis/delete-transform.asciidoc
Normal file
@ -0,0 +1,43 @@
|
||||
[role="xpack"]
|
||||
[testenv="basic"]
|
||||
[[delete-data-frame-transform]]
|
||||
=== Delete {dataframe-transforms} API
|
||||
++++
|
||||
<titleabbrev>Delete {dataframe-transforms}</titleabbrev>
|
||||
++++
|
||||
|
||||
Deletes an existing {dataframe-transform}.
|
||||
|
||||
|
||||
==== Request
|
||||
|
||||
`DELETE _data_frame/transforms/<data_frame_transform_id>`
|
||||
|
||||
//==== Description
|
||||
|
||||
==== Path Parameters
|
||||
|
||||
`data_frame_transform_id` (required)::
|
||||
(string) Identifier for the {dataframe-transform}.
|
||||
|
||||
//===== Authorization
|
||||
|
||||
==== Examples
|
||||
|
||||
The following example deletes the `ecommerce_transform` {dataframe-transform}:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
DELETE _data_frame/transforms/ecommerce_transform
|
||||
--------------------------------------------------
|
||||
// CONSOLE
|
||||
// TEST[skip:setup kibana sample data]
|
||||
|
||||
When the {dataframe-transform} is deleted, you receive the following results:
|
||||
[source,js]
|
||||
----
|
||||
{
|
||||
"acknowledged" : true
|
||||
}
|
||||
----
|
||||
// TESTRESPONSE
|
@ -7,10 +7,17 @@
|
||||
[[data-frame-transform-apis]]
|
||||
=== {dataframe-transforms-cap}
|
||||
|
||||
* <<preview-data-frame-transform,Preview {dataframe-transforms}>>
|
||||
* <<put-data-frame-transform,Create {dataframe-transforms}>>,
|
||||
<<delete-data-frame-transform,delete {dataframe-transforms}>>
|
||||
* <<preview-data-frame-transform,Preview {dataframe-transforms}>>
|
||||
* <<get-data-frame-transform,Get {dataframe-transform} info>>,
|
||||
<<get-data-frame-transform-stats,Get {dataframe-transform} statistics>>
|
||||
* <<preview-data-frame-transform,Preview {dataframe-transforms}>>
|
||||
|
||||
//CREATE
|
||||
include::put-transform.asciidoc[]
|
||||
//DELETE
|
||||
include::delete-transform.asciidoc[]
|
||||
//GET
|
||||
include::get-transform.asciidoc[]
|
||||
include::get-transform-stats.asciidoc[]
|
||||
|
77
docs/reference/data-frames/apis/put-transform.asciidoc
Normal file
77
docs/reference/data-frames/apis/put-transform.asciidoc
Normal file
@ -0,0 +1,77 @@
|
||||
[role="xpack"]
|
||||
[testenv="basic"]
|
||||
[[put-data-frame-transform]]
|
||||
=== Create {dataframe-transforms} API
|
||||
++++
|
||||
<titleabbrev>Create {dataframe-transforms}</titleabbrev>
|
||||
++++
|
||||
|
||||
Instantiates a {dataframe-transform}.
|
||||
|
||||
|
||||
==== Request
|
||||
|
||||
`PUT _data_frame/transforms/<data_frame_transform_id>`
|
||||
|
||||
//===== Description
|
||||
|
||||
==== Path Parameters
|
||||
|
||||
`data_frame_transform_id` (required)::
|
||||
(string) Identifier for the {dataframe-transform}. This identifier can contain
|
||||
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It
|
||||
must start and end with alphanumeric characters.
|
||||
|
||||
|
||||
==== Request Body
|
||||
|
||||
`source`:: The source index or index pattern.
|
||||
|
||||
`dest`:: The destination index.
|
||||
|
||||
`pivot`:: Defines the pivot function `group by` fields and the aggregation to
|
||||
reduce the data.
|
||||
|
||||
|
||||
//==== Authorization
|
||||
|
||||
==== Examples
|
||||
|
||||
The following example creates a {dataframe-transform} for the {kib} eCommerce
|
||||
sample data:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
PUT _data_frame/transforms/ecommerce_transform
|
||||
{
|
||||
"source": "kibana_sample_data_ecommerce",
|
||||
"dest": "kibana_sample_data_ecommerce_transform",
|
||||
"pivot": {
|
||||
"group_by": {
|
||||
"customer_id": {
|
||||
"terms": {
|
||||
"field": "customer_id"
|
||||
}
|
||||
}
|
||||
},
|
||||
"aggregations": {
|
||||
"max_price": {
|
||||
"max": {
|
||||
"field": "taxful_total_price"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
--------------------------------------------------
|
||||
// CONSOLE
|
||||
// TEST[skip:add sample kibana data]
|
||||
|
||||
When the transform is created, you receive the following results:
|
||||
[source,js]
|
||||
----
|
||||
{
|
||||
"acknowledged" : true
|
||||
}
|
||||
----
|
||||
// NOTCONSOLE
|
@ -1,6 +1,6 @@
|
||||
{
|
||||
"data_frame.delete_data_frame_transform": {
|
||||
"documentation": "TODO",
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-data-frame-transform.html",
|
||||
"methods": [ "DELETE" ],
|
||||
"url": {
|
||||
"path": "/_data_frame/transforms/{transform_id}",
|
||||
|
@ -1,6 +1,6 @@
|
||||
{
|
||||
"data_frame.put_data_frame_transform": {
|
||||
"documentation": "TODO",
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-data-frame-transform.html",
|
||||
"methods": [ "PUT" ],
|
||||
"url": {
|
||||
"path": "/_data_frame/transforms/{transform_id}",
|
||||
|
Loading…
x
Reference in New Issue
Block a user