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.

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

Merged
merged 3 commits into from
Jul 17, 2019
+32 −6
Merged

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

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a491450
[DOCS] Adds sync to data frame transform API
lcawl Jul 12, 2019
f9a1e6a
[DOCS] Adds missing description for time property
lcawl Jul 12, 2019
44c1c30
[DOCS] Adds tip to field property
lcawl Jul 16, 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
27 changes: 21 additions & 6 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 @@ -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 <<data-frame-transform-source>>.

`sync`::
(Optional, object) Defines the properties required to run continuously.
`field`:::
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there is another level between sync and field/delay, its "sync" -> "time" -> "field"/"delay" (see your example below)

sync defines continuous mode, time defines that the sync method is using a timestamp field in the data. In future we will have other ways to sync source and dest, e.g. for non timeseries data

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, I've drafted a description of that time property.

(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
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we identified yesterday that we need a default value for delay, I will update this comment once we agreed on a value.

latest input data time.

[[put-data-frame-transform-example]]
==== {api-examples-title}
Expand All @@ -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": {
Expand All @@ -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
Expand Down