-
Notifications
You must be signed in to change notification settings - Fork 25k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
HLRC: reindex API with wait_for_completion false (#35202)
Extend High Level Rest Client Reindex API to support requests with wait_for_completion=false. This method will return a TaskSubmissionResult with task identifier as string and results can be queried with Task API refers: #27205
- Loading branch information
Showing
10 changed files
with
400 additions
and
192 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
78 changes: 78 additions & 0 deletions
78
.../rest-high-level/src/main/java/org/elasticsearch/client/tasks/TaskSubmissionResponse.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
/* | ||
* Licensed to Elasticsearch under one or more contributor | ||
* license agreements. See the NOTICE file distributed with | ||
* this work for additional information regarding copyright | ||
* ownership. Elasticsearch licenses this file to you under | ||
* the Apache License, Version 2.0 (the "License"); you may | ||
* not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, | ||
* software distributed under the License is distributed on an | ||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
* KIND, either express or implied. See the License for the | ||
* specific language governing permissions and limitations | ||
* under the License. | ||
*/ | ||
|
||
package org.elasticsearch.client.tasks; | ||
|
||
import org.elasticsearch.action.ActionResponse; | ||
import org.elasticsearch.common.ParseField; | ||
import org.elasticsearch.common.xcontent.ConstructingObjectParser; | ||
import org.elasticsearch.common.xcontent.XContentParser; | ||
|
||
import java.io.IOException; | ||
import java.util.Objects; | ||
|
||
public class TaskSubmissionResponse extends ActionResponse { | ||
|
||
private static final ParseField TASK = new ParseField("task"); | ||
|
||
public static final ConstructingObjectParser<TaskSubmissionResponse, Void> PARSER = new ConstructingObjectParser<>( | ||
"task_submission_response", | ||
true, a -> new TaskSubmissionResponse((String) a[0])); | ||
|
||
static { | ||
PARSER.declareString(ConstructingObjectParser.optionalConstructorArg(), TASK); | ||
} | ||
|
||
private final String task; | ||
|
||
TaskSubmissionResponse(String task) { | ||
this.task = task; | ||
} | ||
|
||
/** | ||
* Get the task id | ||
* | ||
* @return the id of the reindex task. | ||
*/ | ||
public String getTask() { | ||
return task; | ||
} | ||
|
||
@Override | ||
public int hashCode() { | ||
return Objects.hash(task); | ||
} | ||
|
||
@Override | ||
public boolean equals(Object other) { | ||
if (this == other) { | ||
return true; | ||
} | ||
if (other == null || getClass() != other.getClass()) { | ||
return false; | ||
} | ||
TaskSubmissionResponse that = (TaskSubmissionResponse) other; | ||
return Objects.equals(task, that.task); | ||
} | ||
|
||
public static TaskSubmissionResponse fromXContent(XContentParser parser) throws IOException { | ||
return PARSER.parse(parser, null); | ||
} | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
133 changes: 133 additions & 0 deletions
133
client/rest-high-level/src/test/java/org/elasticsearch/client/ReindexIT.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,133 @@ | ||
/* | ||
* Licensed to Elasticsearch under one or more contributor | ||
* license agreements. See the NOTICE file distributed with | ||
* this work for additional information regarding copyright | ||
* ownership. Elasticsearch licenses this file to you under | ||
* the Apache License, Version 2.0 (the "License"); you may | ||
* not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, | ||
* software distributed under the License is distributed on an | ||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
* KIND, either express or implied. See the License for the | ||
* specific language governing permissions and limitations | ||
* under the License. | ||
*/ | ||
|
||
package org.elasticsearch.client; | ||
|
||
import org.elasticsearch.action.bulk.BulkRequest; | ||
import org.elasticsearch.action.index.IndexRequest; | ||
import org.elasticsearch.action.support.WriteRequest; | ||
import org.elasticsearch.client.tasks.TaskSubmissionResponse; | ||
import org.elasticsearch.common.settings.Settings; | ||
import org.elasticsearch.common.xcontent.XContentType; | ||
import org.elasticsearch.index.query.IdsQueryBuilder; | ||
import org.elasticsearch.index.reindex.BulkByScrollResponse; | ||
import org.elasticsearch.index.reindex.ReindexRequest; | ||
import org.elasticsearch.rest.RestStatus; | ||
|
||
import java.io.IOException; | ||
import java.util.Collections; | ||
import java.util.function.BooleanSupplier; | ||
|
||
public class ReindexIT extends ESRestHighLevelClientTestCase { | ||
|
||
public void testReindex() throws IOException { | ||
final String sourceIndex = "source1"; | ||
final String destinationIndex = "dest"; | ||
{ | ||
// Prepare | ||
Settings settings = Settings.builder() | ||
.put("number_of_shards", 1) | ||
.put("number_of_replicas", 0) | ||
.build(); | ||
createIndex(sourceIndex, settings); | ||
createIndex(destinationIndex, settings); | ||
BulkRequest bulkRequest = new BulkRequest() | ||
.add(new IndexRequest(sourceIndex, "type", "1").source(Collections.singletonMap("foo", "bar"), XContentType.JSON)) | ||
.add(new IndexRequest(sourceIndex, "type", "2").source(Collections.singletonMap("foo2", "bar2"), XContentType.JSON)) | ||
.setRefreshPolicy(WriteRequest.RefreshPolicy.IMMEDIATE); | ||
assertEquals( | ||
RestStatus.OK, | ||
highLevelClient().bulk( | ||
bulkRequest, | ||
RequestOptions.DEFAULT | ||
).status() | ||
); | ||
} | ||
{ | ||
// reindex one document with id 1 from source to destination | ||
ReindexRequest reindexRequest = new ReindexRequest(); | ||
reindexRequest.setSourceIndices(sourceIndex); | ||
reindexRequest.setDestIndex(destinationIndex); | ||
reindexRequest.setSourceQuery(new IdsQueryBuilder().addIds("1").types("type")); | ||
reindexRequest.setRefresh(true); | ||
|
||
BulkByScrollResponse bulkResponse = execute(reindexRequest, highLevelClient()::reindex, highLevelClient()::reindexAsync); | ||
|
||
assertEquals(1, bulkResponse.getCreated()); | ||
assertEquals(1, bulkResponse.getTotal()); | ||
assertEquals(0, bulkResponse.getDeleted()); | ||
assertEquals(0, bulkResponse.getNoops()); | ||
assertEquals(0, bulkResponse.getVersionConflicts()); | ||
assertEquals(1, bulkResponse.getBatches()); | ||
assertTrue(bulkResponse.getTook().getMillis() > 0); | ||
assertEquals(1, bulkResponse.getBatches()); | ||
assertEquals(0, bulkResponse.getBulkFailures().size()); | ||
assertEquals(0, bulkResponse.getSearchFailures().size()); | ||
} | ||
} | ||
|
||
public void testReindexTask() throws IOException, InterruptedException { | ||
final String sourceIndex = "source123"; | ||
final String destinationIndex = "dest2"; | ||
{ | ||
// Prepare | ||
Settings settings = Settings.builder() | ||
.put("number_of_shards", 1) | ||
.put("number_of_replicas", 0) | ||
.build(); | ||
createIndex(sourceIndex, settings); | ||
createIndex(destinationIndex, settings); | ||
BulkRequest bulkRequest = new BulkRequest() | ||
.add(new IndexRequest(sourceIndex, "type", "1").source(Collections.singletonMap("foo", "bar"), XContentType.JSON)) | ||
.add(new IndexRequest(sourceIndex, "type", "2").source(Collections.singletonMap("foo2", "bar2"), XContentType.JSON)) | ||
.setRefreshPolicy(WriteRequest.RefreshPolicy.IMMEDIATE); | ||
assertEquals( | ||
RestStatus.OK, | ||
highLevelClient().bulk( | ||
bulkRequest, | ||
RequestOptions.DEFAULT | ||
).status() | ||
); | ||
} | ||
{ | ||
ReindexRequest reindexRequest = new ReindexRequest(); | ||
reindexRequest.setSourceIndices(sourceIndex); | ||
reindexRequest.setDestIndex(destinationIndex); | ||
reindexRequest.setSourceQuery(new IdsQueryBuilder().addIds("1").types("type")); | ||
reindexRequest.setRefresh(true); | ||
|
||
TaskSubmissionResponse reindexSubmission = highLevelClient().submitReindexTask(reindexRequest, RequestOptions.DEFAULT); | ||
|
||
BooleanSupplier hasUpgradeCompleted = checkCompletionStatus(reindexSubmission.getTask()); | ||
awaitBusy(hasUpgradeCompleted); | ||
} | ||
} | ||
|
||
private BooleanSupplier checkCompletionStatus(String taskId) { | ||
return () -> { | ||
try { | ||
Response response = client().performRequest(new Request("GET", "/_tasks/" + taskId)); | ||
return (boolean) entityAsMap(response).get("completed"); | ||
} catch (IOException e) { | ||
fail(e.getMessage()); | ||
return false; | ||
} | ||
}; | ||
} | ||
} |
Oops, something went wrong.