Improve documentation and configuration API when using together: sharding and distibuted data (#20215)
* Missing setter for stateStoreMode in ClusterShardingSettings * Improve Sharding documentation regarding Distributed Data Storage
This commit is contained in:
parent
2418e610ab
commit
e4127c3af6
3 changed files with 11 additions and 0 deletions
|
|
@ -129,6 +129,9 @@ final class ClusterShardingSettings(
|
||||||
def withTuningParameters(tuningParameters: ClusterShardingSettings.TuningParameters): ClusterShardingSettings =
|
def withTuningParameters(tuningParameters: ClusterShardingSettings.TuningParameters): ClusterShardingSettings =
|
||||||
copy(tuningParameters = tuningParameters)
|
copy(tuningParameters = tuningParameters)
|
||||||
|
|
||||||
|
def withStateStoreMode(stateStoreMode: String): ClusterShardingSettings =
|
||||||
|
copy(stateStoreMode = stateStoreMode)
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The `role` of the `ClusterSingletonManagerSettings` is not used. The `role` of the
|
* The `role` of the `ClusterSingletonManagerSettings` is not used. The `role` of the
|
||||||
* coordinator singleton will be the same as the `role` of `ClusterShardingSettings`.
|
* coordinator singleton will be the same as the `role` of `ClusterShardingSettings`.
|
||||||
|
|
|
||||||
|
|
@ -200,6 +200,10 @@ on all nodes::
|
||||||
You must explicitly add the ``akka-distributed-data-experimental`` dependency to your build if
|
You must explicitly add the ``akka-distributed-data-experimental`` dependency to your build if
|
||||||
you use this mode. It is possible to remove ``akka-persistence`` dependency from a project if it
|
you use this mode. It is possible to remove ``akka-persistence`` dependency from a project if it
|
||||||
is not used in user code and ``remember-entities`` is ``off``.
|
is not used in user code and ``remember-entities`` is ``off``.
|
||||||
|
Using it together with ``Remember Entities`` shards will be recreated after rebalancing, however will
|
||||||
|
not be recreated after a clean cluster start as the Sharding Coordinator state is empty after a clean cluster
|
||||||
|
start when using ddata mode. When ``Remember Entities`` is ``on`` Sharding Region always keeps data usig persistence,
|
||||||
|
no matter how ``State Store Mode`` is set.
|
||||||
|
|
||||||
.. warning::
|
.. warning::
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -203,6 +203,10 @@ on all nodes::
|
||||||
You must explicitly add the ``akka-distributed-data-experimental`` dependency to your build if
|
You must explicitly add the ``akka-distributed-data-experimental`` dependency to your build if
|
||||||
you use this mode. It is possible to remove ``akka-persistence`` dependency from a project if it
|
you use this mode. It is possible to remove ``akka-persistence`` dependency from a project if it
|
||||||
is not used in user code and ``remember-entities`` is ``off``.
|
is not used in user code and ``remember-entities`` is ``off``.
|
||||||
|
Using it together with ``Remember Entities`` shards will be recreated after rebalancing, however will
|
||||||
|
not be recreated after a clean cluster start as the Sharding Coordinator state is empty after a clean cluster
|
||||||
|
start when using ddata mode. When ``Remember Entities`` is ``on`` Sharding Region always keeps data usig persistence,
|
||||||
|
no matter how ``State Store Mode`` is set.
|
||||||
|
|
||||||
.. warning::
|
.. warning::
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue