org.apache.solr.cloud.overseer.ClusterStateMutator Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of solr-core Show documentation
Show all versions of solr-core Show documentation
Apache Solr (module: core)
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF 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.apache.solr.cloud.overseer;
import static org.apache.solr.common.params.CommonParams.NAME;
import java.lang.invoke.MethodHandles;
import java.time.Instant;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import org.apache.solr.client.solrj.cloud.DistribStateManager;
import org.apache.solr.client.solrj.cloud.SolrCloudManager;
import org.apache.solr.cloud.api.collections.CollectionHandlingUtils;
import org.apache.solr.common.SolrException;
import org.apache.solr.common.cloud.ClusterState;
import org.apache.solr.common.cloud.DocCollection;
import org.apache.solr.common.cloud.DocCollection.CollectionStateProps;
import org.apache.solr.common.cloud.DocRouter;
import org.apache.solr.common.cloud.ImplicitDocRouter;
import org.apache.solr.common.cloud.Replica;
import org.apache.solr.common.cloud.Slice;
import org.apache.solr.common.cloud.Slice.SliceStateProps;
import org.apache.solr.common.cloud.ZkNodeProps;
import org.apache.solr.common.cloud.ZkStateReader;
import org.apache.solr.common.params.CollectionAdminParams;
import org.apache.solr.common.util.CollectionUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class ClusterStateMutator {
private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
protected final SolrCloudManager dataProvider;
protected final DistribStateManager stateManager;
public ClusterStateMutator(SolrCloudManager dataProvider) {
this.dataProvider = dataProvider;
this.stateManager = dataProvider.getDistribStateManager();
}
@SuppressWarnings({"unchecked"})
public ZkWriteCommand createCollection(ClusterState clusterState, ZkNodeProps message) {
String cName = message.getStr(NAME);
log.debug("building a new cName: {}", cName);
if (clusterState.hasCollection(cName)) {
log.warn("Collection {} already exists. exit", cName);
return ZkStateWriter.NO_OP;
}
Map routerSpec = DocRouter.getRouterSpec(message);
String routerName =
routerSpec.get(NAME) == null ? DocRouter.DEFAULT_NAME : (String) routerSpec.get(NAME);
DocRouter router = DocRouter.getDocRouter(routerName);
Object messageShardsObj = message.get("shards");
Map slices;
// we are being explicitly told the slice data (e.g. coll restore)
if (messageShardsObj instanceof Map) {
slices = Slice.loadAllFromMap(cName, (Map) messageShardsObj);
} else {
List shardNames = new ArrayList<>();
if (router instanceof ImplicitDocRouter) {
getShardNames(shardNames, message.getStr("shards", DocRouter.DEFAULT_NAME));
} else {
int numShards = message.getInt(ZkStateReader.NUM_SHARDS_PROP, -1);
if (numShards < 1)
throw new SolrException(
SolrException.ErrorCode.SERVER_ERROR,
"numShards is a required parameter for 'compositeId' router");
getShardNames(numShards, shardNames);
}
List ranges =
router.partitionRange(shardNames.size(), router.fullRange()); // maybe null
slices = new LinkedHashMap<>();
for (int i = 0; i < shardNames.size(); i++) {
String sliceName = shardNames.get(i);
Map sliceProps = CollectionUtil.newLinkedHashMap(1);
sliceProps.put(SliceStateProps.RANGE, ranges == null ? null : ranges.get(i));
slices.put(sliceName, new Slice(sliceName, null, sliceProps, cName));
}
}
Map collectionProps = new HashMap<>();
for (Map.Entry e :
CollectionHandlingUtils.COLLECTION_PROPS_AND_DEFAULTS.entrySet()) {
Object val = message.get(e.getKey());
if (val == null) {
val = CollectionHandlingUtils.COLLECTION_PROPS_AND_DEFAULTS.get(e.getKey());
}
if (val != null) collectionProps.put(e.getKey(), val);
}
collectionProps.put(CollectionStateProps.DOC_ROUTER, routerSpec);
if (message.getStr("fromApi") == null) {
collectionProps.put("autoCreated", "true");
}
// put configName in props so that it will appear in state.json
final String configName = (String) message.getProperties().get(CollectionAdminParams.COLL_CONF);
if (configName != null) {
collectionProps.put(ZkStateReader.CONFIGNAME_PROP, configName);
}
// add user-defined properties
for (String prop : message.keySet()) {
if (prop.startsWith(CollectionAdminParams.PROPERTY_PREFIX)) {
collectionProps.put(prop, message.get(prop));
}
}
assert !collectionProps.containsKey(CollectionAdminParams.COLL_CONF);
// This instance does not fully capture what will be persisted: the zkNodeVersion and
// creationTime will only be definitively set in ZK. Hence, the defaults passed here.
DocCollection newCollection =
DocCollection.create(
cName,
slices,
collectionProps,
router,
-1,
Instant.EPOCH,
stateManager.getPrsSupplier(cName));
return new ZkWriteCommand(cName, newCollection);
}
public ZkWriteCommand deleteCollection(ClusterState clusterState, ZkNodeProps message) {
final String collection = message.getStr(NAME);
if (!CollectionMutator.checkKeyExistence(message, NAME)) return ZkStateWriter.NO_OP;
DocCollection coll = clusterState.getCollectionOrNull(collection);
if (coll == null) return ZkStateWriter.NO_OP;
return new ZkWriteCommand(coll.getName(), null);
}
public static ClusterState newState(ClusterState state, String name, DocCollection collection) {
ClusterState newClusterState = null;
if (collection == null) {
newClusterState = state.copyWith(name, null);
} else {
newClusterState = state.copyWith(name, collection);
}
return newClusterState;
}
public static void getShardNames(Integer numShards, List shardNames) {
if (numShards == null)
throw new SolrException(
SolrException.ErrorCode.BAD_REQUEST, "numShards" + " is a required param");
for (int i = 0; i < numShards; i++) {
final String sliceName = "shard" + (i + 1);
shardNames.add(sliceName);
}
}
public static void getShardNames(List shardNames, String shards) {
if (shards == null)
throw new SolrException(
SolrException.ErrorCode.BAD_REQUEST, "shards" + " is a required param");
for (String s : shards.split(",")) {
if (s == null || s.trim().isEmpty()) continue;
shardNames.add(s.trim());
}
if (shardNames.isEmpty())
throw new SolrException(
SolrException.ErrorCode.BAD_REQUEST, "shards" + " is a required param");
}
/*
* Return an already assigned id or null if not assigned
*/
public static String getAssignedId(final DocCollection collection, final String nodeName) {
Collection slices = collection != null ? collection.getSlices() : null;
if (slices != null) {
for (Slice slice : slices) {
if (slice.getReplicasMap().get(nodeName) != null) {
return slice.getName();
}
}
}
return null;
}
public static String getAssignedCoreNodeName(
DocCollection collection, String forNodeName, String forCoreName) {
Collection slices = collection != null ? collection.getSlices() : null;
if (slices != null) {
for (Slice slice : slices) {
for (Replica replica : slice.getReplicas()) {
String nodeName = replica.getStr(ZkStateReader.NODE_NAME_PROP);
String core = replica.getStr(ZkStateReader.CORE_NAME_PROP);
if (nodeName.equals(forNodeName) && core.equals(forCoreName)) {
return replica.getName();
}
}
}
}
return null;
}
}