Skip to content

Fix some typos in scripted and runtime fields doc. #2665

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
Aug 13, 2023
Merged

Fix some typos in scripted and runtime fields doc. #2665

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
16 changes: 8 additions & 8 deletions src/main/asciidoc/reference/elasticsearch-misc-scripted-and-runtime-fields.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ Please refer to the Elasticsearch documentation about scripting (https://www.ela
In the context of Spring Data Elasticsearch you can use

* scripted fields that are used to return fields that are calculated on the result documents and added to the returned document.
* runtime fields that are calculated on the stored documents and can be used in a query and/or be returned in the search result.
* runtime fields that are calculated on the stored documents and can be used in a query and/or be returned in the search result.

The following code snippets will show what you can do (this show imperative code, but the reactive implementation works similar).
The following code snippets will show what you can do (these show imperative code, but the reactive implementation works similar).

== The person entity

Expand Down Expand Up @@ -62,7 +62,7 @@ public record Person(
----

<.> the `age` property will be calculated and filled in search results.
<.> a convenience constructor to set up the test data
<.> a convenience constructor to set up the test data.
====

Note that the `age` property is annotated with `@ScriptedField`.
Expand All @@ -87,7 +87,7 @@ public interface PersonRepository extends ElasticsearchRepository<Person, String

== The service class

The service class has a repository injected and an `ElasticsearchOperations` instance to show several ways of poplauting and using the `age` property.
The service class has a repository injected and an `ElasticsearchOperations` instance to show several ways of populating and using the `age` property.
We show the code split up in different pieces to put the explanations in

====
Expand Down Expand Up @@ -137,8 +137,8 @@ public class PersonService {

=== Scripted fields

The next piece show how to use a scripted field to calculate and return the age of the persons.
Scripted fields can only add something to the returned data, the age cannot be used in the query (see runtime fields for that).)
The next piece shows how to use a scripted field to calculate and return the age of the persons.
Scripted fields can only add something to the returned data, the age cannot be used in the query (see runtime fields for that).

====
[source,java]
Expand Down Expand Up @@ -212,12 +212,12 @@ In the following code this is used to run a query for a given gender and maximum
}
----

<.> define the runtime field that caclulates the // see https://asciidoctor.org/docs/user-manual/#builtin-attributes for builtin attributes.
<.> define the runtime field that calculates the age of a person. // see https://asciidoctor.org/docs/user-manual/#builtin-attributes for builtin attributes.
<.> when using `Query`, add the runtime field.
<.> when adding a scripted field to a `Query`, an additional field parameter is needed to have the calculated value returned.
<.> when adding a scripted field to a `Query`, an additional source filter is needed to also retrieve the _normal_ fields from the document source.
<.> get the data filtered with the query and where the returned entites have the age property set.
<.> when using the repository, all that needs to be done is adding the runtime field as method parameter.
====

In addition to define a runtime fields on a query, they can also be defined in the index by setting the `runtimeFIeldPath` property of the `@Mapping` annotation to point to a JSON file that contains the runtime field definitions.
In addition to define a runtime fields on a query, they can also be defined in the index by setting the `runtimeFieldsPath` property of the `@Mapping` annotation to point to a JSON file that contains the runtime field definitions.