Skip to content

[DOCS] Adds sync to data frame transform API #44254

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.

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

Merged
merged 3 commits into from
Jul 17, 2019
Merged
Changes from all commits
Commits
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
38 changes: 32 additions & 6 deletions docs/reference/data-frames/apis/put-transform.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,26 @@ 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 <<data-frame-transform-source>>.

`sync`::
(Optional, object) Defines the properties required to run continuously.
`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.
+
--
TIP: In general, it’s a good idea to use a field that contains the
<<accessing-ingest-metadata,ingest timestamp>>. 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. The default value is `60s`.

[[put-data-frame-transform-example]]
==== {api-examples-title}
Expand All @@ -85,11 +105,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": {
Expand All @@ -106,7 +121,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
Expand Down