|
| 1 | +/* |
| 2 | + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one |
| 3 | + * or more contributor license agreements. Licensed under the Elastic License |
| 4 | + * 2.0 and the Server Side Public License, v 1; you may not use this file except |
| 5 | + * in compliance with, at your election, the Elastic License 2.0 or the Server |
| 6 | + * Side Public License, v 1. |
| 7 | + */ |
| 8 | + |
| 9 | +package org.elasticsearch.action.search; |
| 10 | + |
| 11 | +import org.elasticsearch.action.IndicesRequest; |
| 12 | +import org.elasticsearch.action.OriginalIndices; |
| 13 | +import org.elasticsearch.action.support.IndicesOptions; |
| 14 | +import org.elasticsearch.common.io.stream.StreamInput; |
| 15 | +import org.elasticsearch.common.io.stream.StreamOutput; |
| 16 | +import org.elasticsearch.common.io.stream.Writeable; |
| 17 | +import org.elasticsearch.core.Nullable; |
| 18 | +import org.elasticsearch.core.TimeValue; |
| 19 | +import org.elasticsearch.index.shard.ShardId; |
| 20 | +import org.elasticsearch.search.Scroll; |
| 21 | +import org.elasticsearch.search.builder.SearchSourceBuilder; |
| 22 | +import org.elasticsearch.search.internal.AliasFilter; |
| 23 | +import org.elasticsearch.search.internal.ShardSearchContextId; |
| 24 | +import org.elasticsearch.search.internal.ShardSearchRequest; |
| 25 | +import org.elasticsearch.tasks.Task; |
| 26 | +import org.elasticsearch.tasks.TaskId; |
| 27 | +import org.elasticsearch.transport.TransportRequest; |
| 28 | + |
| 29 | +import java.io.IOException; |
| 30 | +import java.util.ArrayList; |
| 31 | +import java.util.Arrays; |
| 32 | +import java.util.List; |
| 33 | +import java.util.Map; |
| 34 | +import java.util.stream.Collectors; |
| 35 | + |
| 36 | +/** |
| 37 | + * Node-level request used during can-match phase |
| 38 | + */ |
| 39 | +public class CanMatchNodeRequest extends TransportRequest implements IndicesRequest { |
| 40 | + |
| 41 | + private final SearchSourceBuilder source; |
| 42 | + private final List<Shard> shards; |
| 43 | + private final SearchType searchType; |
| 44 | + private final Boolean requestCache; |
| 45 | + private final boolean allowPartialSearchResults; |
| 46 | + private final Scroll scroll; |
| 47 | + private final int numberOfShards; |
| 48 | + private final long nowInMillis; |
| 49 | + @Nullable |
| 50 | + private final String clusterAlias; |
| 51 | + private final String[] indices; |
| 52 | + private final IndicesOptions indicesOptions; |
| 53 | + private final TimeValue waitForCheckpointsTimeout; |
| 54 | + |
| 55 | + public static class Shard implements Writeable { |
| 56 | + private final String[] indices; |
| 57 | + private final ShardId shardId; |
| 58 | + private final int shardRequestIndex; |
| 59 | + private final AliasFilter aliasFilter; |
| 60 | + private final float indexBoost; |
| 61 | + private final ShardSearchContextId readerId; |
| 62 | + private final TimeValue keepAlive; |
| 63 | + private final long waitForCheckpoint; |
| 64 | + |
| 65 | + public Shard(String[] indices, |
| 66 | + ShardId shardId, |
| 67 | + int shardRequestIndex, |
| 68 | + AliasFilter aliasFilter, |
| 69 | + float indexBoost, |
| 70 | + ShardSearchContextId readerId, |
| 71 | + TimeValue keepAlive, |
| 72 | + long waitForCheckpoint) { |
| 73 | + this.indices = indices; |
| 74 | + this.shardId = shardId; |
| 75 | + this.shardRequestIndex = shardRequestIndex; |
| 76 | + this.aliasFilter = aliasFilter; |
| 77 | + this.indexBoost = indexBoost; |
| 78 | + this.readerId = readerId; |
| 79 | + this.keepAlive = keepAlive; |
| 80 | + this.waitForCheckpoint = waitForCheckpoint; |
| 81 | + assert keepAlive == null || readerId != null : "readerId: " + readerId + " keepAlive: " + keepAlive; |
| 82 | + } |
| 83 | + |
| 84 | + public Shard(StreamInput in) throws IOException { |
| 85 | + indices = in.readStringArray(); |
| 86 | + shardId = new ShardId(in); |
| 87 | + shardRequestIndex = in.readVInt(); |
| 88 | + aliasFilter = new AliasFilter(in); |
| 89 | + indexBoost = in.readFloat(); |
| 90 | + readerId = in.readOptionalWriteable(ShardSearchContextId::new); |
| 91 | + keepAlive = in.readOptionalTimeValue(); |
| 92 | + waitForCheckpoint = in.readLong(); |
| 93 | + assert keepAlive == null || readerId != null : "readerId: " + readerId + " keepAlive: " + keepAlive; |
| 94 | + } |
| 95 | + |
| 96 | + @Override |
| 97 | + public void writeTo(StreamOutput out) throws IOException { |
| 98 | + out.writeStringArray(indices); |
| 99 | + shardId.writeTo(out); |
| 100 | + out.writeVInt(shardRequestIndex); |
| 101 | + aliasFilter.writeTo(out); |
| 102 | + out.writeFloat(indexBoost); |
| 103 | + out.writeOptionalWriteable(readerId); |
| 104 | + out.writeOptionalTimeValue(keepAlive); |
| 105 | + out.writeLong(waitForCheckpoint); |
| 106 | + } |
| 107 | + |
| 108 | + public int getShardRequestIndex() { |
| 109 | + return shardRequestIndex; |
| 110 | + } |
| 111 | + |
| 112 | + public String[] getOriginalIndices() { |
| 113 | + return indices; |
| 114 | + } |
| 115 | + |
| 116 | + public ShardId shardId() { |
| 117 | + return shardId; |
| 118 | + } |
| 119 | + } |
| 120 | + |
| 121 | + public CanMatchNodeRequest( |
| 122 | + SearchRequest searchRequest, |
| 123 | + IndicesOptions indicesOptions, |
| 124 | + List<Shard> shards, |
| 125 | + int numberOfShards, |
| 126 | + long nowInMillis, |
| 127 | + @Nullable String clusterAlias |
| 128 | + ) { |
| 129 | + this.source = searchRequest.source(); |
| 130 | + this.indicesOptions = indicesOptions; |
| 131 | + this.shards = new ArrayList<>(shards); |
| 132 | + this.searchType = searchRequest.searchType(); |
| 133 | + this.requestCache = searchRequest.requestCache(); |
| 134 | + // If allowPartialSearchResults is unset (ie null), the cluster-level default should have been substituted |
| 135 | + // at this stage. Any NPEs in the above are therefore an error in request preparation logic. |
| 136 | + assert searchRequest.allowPartialSearchResults() != null; |
| 137 | + this.allowPartialSearchResults = searchRequest.allowPartialSearchResults(); |
| 138 | + this.scroll = searchRequest.scroll(); |
| 139 | + this.numberOfShards = numberOfShards; |
| 140 | + this.nowInMillis = nowInMillis; |
| 141 | + this.clusterAlias = clusterAlias; |
| 142 | + this.waitForCheckpointsTimeout = searchRequest.getWaitForCheckpointsTimeout(); |
| 143 | + indices = shards.stream().map(Shard::getOriginalIndices).flatMap(Arrays::stream).distinct() |
| 144 | + .toArray(String[]::new); |
| 145 | + } |
| 146 | + |
| 147 | + public CanMatchNodeRequest(StreamInput in) throws IOException { |
| 148 | + super(in); |
| 149 | + source = in.readOptionalWriteable(SearchSourceBuilder::new); |
| 150 | + indicesOptions = IndicesOptions.readIndicesOptions(in); |
| 151 | + searchType = SearchType.fromId(in.readByte()); |
| 152 | + scroll = in.readOptionalWriteable(Scroll::new); |
| 153 | + requestCache = in.readOptionalBoolean(); |
| 154 | + allowPartialSearchResults = in.readBoolean(); |
| 155 | + numberOfShards = in.readVInt(); |
| 156 | + nowInMillis = in.readVLong(); |
| 157 | + clusterAlias = in.readOptionalString(); |
| 158 | + waitForCheckpointsTimeout = in.readTimeValue(); |
| 159 | + shards = in.readList(Shard::new); |
| 160 | + indices = shards.stream().map(Shard::getOriginalIndices).flatMap(Arrays::stream).distinct() |
| 161 | + .toArray(String[]::new); |
| 162 | + } |
| 163 | + |
| 164 | + @Override |
| 165 | + public void writeTo(StreamOutput out) throws IOException { |
| 166 | + super.writeTo(out); |
| 167 | + out.writeOptionalWriteable(source); |
| 168 | + indicesOptions.writeIndicesOptions(out); |
| 169 | + out.writeByte(searchType.id()); |
| 170 | + out.writeOptionalWriteable(scroll); |
| 171 | + out.writeOptionalBoolean(requestCache); |
| 172 | + out.writeBoolean(allowPartialSearchResults); |
| 173 | + out.writeVInt(numberOfShards); |
| 174 | + out.writeVLong(nowInMillis); |
| 175 | + out.writeOptionalString(clusterAlias); |
| 176 | + out.writeTimeValue(waitForCheckpointsTimeout); |
| 177 | + out.writeList(shards); |
| 178 | + } |
| 179 | + |
| 180 | + public List<Shard> getShardLevelRequests() { |
| 181 | + return shards; |
| 182 | + } |
| 183 | + |
| 184 | + public List<ShardSearchRequest> createShardSearchRequests() { |
| 185 | + return shards.stream().map(this::createShardSearchRequest).collect(Collectors.toList()); |
| 186 | + } |
| 187 | + |
| 188 | + public ShardSearchRequest createShardSearchRequest(Shard r) { |
| 189 | + ShardSearchRequest shardSearchRequest = new ShardSearchRequest( |
| 190 | + new OriginalIndices(r.indices, indicesOptions), r.shardId, r.shardRequestIndex, numberOfShards, searchType, |
| 191 | + source, requestCache, r.aliasFilter, r.indexBoost, allowPartialSearchResults, scroll, |
| 192 | + nowInMillis, clusterAlias, r.readerId, r.keepAlive, r.waitForCheckpoint, waitForCheckpointsTimeout |
| 193 | + ); |
| 194 | + shardSearchRequest.setParentTask(getParentTask()); |
| 195 | + return shardSearchRequest; |
| 196 | + } |
| 197 | + |
| 198 | + @Override |
| 199 | + public String[] indices() { |
| 200 | + return indices; |
| 201 | + } |
| 202 | + |
| 203 | + @Override |
| 204 | + public IndicesOptions indicesOptions() { |
| 205 | + return indicesOptions; |
| 206 | + } |
| 207 | + |
| 208 | + @Override |
| 209 | + public Task createTask(long id, String type, String action, TaskId parentTaskId, Map<String, String> headers) { |
| 210 | + return new SearchShardTask(id, type, action, getDescription(), parentTaskId, headers); |
| 211 | + } |
| 212 | + |
| 213 | + @Override |
| 214 | + public String getDescription() { |
| 215 | + // Shard id is enough here, the request itself can be found by looking at the parent task description |
| 216 | + return "shardIds[" + shards.stream().map(slr -> slr.shardId).collect(Collectors.toList()) + "]"; |
| 217 | + } |
| 218 | + |
| 219 | +} |
0 commit comments