@@ -67,6 +67,26 @@ IMPORTANT: You must use {kib} or this API to create a {dataframe-transform}.
67
67
`source`::
68
68
(Required, object) The source configuration, which consists of `index` and
69
69
optionally a `query`. See <<data-frame-transform-source>>.
70
+
71
+ `sync`::
72
+ (Optional, object) Defines the properties required to run continuously.
73
+ `time`:::
74
+ (Required, object) Specifies that the {dataframe-transform} uses a time
75
+ field to synchronize the source and destination indices.
76
+ `field`::::
77
+ (Required, string) The date field that is used to identify new documents
78
+ in the source.
79
+ +
80
+ --
81
+ TIP: In general, it’s a good idea to use a field that contains the
82
+ <<accessing-ingest-metadata,ingest timestamp>>. If you use a different field,
83
+ you might need to set the `delay` such that it accounts for data transmission
84
+ delays.
85
+
86
+ --
87
+ `delay`::::
88
+ (Optional, time units) The time delay between the current time and the
89
+ latest input data time. The default value is `60s`.
70
90
71
91
[[put-data-frame-transform-example]]
72
92
==== {api-examples-title}
@@ -85,11 +105,6 @@ PUT _data_frame/transforms/ecommerce_transform
85
105
}
86
106
}
87
107
},
88
- "dest": {
89
- "index": "kibana_sample_data_ecommerce_transform",
90
- "pipeline": "add_timestamp_pipeline"
91
- },
92
- "frequency": "5m",
93
108
"pivot": {
94
109
"group_by": {
95
110
"customer_id": {
@@ -106,7 +121,18 @@ PUT _data_frame/transforms/ecommerce_transform
106
121
}
107
122
}
108
123
},
109
- "description": "Maximum priced ecommerce data by customer_id in Asia"
124
+ "description": "Maximum priced ecommerce data by customer_id in Asia",
125
+ "dest": {
126
+ "index": "kibana_sample_data_ecommerce_transform",
127
+ "pipeline": "add_timestamp_pipeline"
128
+ },
129
+ "frequency": "5m",
130
+ "sync": {
131
+ "time": {
132
+ "field": "order_date",
133
+ "delay": "60s"
134
+ }
135
+ }
110
136
}
111
137
--------------------------------------------------
112
138
// CONSOLE
0 commit comments