From a4914505c55be387753155aca16a1a7b65ea240a Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 11 Jul 2019 20:34:52 -0700 Subject: [PATCH 1/3] [DOCS] Adds sync to data frame transform API --- .../data-frames/apis/put-transform.asciidoc | 27 ++++++++++++++----- 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/docs/reference/data-frames/apis/put-transform.asciidoc b/docs/reference/data-frames/apis/put-transform.asciidoc index 50b48d7a70136..ef2479cfe8d96 100644 --- a/docs/reference/data-frames/apis/put-transform.asciidoc +++ b/docs/reference/data-frames/apis/put-transform.asciidoc @@ -67,6 +67,15 @@ IMPORTANT: You must use {kib} or this API to create a {dataframe-transform}. `source`:: (object) Required. The source configuration, which consists of `index` and optionally a `query`. See <>. + +`sync`:: + (Optional, object) Defines the properties required to run continuously. + `field`::: + (Required, string) The date field that is used to identify new documents in + the source. + `delay`::: + (Optional, time units) The time delay between the current time and the + latest input data time. [[put-data-frame-transform-example]] ==== {api-examples-title} @@ -85,11 +94,6 @@ PUT _data_frame/transforms/ecommerce_transform } } }, - "dest": { - "index": "kibana_sample_data_ecommerce_transform", - "pipeline": "add_timestamp_pipeline" - }, - "frequency": "5m", "pivot": { "group_by": { "customer_id": { @@ -106,7 +110,18 @@ PUT _data_frame/transforms/ecommerce_transform } } }, - "description": "Maximum priced ecommerce data by customer_id in Asia" + "description": "Maximum priced ecommerce data by customer_id in Asia", + "dest": { + "index": "kibana_sample_data_ecommerce_transform", + "pipeline": "add_timestamp_pipeline" + }, + "frequency": "5m", + "sync": { + "time": { + "field": "order_date", + "delay": "60s" + } + } } -------------------------------------------------- // CONSOLE From f9a1e6a0f2e4233314f50b7e6efbc45ca4ddc63a Mon Sep 17 00:00:00 2001 From: lcawl Date: Fri, 12 Jul 2019 10:05:55 -0700 Subject: [PATCH 2/3] [DOCS] Adds missing description for time property --- .../data-frames/apis/put-transform.asciidoc | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/docs/reference/data-frames/apis/put-transform.asciidoc b/docs/reference/data-frames/apis/put-transform.asciidoc index ef2479cfe8d96..f9e7fae232ebc 100644 --- a/docs/reference/data-frames/apis/put-transform.asciidoc +++ b/docs/reference/data-frames/apis/put-transform.asciidoc @@ -70,12 +70,15 @@ IMPORTANT: You must use {kib} or this API to create a {dataframe-transform}. `sync`:: (Optional, object) Defines the properties required to run continuously. - `field`::: - (Required, string) The date field that is used to identify new documents in - the source. - `delay`::: - (Optional, time units) The time delay between the current time and the - latest input data time. + `time`::: + (Required, object) Specifies that the {dataframe-transform} uses a time + field to synchronize the source and destination indices. + `field`:::: + (Required, string) The date field that is used to identify new documents + in the source. + `delay`:::: + (Optional, time units) The time delay between the current time and the + latest input data time. [[put-data-frame-transform-example]] ==== {api-examples-title} From 44c1c300db61b16d62dcf7a3e77118ac0176cda3 Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 16 Jul 2019 16:46:45 -0700 Subject: [PATCH 3/3] [DOCS] Adds tip to field property --- docs/reference/data-frames/apis/put-transform.asciidoc | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/reference/data-frames/apis/put-transform.asciidoc b/docs/reference/data-frames/apis/put-transform.asciidoc index f9e7fae232ebc..4b7733d12a290 100644 --- a/docs/reference/data-frames/apis/put-transform.asciidoc +++ b/docs/reference/data-frames/apis/put-transform.asciidoc @@ -76,9 +76,17 @@ IMPORTANT: You must use {kib} or this API to create a {dataframe-transform}. `field`:::: (Required, string) The date field that is used to identify new documents in the source. ++ +-- +TIP: In general, it’s a good idea to use a field that contains the +<>. If you use a different field, +you might need to set the `delay` such that it accounts for data transmission +delays. + +-- `delay`:::: (Optional, time units) The time delay between the current time and the - latest input data time. + latest input data time. The default value is `60s`. [[put-data-frame-transform-example]] ==== {api-examples-title}