Skip to content

[DOCS] Clarifies destination index mappings for Transforms #63794

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 1 commit into from
Oct 16, 2020
Merged

[DOCS] Clarifies destination index mappings for Transforms #63794

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 5 additions & 1 deletion docs/reference/rest-api/common-parms.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,11 @@ The destination for the {transform}.
end::dest[]

tag::dest-index[]
The _destination index_ for the {transform}.
The _destination index_ for the {transform}. The mappings of the destination
index are deduced based on the source fields when possible. If alternate
mappings are required, use the
https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html[Create index API]
prior to starting the {transform}.
end::dest-index[]

tag::dest-pipeline[]
Expand Down
17 changes: 12 additions & 5 deletions docs/reference/transform/limitations.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,18 @@ or <<search-aggregations-pipeline-bucket-script-aggregation,`bucket_scripts`>>,
<<dynamic-mapping,dynamic mappings>> will be used. In some instances the
deduced mappings may be incompatible with the actual data. For example, numeric
overflows might occur or dynamically mapped fields might contain both numbers
and strings. Please check {es} logs if you think this may have occurred. As a
workaround, you may define custom mappings prior to starting the
{transform}. For example,
<<indices-create-index,create a custom destination index>> or
<<indices-templates,define an index template>>.
and strings. Please check {es} logs if you think this may have occurred.

You can view the deduced mappings by using the
https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html[Preview transform API].
See the `generated_dest_index` object in the API response.

If it's required, you may define custom mappings prior to starting the
{transform} by creating a custom destination index using the
https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html[Create index API].
As deduced mappings cannot be overwritten by an index template, use the Create
index API to define custom mappings. The index templates only apply to fields
derived from scripts that use dynamic mappings.

[discrete]
[[transform-batch-limitations]]
Expand Down