org.apache.solr.common.params.CollectionParams Maven / Gradle / Ivy
/*
* 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.common.params;
import static java.util.stream.Collectors.toMap;
import java.util.Collections;
import java.util.Locale;
import java.util.Map;
import java.util.function.Function;
import java.util.stream.Stream;
public interface CollectionParams {
/** What action */
String ACTION = "action";
String NAME = "name";
/**
* @deprecated use {@link #SOURCE_NODE} instead
*/
@Deprecated String FROM_NODE = "fromNode";
String SOURCE_NODE = "sourceNode";
String TARGET_NODE = "targetNode";
String SOURCE_NODES = "sourceNodes";
String TARGET_NODES = "targetNodes";
String NODES = "nodes";
String MAX_BALANCE_SKEW = "maxBalanceSkew";
enum LockLevel {
NONE(10, null),
REPLICA(3, null),
SHARD(2, REPLICA),
COLLECTION(1, SHARD),
CLUSTER(0, COLLECTION);
private final int height;
private final LockLevel child;
LockLevel(int height, LockLevel child) {
this.height = height;
this.child = child;
}
public LockLevel getChild() {
return this.child;
}
public int getHeight() {
return this.height;
}
public boolean isHigherOrEqual(LockLevel that) {
return height >= that.height;
}
}
/**
* (Mostly) Collection API actions that can be sent by nodes to the Overseer over the
* /overseer/collection-queue-work ZooKeeper queue.
*
* Some of these actions are also used over the cluster state update queue at
* /overseer/queue and have a different (though related) meaning there. These actions are:
* {@link #CREATE}, {@link #DELETE}, {@link #CREATESHARD}, {@link #DELETESHARD}, {@link
* #ADDREPLICA}, {@link #ADDREPLICAPROP}, {@link #DELETEREPLICAPROP}, {@link #BALANCESHARDUNIQUE}
* and {@link #MODIFYCOLLECTION}.
*/
enum CollectionAction {
CREATE(true, LockLevel.COLLECTION),
DELETE(true, LockLevel.COLLECTION),
RELOAD(true, LockLevel.COLLECTION),
SYNCSHARD(true, LockLevel.SHARD),
CREATEALIAS(true, LockLevel.COLLECTION),
DELETEALIAS(true, LockLevel.COLLECTION),
ALIASPROP(true, LockLevel.COLLECTION),
LISTALIASES(false, LockLevel.NONE),
MAINTAINROUTEDALIAS(true, LockLevel.COLLECTION), // internal use only
DELETEROUTEDALIASCOLLECTIONS(true, LockLevel.COLLECTION),
SPLITSHARD(true, LockLevel.SHARD),
DELETESHARD(true, LockLevel.SHARD),
CREATESHARD(true, LockLevel.COLLECTION),
DELETEREPLICA(true, LockLevel.SHARD),
FORCELEADER(true, LockLevel.SHARD),
MIGRATE(true, LockLevel.COLLECTION),
ADDROLE(true, LockLevel.NONE),
REMOVEROLE(true, LockLevel.NONE),
CLUSTERPROP(true, LockLevel.NONE),
COLLECTIONPROP(true, LockLevel.COLLECTION),
REQUESTSTATUS(false, LockLevel.NONE),
DELETESTATUS(false, LockLevel.NONE),
ADDREPLICA(true, LockLevel.SHARD),
MOVEREPLICA(true, LockLevel.SHARD),
OVERSEERSTATUS(false, LockLevel.NONE),
// For testing. Could eventually be exposed publicly if needed
DISTRIBUTEDAPIPROCESSING(false, LockLevel.NONE),
LIST(false, LockLevel.NONE),
CLUSTERSTATUS(false, LockLevel.NONE),
ADDREPLICAPROP(true, LockLevel.REPLICA),
DELETEREPLICAPROP(true, LockLevel.REPLICA),
BALANCESHARDUNIQUE(true, LockLevel.COLLECTION),
REBALANCELEADERS(true, LockLevel.COLLECTION),
MODIFYCOLLECTION(true, LockLevel.COLLECTION),
BACKUP(true, LockLevel.COLLECTION),
RESTORE(true, LockLevel.COLLECTION),
INSTALLSHARDDATA(true, LockLevel.SHARD),
LISTBACKUP(false, LockLevel.NONE),
DELETEBACKUP(true, LockLevel.COLLECTION),
CREATESNAPSHOT(true, LockLevel.COLLECTION),
DELETESNAPSHOT(true, LockLevel.COLLECTION),
LISTSNAPSHOTS(false, LockLevel.NONE),
// only for testing. it just waits for specified time
// these are not exposed via collection API commands
// but the overseer is aware of these tasks
MOCK_COLL_TASK(false, LockLevel.COLLECTION),
MOCK_SHARD_TASK(false, LockLevel.SHARD),
// TODO when we have a node level lock use it here
REPLACENODE(true, LockLevel.NONE),
// TODO when we have a node level lock use it here
MIGRATE_REPLICAS(true, LockLevel.NONE),
// TODO when we have a node level lock use it here
BALANCE_REPLICAS(true, LockLevel.NONE),
DELETENODE(true, LockLevel.NONE),
MOCK_REPLICA_TASK(false, LockLevel.REPLICA),
NONE(false, LockLevel.NONE),
// TODO: not implemented yet
MERGESHARDS(true, LockLevel.SHARD),
COLSTATUS(true, LockLevel.NONE),
// this command implements its own locking
REINDEXCOLLECTION(true, LockLevel.NONE),
RENAME(true, LockLevel.COLLECTION);
public final boolean isWrite;
public final String lowerName;
public final LockLevel lockLevel;
CollectionAction(boolean isWrite, LockLevel level) {
this.isWrite = isWrite;
this.lockLevel = level;
lowerName = name().toLowerCase(Locale.ROOT);
}
public static CollectionAction get(String p) {
return actions.get(p == null ? null : p.toLowerCase(Locale.ROOT));
}
public boolean isEqual(String s) {
return s != null && lowerName.equals(s.toLowerCase(Locale.ROOT));
}
public String toLower() {
return lowerName;
}
}
Map actions =
Collections.unmodifiableMap(
Stream.of(CollectionAction.values())
.collect(toMap(CollectionAction::toLower, Function.identity())));
}