Browse Source

[DOCS] change source and dest to be nested and add a query to the example (#41293)

update source and dest to reflect the changes done in #40396 and add a query to the example.
Hendrik Muhs 6 years ago
parent
commit
3b0dd4a4ed
1 changed files with 17 additions and 5 deletions
  1. 17 5
      docs/reference/data-frames/apis/put-transform.asciidoc

+ 17 - 5
docs/reference/data-frames/apis/put-transform.asciidoc

@@ -25,9 +25,10 @@ Instantiates a {dataframe-transform}.
 
 ==== Request Body
 
-`source`:: The source index or index pattern.
+`source`:: (object) The source configuration, consisting of `index` and optionally
+a `query`.
 
-`dest`:: The destination index.
+`dest`:: (object) The destination configuration, consisting of `index`.
 
 `pivot`:: Defines the pivot function `group by` fields and the aggregation to
 reduce the data.
@@ -44,8 +45,19 @@ sample data:
 --------------------------------------------------
 PUT _data_frame/transforms/ecommerce_transform
 {
-  "source": "kibana_sample_data_ecommerce",
-  "dest": "kibana_sample_data_ecommerce_transform",
+  "source": {
+    "index": "kibana_sample_data_ecommerce",
+    "query": {
+      "term": {
+        "geoip.continent_name": {
+          "value": "Asia"
+        }
+      }
+    }
+  },
+  "dest": {
+    "index": "kibana_sample_data_ecommerce_transform"
+  },
   "pivot": {
     "group_by": {
       "customer_id": {
@@ -74,4 +86,4 @@ When the transform is created, you receive the following results:
   "acknowledged" : true
 }
 ----
-// NOTCONSOLE
+// NOTCONSOLE