Skip to content

Commit e8fc16e

Browse files
przemekwitekprzemekwitek
authored
[Transform] Rename interim_results to align_checkpoints (#76609) (#76645)
1 parent 46529f0 commit e8fc16e

File tree

17 files changed

+195
-92
lines changed

17 files changed

+195
-92
lines changed

‎client/rest-high-level/src/main/java/org/elasticsearch/client/transform/transforms/SettingsConfig.java

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -25,20 +25,20 @@ public class SettingsConfig implements ToXContentObject {
2525
private static final ParseField MAX_PAGE_SEARCH_SIZE = new ParseField("max_page_search_size");
2626
private static final ParseField DOCS_PER_SECOND = new ParseField("docs_per_second");
2727
private static final ParseField DATES_AS_EPOCH_MILLIS = new ParseField("dates_as_epoch_millis");
28-
private static final ParseField INTERIM_RESULTS = new ParseField("interim_results");
28+
private static final ParseField ALIGN_CHECKPOINTS = new ParseField("align_checkpoints");
2929
private static final int DEFAULT_MAX_PAGE_SEARCH_SIZE = -1;
3030
private static final float DEFAULT_DOCS_PER_SECOND = -1F;
3131

3232
// use an integer as we need to code 4 states: true, false, null (unchanged), default (defined server side)
3333
private static final int DEFAULT_DATES_AS_EPOCH_MILLIS = -1;
3434

3535
// use an integer as we need to code 4 states: true, false, null (unchanged), default (defined server side)
36-
private static final int DEFAULT_INTERIM_RESULTS = -1;
36+
private static final int DEFAULT_ALIGN_CHECKPOINTS = -1;
3737

3838
private final Integer maxPageSearchSize;
3939
private final Float docsPerSecond;
4040
private final Integer datesAsEpochMillis;
41-
private final Integer interimResults;
41+
private final Integer alignCheckpoints;
4242

4343
private static final ConstructingObjectParser<SettingsConfig, Void> PARSER = new ConstructingObjectParser<>(
4444
"settings_config",
@@ -59,8 +59,8 @@ public class SettingsConfig implements ToXContentObject {
5959
// this boolean requires 4 possible values: true, false, not_specified, default, therefore using a custom parser
6060
PARSER.declareField(
6161
optionalConstructorArg(),
62-
p -> p.currentToken() == XContentParser.Token.VALUE_NULL ? DEFAULT_INTERIM_RESULTS : p.booleanValue() ? 1 : 0,
63-
INTERIM_RESULTS,
62+
p -> p.currentToken() == XContentParser.Token.VALUE_NULL ? DEFAULT_ALIGN_CHECKPOINTS : p.booleanValue() ? 1 : 0,
63+
ALIGN_CHECKPOINTS,
6464
ValueType.BOOLEAN_OR_NULL
6565
);
6666
}
@@ -69,11 +69,11 @@ public static SettingsConfig fromXContent(final XContentParser parser) {
6969
return PARSER.apply(parser, null);
7070
}
7171

72-
SettingsConfig(Integer maxPageSearchSize, Float docsPerSecond, Integer datesAsEpochMillis, Integer interimResults) {
72+
SettingsConfig(Integer maxPageSearchSize, Float docsPerSecond, Integer datesAsEpochMillis, Integer alignCheckpoints) {
7373
this.maxPageSearchSize = maxPageSearchSize;
7474
this.docsPerSecond = docsPerSecond;
7575
this.datesAsEpochMillis = datesAsEpochMillis;
76-
this.interimResults = interimResults;
76+
this.alignCheckpoints = alignCheckpoints;
7777
}
7878

7979
@Override
@@ -100,11 +100,11 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws
100100
builder.field(DATES_AS_EPOCH_MILLIS.getPreferredName(), datesAsEpochMillis > 0 ? true : false);
101101
}
102102
}
103-
if (interimResults != null) {
104-
if (interimResults.equals(DEFAULT_INTERIM_RESULTS)) {
105-
builder.field(INTERIM_RESULTS.getPreferredName(), (Boolean) null);
103+
if (alignCheckpoints != null) {
104+
if (alignCheckpoints.equals(DEFAULT_ALIGN_CHECKPOINTS)) {
105+
builder.field(ALIGN_CHECKPOINTS.getPreferredName(), (Boolean) null);
106106
} else {
107-
builder.field(INTERIM_RESULTS.getPreferredName(), interimResults > 0 ? true : false);
107+
builder.field(ALIGN_CHECKPOINTS.getPreferredName(), alignCheckpoints > 0 ? true : false);
108108
}
109109
}
110110
builder.endObject();
@@ -123,8 +123,8 @@ public Boolean getDatesAsEpochMillis() {
123123
return datesAsEpochMillis != null ? datesAsEpochMillis > 0 : null;
124124
}
125125

126-
public Boolean getInterimResults() {
127-
return interimResults != null ? interimResults > 0 : null;
126+
public Boolean getAlignCheckpoints() {
127+
return alignCheckpoints != null ? alignCheckpoints > 0 : null;
128128
}
129129

130130
@Override
@@ -140,12 +140,12 @@ public boolean equals(Object other) {
140140
return Objects.equals(maxPageSearchSize, that.maxPageSearchSize)
141141
&& Objects.equals(docsPerSecond, that.docsPerSecond)
142142
&& Objects.equals(datesAsEpochMillis, that.datesAsEpochMillis)
143-
&& Objects.equals(interimResults, that.interimResults);
143+
&& Objects.equals(alignCheckpoints, that.alignCheckpoints);
144144
}
145145

146146
@Override
147147
public int hashCode() {
148-
return Objects.hash(maxPageSearchSize, docsPerSecond, datesAsEpochMillis, interimResults);
148+
return Objects.hash(maxPageSearchSize, docsPerSecond, datesAsEpochMillis, alignCheckpoints);
149149
}
150150

151151
public static Builder builder() {
@@ -156,7 +156,7 @@ public static class Builder {
156156
private Integer maxPageSearchSize;
157157
private Float docsPerSecond;
158158
private Integer datesAsEpochMillis;
159-
private Integer interimResults;
159+
private Integer alignCheckpoints;
160160

161161
/**
162162
* Sets the paging maximum paging maxPageSearchSize that transform can use when
@@ -203,20 +203,20 @@ public Builder setDatesAsEpochMillis(Boolean datesAsEpochMillis) {
203203
}
204204

205205
/**
206-
* Whether to write interim results in transform checkpoints.
206+
* Whether to align transform checkpoint ranges with date histogram interval.
207207
*
208208
* An explicit `null` resets to default.
209209
*
210-
* @param interimResults true if interim results should be written.
211-
* @return the {@link Builder} with interimResults set.
210+
* @param alignCheckpoints true if checkpoint ranges should be aligned with date histogram interval.
211+
* @return the {@link Builder} with alignCheckpoints set.
212212
*/
213-
public Builder setInterimResults(Boolean interimResults) {
214-
this.interimResults = interimResults == null ? DEFAULT_INTERIM_RESULTS : interimResults ? 1 : 0;
213+
public Builder setAlignCheckpoints(Boolean alignCheckpoints) {
214+
this.alignCheckpoints = alignCheckpoints == null ? DEFAULT_ALIGN_CHECKPOINTS : alignCheckpoints ? 1 : 0;
215215
return this;
216216
}
217217

218218
public SettingsConfig build() {
219-
return new SettingsConfig(maxPageSearchSize, docsPerSecond, datesAsEpochMillis, interimResults);
219+
return new SettingsConfig(maxPageSearchSize, docsPerSecond, datesAsEpochMillis, alignCheckpoints);
220220
}
221221
}
222222
}

‎client/rest-high-level/src/test/java/org/elasticsearch/client/transform/transforms/SettingsConfigTests.java

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ public void testExplicitNullOnWriteParser() throws IOException {
7373
assertThat(settingsAsMap.getOrDefault("max_page_search_size", "not_set"), equalTo("not_set"));
7474
assertNull(settingsAsMap.getOrDefault("docs_per_second", "not_set"));
7575
assertThat(settingsAsMap.getOrDefault("dates_as_epoch_millis", "not_set"), equalTo("not_set"));
76-
assertThat(settingsAsMap.getOrDefault("interim_results", "not_set"), equalTo("not_set"));
76+
assertThat(settingsAsMap.getOrDefault("align_checkpoints", "not_set"), equalTo("not_set"));
7777

7878
config = fromString("{\"dates_as_epoch_millis\" : null}");
7979
assertFalse(config.getDatesAsEpochMillis());
@@ -82,16 +82,16 @@ public void testExplicitNullOnWriteParser() throws IOException {
8282
assertThat(settingsAsMap.getOrDefault("max_page_search_size", "not_set"), equalTo("not_set"));
8383
assertThat(settingsAsMap.getOrDefault("docs_per_second", "not_set"), equalTo("not_set"));
8484
assertNull(settingsAsMap.getOrDefault("dates_as_epoch_millis", "not_set"));
85-
assertThat(settingsAsMap.getOrDefault("interim_results", "not_set"), equalTo("not_set"));
85+
assertThat(settingsAsMap.getOrDefault("align_checkpoints", "not_set"), equalTo("not_set"));
8686

87-
config = fromString("{\"interim_results\" : null}");
88-
assertFalse(config.getInterimResults());
87+
config = fromString("{\"align_checkpoints\" : null}");
88+
assertFalse(config.getAlignCheckpoints());
8989

9090
settingsAsMap = xContentToMap(config);
9191
assertThat(settingsAsMap.getOrDefault("max_page_search_size", "not_set"), equalTo("not_set"));
9292
assertThat(settingsAsMap.getOrDefault("docs_per_second", "not_set"), equalTo("not_set"));
9393
assertThat(settingsAsMap.getOrDefault("dates_as_epoch_millis", "not_set"), equalTo("not_set"));
94-
assertNull(settingsAsMap.getOrDefault("interim_results", "not_set"));
94+
assertNull(settingsAsMap.getOrDefault("align_checkpoints", "not_set"));
9595
}
9696

9797
public void testExplicitNullOnWriteBuilder() throws IOException {
@@ -103,12 +103,12 @@ public void testExplicitNullOnWriteBuilder() throws IOException {
103103
assertNull(settingsAsMap.getOrDefault("max_page_search_size", "not_set"));
104104
assertThat(settingsAsMap.getOrDefault("docs_per_second", "not_set"), equalTo("not_set"));
105105
assertThat(settingsAsMap.getOrDefault("dates_as_epoch_millis", "not_set"), equalTo("not_set"));
106-
assertThat(settingsAsMap.getOrDefault("interim_results", "not_set"), equalTo("not_set"));
106+
assertThat(settingsAsMap.getOrDefault("align_checkpoints", "not_set"), equalTo("not_set"));
107107

108108
SettingsConfig emptyConfig = new SettingsConfig.Builder().build();
109109
assertNull(emptyConfig.getMaxPageSearchSize());
110110
assertNull(emptyConfig.getDatesAsEpochMillis());
111-
assertNull(emptyConfig.getInterimResults());
111+
assertNull(emptyConfig.getAlignCheckpoints());
112112

113113
settingsAsMap = xContentToMap(emptyConfig);
114114
assertTrue(settingsAsMap.isEmpty());
@@ -120,7 +120,7 @@ public void testExplicitNullOnWriteBuilder() throws IOException {
120120
assertThat(settingsAsMap.getOrDefault("max_page_search_size", "not_set"), equalTo("not_set"));
121121
assertNull(settingsAsMap.getOrDefault("docs_per_second", "not_set"));
122122
assertThat(settingsAsMap.getOrDefault("dates_as_epoch_millis", "not_set"), equalTo("not_set"));
123-
assertThat(settingsAsMap.getOrDefault("interim_results", "not_set"), equalTo("not_set"));
123+
assertThat(settingsAsMap.getOrDefault("align_checkpoints", "not_set"), equalTo("not_set"));
124124

125125
config = new SettingsConfig.Builder().setDatesAsEpochMillis(null).build();
126126
// returns false, however it's `null` as in "use default", checked next
@@ -130,17 +130,17 @@ public void testExplicitNullOnWriteBuilder() throws IOException {
130130
assertThat(settingsAsMap.getOrDefault("max_page_search_size", "not_set"), equalTo("not_set"));
131131
assertThat(settingsAsMap.getOrDefault("docs_per_second", "not_set"), equalTo("not_set"));
132132
assertNull(settingsAsMap.getOrDefault("dates_as_epoch_millis", "not_set"));
133-
assertThat(settingsAsMap.getOrDefault("interim_results", "not_set"), equalTo("not_set"));
133+
assertThat(settingsAsMap.getOrDefault("align_checkpoints", "not_set"), equalTo("not_set"));
134134

135-
config = new SettingsConfig.Builder().setInterimResults(null).build();
135+
config = new SettingsConfig.Builder().setAlignCheckpoints(null).build();
136136
// returns false, however it's `null` as in "use default", checked next
137-
assertFalse(config.getInterimResults());
137+
assertFalse(config.getAlignCheckpoints());
138138

139139
settingsAsMap = xContentToMap(config);
140140
assertThat(settingsAsMap.getOrDefault("max_page_search_size", "not_set"), equalTo("not_set"));
141141
assertThat(settingsAsMap.getOrDefault("docs_per_second", "not_set"), equalTo("not_set"));
142142
assertThat(settingsAsMap.getOrDefault("dates_as_epoch_millis", "not_set"), equalTo("not_set"));
143-
assertNull(settingsAsMap.getOrDefault("interim_results", "not_set"));
143+
assertNull(settingsAsMap.getOrDefault("align_checkpoints", "not_set"));
144144
}
145145

146146
private Map<String, Object> xContentToMap(ToXContent xcontent) throws IOException {

‎client/rest-high-level/src/test/java/org/elasticsearch/client/transform/transforms/hlrc/SettingsConfigTests.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ public static void assertHlrcEquals(
3535
assertEquals(serverTestInstance.getMaxPageSearchSize(), clientInstance.getMaxPageSearchSize());
3636
assertEquals(serverTestInstance.getDocsPerSecond(), clientInstance.getDocsPerSecond());
3737
assertEquals(serverTestInstance.getDatesAsEpochMillis(), clientInstance.getDatesAsEpochMillis());
38-
assertEquals(serverTestInstance.getInterimResults(), clientInstance.getInterimResults());
38+
assertEquals(serverTestInstance.getAlignCheckpoints(), clientInstance.getAlignCheckpoints());
3939
}
4040

4141
@Override

‎docs/reference/rest-api/common-parms.asciidoc

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1019,6 +1019,14 @@ throttles the {transform} by adding a wait time between search requests. The
10191019
default value is `null`, which disables throttling.
10201020
end::transform-settings-docs-per-second[]
10211021

1022+
tag::transform-settings-align-checkpoints[]
1023+
Specifies whether the transform checkpoint ranges should be optimized for performance.
1024+
Such optimization can align checkpoint ranges with date histogram interval when date histogram
1025+
is specified as a group source in the transform config. As an effect, less document updates in the
1026+
destination index will be performed thus improving overall performance.
1027+
The default value is `true`, which means the checkpoint ranges will be optimized if possible.
1028+
end::transform-settings-align-checkpoints[]
1029+
10221030
tag::transform-settings-max-page-search-size[]
10231031
Defines the initial page size to use for the composite aggregation for each
10241032
checkpoint. If circuit breaker exceptions occur, the page size is dynamically

‎docs/reference/transform/apis/preview-transform.asciidoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,9 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings]
204204
`docs_per_second`:::
205205
(Optional, float)
206206
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-docs-per-second]
207+
`align_checkpoints`:::
208+
(Optional, boolean)
209+
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-align-checkpoints]
207210
`max_page_search_size`:::
208211
(Optional, integer)
209212
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-max-page-search-size]

‎docs/reference/transform/apis/put-transform.asciidoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -186,6 +186,9 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-dat
186186
`docs_per_second`:::
187187
(Optional, float)
188188
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-docs-per-second]
189+
`align_checkpoints`:::
190+
(Optional, boolean)
191+
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-align-checkpoints]
189192
`max_page_search_size`:::
190193
(Optional, integer)
191194
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-max-page-search-size]

‎docs/reference/transform/apis/update-transform.asciidoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,9 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-dat
138138
`docs_per_second`:::
139139
(Optional, float)
140140
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-docs-per-second]
141+
`align_checkpoints`:::
142+
(Optional, boolean)
143+
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-align-checkpoints]
141144
`max_page_search_size`:::
142145
(Optional, integer)
143146
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-max-page-search-size]

‎x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/transform/TransformField.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ public final class TransformField {
3737
public static final ParseField MAX_PAGE_SEARCH_SIZE = new ParseField("max_page_search_size");
3838
public static final ParseField DOCS_PER_SECOND = new ParseField("docs_per_second");
3939
public static final ParseField DATES_AS_EPOCH_MILLIS = new ParseField("dates_as_epoch_millis");
40-
public static final ParseField INTERIM_RESULTS = new ParseField("interim_results");
40+
public static final ParseField ALIGN_CHECKPOINTS = new ParseField("align_checkpoints");
4141
public static final ParseField FIELD = new ParseField("field");
4242
public static final ParseField SYNC = new ParseField("sync");
4343
public static final ParseField TIME = new ParseField("time");

0 commit comments

Comments
 (0)