akka.cluster.sharding

Class RemoveInternalClusterShardingData$

java.lang.Object

akka.cluster.sharding.RemoveInternalClusterShardingData$

public class RemoveInternalClusterShardingData$
extends java.lang.Object

Utility program that removes the internal data stored with Akka Persistence by the Cluster Sharding coordinator. The data contains the locations of the shards using Akka Persistence and it can safely be removed when restarting the whole Akka Cluster. Note that this is not application data.

Never use this program while there are running Akka Cluster that is using Cluster Sharding. Stop all Cluster nodes before using this program.

It can be needed to remove the data if the Cluster Sharding coordinator cannot startup because of corrupt data, which may happen if accidentally two clusters were running at the same time, e.g. caused by using auto-down and there was a network partition.

Use this program as a standalone Java main program:

 java -classpath <jar files, including akka-cluster-sharding>
   akka.cluster.sharding.RemoveInternalClusterShardingData
     -2.3 entityType1 entityType2 entityType3
 

The program is included in the akka-cluster-sharding jar file. It is easiest to run it with same classpath and configuration as your ordinary application. It can be run from sbt or maven in similar way.

Specify the entity type names (same as you use in the start method of ClusterSharding) as program arguments.

If you specify -2.3 as the first program argument it will also try to remove data that was stored by Cluster Sharding in Akka 2.3.x using different persistenceId.

Field Summary

Fields

Modifier and Type	Field and Description
static RemoveInternalClusterShardingData$	MODULE$ Static reference to the singleton instance of this Scala object.

Constructor Summary

Constructors

Constructor and Description
RemoveInternalClusterShardingData$()

Method Summary

Modifier and Type	Method and Description
void	main(java.lang.String[] args)
Props	props(java.lang.String journalPluginId, scala.collection.immutable.Set<java.lang.String> typeNames, scala.concurrent.Promise<scala.runtime.BoxedUnit> completion, boolean remove2dot3Data) INTERNAL API: Props for RemoveInternalClusterShardingData actor.
scala.concurrent.Future<scala.runtime.BoxedUnit>	remove(ActorSystem system, java.lang.String journalPluginId, scala.collection.immutable.Set<java.lang.String> typeNames, boolean terminateSystem, boolean remove2dot3Data) API corresponding to the main(java.lang.String[]) method as described in the RemoveInternalClusterShardingData companion object

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MODULE$

public static final RemoveInternalClusterShardingData$ MODULE$

Static reference to the singleton instance of this Scala object.

Constructor Detail

RemoveInternalClusterShardingData$

public RemoveInternalClusterShardingData$()

Method Detail

main

public void main(java.lang.String[] args)

Parameters:

args - (undocumented)

See Also:

RemoveInternalClusterShardingData companion object

remove

public scala.concurrent.Future<scala.runtime.BoxedUnit> remove(ActorSystem system,
                                                               java.lang.String journalPluginId,
                                                               scala.collection.immutable.Set<java.lang.String> typeNames,
                                                               boolean terminateSystem,
                                                               boolean remove2dot3Data)

API corresponding to the main(java.lang.String[]) method as described in the RemoveInternalClusterShardingData companion object

Parameters:

system - (undocumented)

journalPluginId - (undocumented)

typeNames - (undocumented)

terminateSystem - (undocumented)

remove2dot3Data - (undocumented)

Returns:

(undocumented)

props

public Props props(java.lang.String journalPluginId,
                   scala.collection.immutable.Set<java.lang.String> typeNames,
                   scala.concurrent.Promise<scala.runtime.BoxedUnit> completion,
                   boolean remove2dot3Data)

INTERNAL API: Props for RemoveInternalClusterShardingData actor.

Parameters:

journalPluginId - (undocumented)

typeNames - (undocumented)

completion - (undocumented)

remove2dot3Data - (undocumented)

Returns:

(undocumented)