Skip to content
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

[DOCS] Add docs for runtime fields #62653

Merged
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
53 commits
Select commit Hold shift + click to select a range
1eebe84
First steps in docs for runtime fields.
Sep 14, 2020
e1c0427
Adding new page for runtime fields.
Sep 14, 2020
47bb110
Adding page for runtime fields.
Sep 15, 2020
0c97b92
Adding more to the runtime fields topic.
Sep 17, 2020
ee8a16f
Adding parameters and retrieval options for runtime fields.
Sep 18, 2020
f56bde0
Adding TESTSETUP for index creation.
Sep 18, 2020
bb82284
Incorporating review feedback.
Sep 21, 2020
b2cbf0a
Incorporating reviewer feedback.
Sep 22, 2020
d119cbd
Adding examples for runtime fields.
Sep 23, 2020
a287895
Adding more context and simplifying the example.
Sep 24, 2020
ce0fcdd
Merge branch 'master' into docs__add-runtime-fields
elasticmachine Sep 28, 2020
2b533f7
Changing timestamp to @timestamp throughout.
Sep 28, 2020
d2d8551
Removing duplicate @timestamp field.
Sep 28, 2020
282a777
Expanding example to hopefully fix CI builds.
Sep 28, 2020
50a30f6
Adding skip test for result.
Sep 28, 2020
eb4c6c7
Merge branch 'master' into docs__add-runtime-fields
elasticmachine Sep 28, 2020
f8a3d50
Adding missing callout.
Sep 28, 2020
796a10f
Merge branch 'docs__add-runtime-fields' of github.com:lockewritesdocs…
Sep 28, 2020
301abd1
Adding TESTRESPONSEs, which are currently broken.
Sep 28, 2020
62a5393
Fixing TESTRESPONSEs.
Sep 29, 2020
36c9244
Incorporating review feedback.
Sep 29, 2020
804f10f
Several clarifications, better test cases, and other changes.
Sep 30, 2020
875713c
Adding missing callout in example.
Oct 1, 2020
54d529a
Adding substitutions to TESTRESPONSE for shorter results shown.
Oct 1, 2020
7c1a7e0
Shuffling some information and adding link to script-fields.
Oct 26, 2020
d3f3e4b
Fixing typo.
Oct 26, 2020
3fe1541
Updates for API redesign -- will break builds.
Oct 30, 2020
2d158de
Merge branch 'master' into docs__add-runtime-fields
elasticmachine Nov 19, 2020
6d495f0
Updating examples and including info about overriding fields.
Nov 23, 2020
e00f80f
Updating examples.
Nov 24, 2020
c631ce9
Merge branch 'master' into docs__add-runtime-fields
elasticmachine Nov 24, 2020
8824bea
Adding info for using runtime fields in the search request.
Nov 24, 2020
282c261
Merge branch 'docs__add-runtime-fields' of github.com:lockewritesdocs…
Nov 24, 2020
72cf354
Adding that queries against runtime fields are expensive.
Nov 25, 2020
35d7b6a
Incorporating feedback from reviewers.
Nov 30, 2020
4cd5b20
Minor changes from reviews.
Dec 1, 2020
a2be37b
Merge branch 'master' into docs__add-runtime-fields
elasticmachine Dec 1, 2020
99b2720
Adding alias for test case.
Dec 1, 2020
43dd29d
Adding aliases to PUT example.
Dec 1, 2020
994b1c2
Fixing test cases, for real this time.
Dec 1, 2020
38194b2
Updating use cases and introducing overlay throughout.
Dec 1, 2020
70a82e8
Edits, adding 'shadowing', and explaining shadowing better.
Dec 2, 2020
c27ce4c
Streamlining tests and other changes.
Dec 3, 2020
d9a9271
Fix formatting in example for test.
Dec 3, 2020
4d5452d
Apply suggestions from code review
Dec 7, 2020
8175917
Incorporating reviewer feedback 7 Dec
Dec 7, 2020
4e7b0b8
Merge branch 'master' into docs__add-runtime-fields
elasticmachine Dec 8, 2020
b732ae2
Shifting structure of mapping page to fix cross links.
Dec 8, 2020
1ea874f
Merge branch 'docs__add-runtime-fields' of github.com:lockewritesdocs…
Dec 8, 2020
8870aab
Revisions for shadowing, overview, and other sections.
Dec 8, 2020
1475e9d
Removing dot notation section and incorporating review changes.
Dec 9, 2020
06241b7
Adding updated example for shadowing.
Dec 9, 2020
c1b61ee
Streamlining shadowing example and TESTRESPONSEs.
Dec 9, 2020
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
24 changes: 22 additions & 2 deletions docs/reference/mapping/types.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -108,11 +108,12 @@ as-you-type completion.
=== Arrays
In {es}, arrays do not require a dedicated field data type. Any field can contain
zero or more values by default, however, all values in the array must be of the
same field type. See <<array>>.
same field type.

See <<array>> to learn more.
lockewritesdocs marked this conversation as resolved.
Show resolved Hide resolved

[discrete]
=== Multi-fields

It is often useful to index the same field in different ways for different
purposes. For instance, a `string` field could be mapped as
a `text` field for full-text search, and as a `keyword` field for
Expand All @@ -124,6 +125,23 @@ the <<analysis-standard-analyzer,`standard` analyzer>>, the
This is the purpose of _multi-fields_. Most field types support multi-fields
via the <<multi-fields>> parameter.

[discrete]
=== Runtime
lockewritesdocs marked this conversation as resolved.
Show resolved Hide resolved
Oftentimes, you just want to make your data available to {es} without indexing
or preprocessing. _Runtime fields_ extend the flexibility of the
<<search-search,search API>> to quickly make data searchable, even with minimal
structure.

// tag::runtime-fields-description[]
Runtime fields are not indexed and do have <<doc-values,doc_values>>, meaning
Lucene is unaware of their existence. However, runtime fields are accessible
from the search API like any other field that has `doc_values` and is
searchable. You can retrieve and query these fields, as well as aggregate and
sort on them.
lockewritesdocs marked this conversation as resolved.
Show resolved Hide resolved
// end::runtime-fields-description[]

See <<runtime>> to learn more.

include::types/alias.asciidoc[]

include::types/array.asciidoc[]
Expand Down Expand Up @@ -168,6 +186,8 @@ include::types/rank-feature.asciidoc[]

include::types/rank-features.asciidoc[]

include::types/runtime.asciidoc[]

include::types/search-as-you-type.asciidoc[]

include::types/text.asciidoc[]
Expand Down
94 changes: 94 additions & 0 deletions docs/reference/mapping/types/runtime.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
[[runtime]]
lockewritesdocs marked this conversation as resolved.
Show resolved Hide resolved
=== Runtime

////
[source,console]
----
PUT /my-index
----
// TESTSETUP
////

Typically, you must index fields to {es} before they can be retrieved,
aggregated, or searched. With runtime fields, you can explicitly define a field
in the mapping and access it at runtime without indexing your data. This
flexibility allows you to more quickly ingest raw data into the Elastic Stack
and immediately access it. By dynamically evaluating runtime fields at query
time, you can choose which fields to index and optimize disk space.

include::{es-ref-dir}/mapping/types.asciidoc[tag=runtime-fields-description]

// Each runtime field is of the `runtime` data type, and has its own
// <<mapping-types,field type>>, such as `boolean`, `long`, or `keyword`. The
// field type identifies the data type In
// the following example, the data type is `runtime` and the runtime field type is
// `keyword`.

==== Specifying runtime fields
lockewritesdocs marked this conversation as resolved.
Show resolved Hide resolved
Runtime fields do not have access to the
<<mapping-source-field,`_source` field>>. You specify runtime fields in the
lockewritesdocs marked this conversation as resolved.
Show resolved Hide resolved
mapping by <<modules-scripting-using,defining a script>>, which always has
access to the `source` field. At search time, the script runs and generates
lockewritesdocs marked this conversation as resolved.
Show resolved Hide resolved
values for each scripted field.

The script in the following request extracts the day of the week from the
`timestamp` field, which is defined as a `date` data type.

[source,console]
----
PUT /my-index/_mappings
{
"properties" : {
"day_of_week" : {
"type" : "runtime", <1>
"runtime_type" : "keyword", <2>
"script" : {
"source" : "emit(doc['timestamp'].value.dayOfWeekEnum.getDisplayName(TextStyle.FULL, Locale.ROOT))"
}
}
}
}
----

<1> Runtime fields are of the `runtime` data type.
<2> Each runtime has its own field type, defined by `runtime_type`.

[[runtime-params]]
==== Parameters for `runtime` fields
Runtime fields accept the following parameters:

`type`::
The type of runtime computation to perform at query time. Currently, runtime
fields only support the `runtime` data type.

`runtime_type`::
lockewritesdocs marked this conversation as resolved.
Show resolved Hide resolved
The <<mapping-types,field type>> for each scripted field. {es}
supports `boolean`, `date`, `double`, `ip`, `keyword`, and `long`.

lockewritesdocs marked this conversation as resolved.
Show resolved Hide resolved
==== Retrieving runtime fields
lockewritesdocs marked this conversation as resolved.
Show resolved Hide resolved
Because runtime fields are not part of the `_source` field, they are not
lockewritesdocs marked this conversation as resolved.
Show resolved Hide resolved
returned in search hits by default. You can request runtime fields by using the
<<search-fields,`fields`>> parameter, or by using the
<<docvalue-fields,`docvalue_fields`>> parameter to return `doc_values` for one
or more fields in the search response.

Use the <<search-field-caps,field capabilities API>> to return runtime fields
like any other field. For example, a runtime field with a `runtime_type` of
`keyword` returns as any other field that belongs to the `keyword` family.
lockewritesdocs marked this conversation as resolved.
Show resolved Hide resolved

The following request uses the search API to retrieve the `day_of_week` field
that the previous request defined in the mapping.

[source,console]
----
GET /my-index/_search
{
"aggs": {
"days_of_week": {
"terms": {
"field": "day_of_week"
}
}
}
}
----