Skip to content

Commit c9b13f5

Browse files
kilfoylekilfoyle
authored
Update tech preview notice for synthetic source (#91474)
1 parent 679b3c9 commit c9b13f5

13 files changed

+116
-13
lines changed

‎docs/reference/mapping/fields/synthetic-source.asciidoc

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
[[synthetic-source]]
2-
==== Synthetic `_source` preview:[]
2+
==== Synthetic `_source`
3+
4+
IMPORTANT: Synthetic `_source` is Generally Available only for TSDB indices
5+
(indices that have `index.mode` set to `time_series`). For other indices
6+
synthetic `_source` is in technical preview. Features in technical preview may
7+
be changed or removed in a future release. Elastic will apply best effort to fix
8+
any issues, but features in technical preview are not subject to the support SLA
9+
of official GA features.
310

411
Though very handy to have around, the source field takes up a significant amount
512
of space on disk. Instead of storing source documents on disk exactly as you

‎docs/reference/mapping/types/aggregate-metric-double.asciidoc

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,15 @@ The search returns the following hit. The value of the `default_metric` field,
248248
// TESTRESPONSE[s/\.\.\./"took": $body.took,"timed_out": false,"_shards": $body._shards,/]
249249

250250
[[aggregate-metric-double-synthetic-source]]
251-
==== Synthetic `_source` preview:[]
251+
==== Synthetic `_source`
252+
253+
IMPORTANT: Synthetic `_source` is Generally Available only for TSDB indices
254+
(indices that have `index.mode` set to `time_series`). For other indices
255+
synthetic `_source` is in technical preview. Features in technical preview may
256+
be changed or removed in a future release. Elastic will apply best effort to fix
257+
any issues, but features in technical preview are not subject to the support SLA
258+
of official GA features.
259+
252260
`aggregate_metric-double` fields support <<synthetic-source,synthetic `_source`>> in their default
253261
configuration. Synthetic `_source` cannot be used together with <<ignore-malformed,`ignore_malformed`>>.
254262

‎docs/reference/mapping/types/boolean.asciidoc

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,15 @@ The following parameters are accepted by `boolean` fields:
216216
Metadata about the field.
217217

218218
[[boolean-synthetic-source]]
219-
==== Synthetic `_source` preview:[]
219+
==== Synthetic `_source`
220+
221+
IMPORTANT: Synthetic `_source` is Generally Available only for TSDB indices
222+
(indices that have `index.mode` set to `time_series`). For other indices
223+
synthetic `_source` is in technical preview. Features in technical preview may
224+
be changed or removed in a future release. Elastic will apply best effort to fix
225+
any issues, but features in technical preview are not subject to the support SLA
226+
of official GA features.
227+
220228
`boolean` fields support <<synthetic-source,synthetic `_source`>> in their
221229
default configuration. Synthetic `_source` cannot be used together with
222230
<<copy-to,`copy_to`>> or with <<doc-values,`doc_values`>> disabled.

‎docs/reference/mapping/types/date.asciidoc

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,15 @@ Which will reply with a date like:
232232
----
233233

234234
[[date-synthetic-source]]
235-
==== Synthetic `_source` preview:[]
235+
==== Synthetic `_source`
236+
237+
IMPORTANT: Synthetic `_source` is Generally Available only for TSDB indices
238+
(indices that have `index.mode` set to `time_series`). For other indices
239+
synthetic `_source` is in technical preview. Features in technical preview may
240+
be changed or removed in a future release. Elastic will apply best effort to fix
241+
any issues, but features in technical preview are not subject to the support SLA
242+
of official GA features.
243+
236244
`date` fields support <<synthetic-source,synthetic `_source`>> in their
237245
default configuration. Synthetic `_source` cannot be used together with
238246
<<copy-to,`copy_to`>>, <<ignore-malformed,`ignore_malformed`>> set to true

‎docs/reference/mapping/types/date_nanos.asciidoc

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,15 @@ field. This limitation also affects <<transforms,{transforms}>>.
141141
---
142142

143143
[[date-nanos-synthetic-source]]
144-
==== Synthetic `_source` preview:[]
144+
==== Synthetic `_source`
145+
146+
IMPORTANT: Synthetic `_source` is Generally Available only for TSDB indices
147+
(indices that have `index.mode` set to `time_series`). For other indices
148+
synthetic `_source` is in technical preview. Features in technical preview may
149+
be changed or removed in a future release. Elastic will apply best effort to fix
150+
any issues, but features in technical preview are not subject to the support SLA
151+
of official GA features.
152+
145153
`date_nanos` fields support <<synthetic-source,synthetic `_source`>> in their
146154
default configuration. Synthetic `_source` cannot be used together with
147155
<<copy-to,`copy_to`>>, <<ignore-malformed,`ignore_malformed`>> set to true

‎docs/reference/mapping/types/dense-vector.asciidoc

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,5 +198,13 @@ neighbors for each new node. Defaults to `100`.
198198
====
199199

200200
[[dense-vector-synthetic-source]]
201-
==== Synthetic `_source` preview:[]
201+
==== Synthetic `_source`
202+
203+
IMPORTANT: Synthetic `_source` is Generally Available only for TSDB indices
204+
(indices that have `index.mode` set to `time_series`). For other indices
205+
synthetic `_source` is in technical preview. Features in technical preview may
206+
be changed or removed in a future release. Elastic will apply best effort to fix
207+
any issues, but features in technical preview are not subject to the support SLA
208+
of official GA features.
209+
202210
`dense_vector` fields support <<synthetic-source,synthetic `_source`>> .

‎docs/reference/mapping/types/geo-point.asciidoc

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,15 @@ def lon = doc['location'].lon;
208208
--------------------------------------------------
209209

210210
[[geo-point-synthetic-source]]
211-
==== Synthetic source preview:[]
211+
==== Synthetic source
212+
213+
IMPORTANT: Synthetic `_source` is Generally Available only for TSDB indices
214+
(indices that have `index.mode` set to `time_series`). For other indices
215+
synthetic `_source` is in technical preview. Features in technical preview may
216+
be changed or removed in a future release. Elastic will apply best effort to fix
217+
any issues, but features in technical preview are not subject to the support SLA
218+
of official GA features.
219+
212220
`geo_point` fields support <<synthetic-source,synthetic `_source`>> in their
213221
default configuration. Synthetic `_source` cannot be used together with
214222
<<ignore-malformed,`ignore_malformed`>>, <<copy-to,`copy_to`>>, or with

‎docs/reference/mapping/types/histogram.asciidoc

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,15 @@ means the field can technically be aggregated with either algorithm, in practice
6969
index data in that manner (e.g. centroids for T-Digest or intervals for HDRHistogram) to ensure best accuracy.
7070

7171
[[histogram-synthetic-source]]
72-
==== Synthetic `_source` preview:[]
72+
==== Synthetic `_source`
73+
74+
IMPORTANT: Synthetic `_source` is Generally Available only for TSDB indices
75+
(indices that have `index.mode` set to `time_series`). For other indices
76+
synthetic `_source` is in technical preview. Features in technical preview may
77+
be changed or removed in a future release. Elastic will apply best effort to fix
78+
any issues, but features in technical preview are not subject to the support SLA
79+
of official GA features.
80+
7381
`histogram` fields support <<synthetic-source,synthetic `_source`>> in their
7482
default configuration. Synthetic `_source` cannot be used together with
7583
<<ignore-malformed,`ignore_malformed`>> or <<copy-to,`copy_to`>>.

‎docs/reference/mapping/types/ip.asciidoc

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,15 @@ GET my-index-000001/_search
152152
--------------------------------------------------
153153

154154
[[ip-synthetic-source]]
155-
==== Synthetic `_source` preview:[]
155+
==== Synthetic `_source`
156+
157+
IMPORTANT: Synthetic `_source` is Generally Available only for TSDB indices
158+
(indices that have `index.mode` set to `time_series`). For other indices
159+
synthetic `_source` is in technical preview. Features in technical preview may
160+
be changed or removed in a future release. Elastic will apply best effort to fix
161+
any issues, but features in technical preview are not subject to the support SLA
162+
of official GA features.
163+
156164
`ip` fields support <<synthetic-source,synthetic `_source`>> in their default
157165
configuration. Synthetic `_source` cannot be used together with
158166
<<copy-to,`copy_to`>> or with <<doc-values,`doc_values`>> disabled.

‎docs/reference/mapping/types/keyword.asciidoc

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,15 @@ Dimension fields have the following constraints:
170170
--
171171

172172
[[keyword-synthetic-source]]
173-
==== Synthetic `_source` preview:[]
173+
==== Synthetic `_source`
174+
175+
IMPORTANT: Synthetic `_source` is Generally Available only for TSDB indices
176+
(indices that have `index.mode` set to `time_series`). For other indices
177+
synthetic `_source` is in technical preview. Features in technical preview may
178+
be changed or removed in a future release. Elastic will apply best effort to fix
179+
any issues, but features in technical preview are not subject to the support SLA
180+
of official GA features.
181+
174182
`keyword` fields support <<synthetic-source,synthetic `_source`>> in their
175183
default configuration. Synthetic `_source` cannot be used together with
176184
a <<normalizer,`normalizer`>> or <<copy-to,`copy_to`>>.

‎docs/reference/mapping/types/numeric.asciidoc

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,15 @@ numeric field can't be both a time series dimension and a time series metric.
228228
This parameter is required.
229229

230230
[[numeric-synthetic-source]]
231-
==== Synthetic `_source` preview:[]
231+
==== Synthetic `_source`
232+
233+
IMPORTANT: Synthetic `_source` is Generally Available only for TSDB indices
234+
(indices that have `index.mode` set to `time_series`). For other indices
235+
synthetic `_source` is in technical preview. Features in technical preview may
236+
be changed or removed in a future release. Elastic will apply best effort to fix
237+
any issues, but features in technical preview are not subject to the support SLA
238+
of official GA features.
239+
232240
All numeric fields except `unsigned_long` support <<synthetic-source,synthetic
233241
`_source`>> in their default configuration. Synthetic `_source` cannot be used
234242
together with <<ignore-malformed,`ignore_malformed`>>, <<copy-to,`copy_to`>>, or

‎docs/reference/mapping/types/text.asciidoc

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,15 @@ The following parameters are accepted by `text` fields:
160160
Metadata about the field.
161161

162162
[[text-synthetic-source]]
163-
==== Synthetic `_source` preview:[]
163+
==== Synthetic `_source`
164+
165+
IMPORTANT: Synthetic `_source` is Generally Available only for TSDB indices
166+
(indices that have `index.mode` set to `time_series`). For other indices
167+
synthetic `_source` is in technical preview. Features in technical preview may
168+
be changed or removed in a future release. Elastic will apply best effort to fix
169+
any issues, but features in technical preview are not subject to the support SLA
170+
of official GA features.
171+
164172
`text` fields support <<synthetic-source,synthetic `_source`>> if they have
165173
a <<keyword-synthetic-source, `keyword`>> sub-field that supports synthetic
166174
`_source` or if the `text` field sets `store` to `true`. Either way, it may

‎docs/reference/mapping/types/version.asciidoc

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,15 @@ you strongly rely on these kind of queries.
6969

7070

7171
[[version-synthetic-source]]
72-
==== Synthetic `_source` preview:[]
72+
==== Synthetic `_source`
73+
74+
IMPORTANT: Synthetic `_source` is Generally Available only for TSDB indices
75+
(indices that have `index.mode` set to `time_series`). For other indices
76+
synthetic `_source` is in technical preview. Features in technical preview may
77+
be changed or removed in a future release. Elastic will apply best effort to fix
78+
any issues, but features in technical preview are not subject to the support SLA
79+
of official GA features.
80+
7381
`version` fields support <<synthetic-source,synthetic `_source`>> so long as they don't
7482
declare <<copy-to,`copy_to`>>.
7583

0 commit comments

Comments
 (0)