Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] add a warning about bypassing PUT API's, update example responses #42062

Merged
merged 3 commits into from
May 16, 2019
Merged

[DOCS] add a warning about bypassing PUT API's, update example responses #42062

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cd9b131
add a warning about bypassing PUT API's, update response examples and
May 10, 2019
9faa362
rephrase warning to cover versioned internal indices
May 10, 2019
a7d71fe
Update docs/reference/data-frames/apis/put-transform.asciidoc
May 11, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 22 additions & 14 deletions docs/reference/data-frames/apis/get-transform-stats.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,27 +65,35 @@ The API returns the following results:
{
"id" : "ecommerce_transform",
"state" : {
"task_state" : "started",
"indexer_state" : "started",
"task_state": "started",
"current_position" : {
"customer_id" : "9"
},
"generation" : 1
"checkpoint" : 1,
"progress" : {
"total_docs" : 1220,
"docs_remaining" : 0,
"percent_complete" : 100.0
}
},
"stats" : {
"pages_processed" : 0,
"documents_processed" : 0,
"documents_indexed" : 0,
"trigger_count" : 0,
"index_time_in_ms" : 0,
"index_total" : 0,
"pages_processed" : 2,
"documents_processed" : 1220,
"documents_indexed" : 13,
"trigger_count" : 1,
"index_time_in_ms" : 19,
"index_total" : 1,
"index_failures" : 0,
"search_time_in_ms" : 0,
"search_total" : 0,
"search_time_in_ms" : 52,
"search_total" : 2,
"search_failures" : 0
},
"checkpointing" : {
"current" : {
"timestamp_millis" : 1557474786393
},
"operations_behind" : 0
}
}
]
}
----
// TESTRESPONSE
// TESTRESPONSE
21 changes: 16 additions & 5 deletions docs/reference/data-frames/apis/get-transform.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,10 +75,20 @@ The API returns the following results:
"transforms" : [
{
"id" : "ecommerce_transform",
"source" : "kibana_sample_data_ecommerce",
"dest" : "kibana_sample_data_ecommerce_transform",
"query" : {
"match_all" : { }
"source" : {
"index" : [
"kibana_sample_data_ecommerce"
],
"query" : {
"term" : {
"geoip.continent_name" : {
"value" : "Asia"
}
}
}
},
"dest" : {
"index" : "kibana_sample_data_ecommerce_transform"
},
"pivot" : {
"group_by" : {
Expand All @@ -95,7 +105,8 @@ The API returns the following results:
}
}
}
}
},
"description" : "Maximum priced ecommerce data by customer_id in Asia"
}
]
}
Expand Down
14 changes: 10 additions & 4 deletions docs/reference/data-frames/apis/put-transform.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,13 @@ Instantiates a {dataframe-transform}.

`PUT _data_frame/transforms/<data_frame_transform_id>`

//===== Description
===== Description

IMPORTANT: You must use {kib} or this API to create a {dataframe-transform}.
Do not put a {dataframe-transform} directly into any
`.data-frame-internal*` indices using the Elasticsearch index API.
If {es} {security-features} are enabled, do not give users any
privileges on `.data-frame-internal*` indices.

==== Path Parameters

Expand All @@ -27,12 +33,12 @@ Instantiates a {dataframe-transform}.

==== Request Body

`source`:: (object) The source configuration, consisting of `index` and optionally
`source` (required):: (object) The source configuration, consisting of `index` and optionally
a `query`.

`dest`:: (object) The destination configuration, consisting of `index`.
`dest` (required):: (object) The destination configuration, consisting of `index`.

`pivot`:: Defines the pivot function `group by` fields and the aggregation to
`pivot`:: (object) Defines the pivot function `group by` fields and the aggregation to
reduce the data.

`description`:: Optional free text description of the data frame transform
Expand Down