Method __init__

redis/cluster.py:700–969

Initialize a new RedisCluster client. :param startup_nodes: List of nodes from which initial bootstrapping can be done :param host: Can be used to point to a startup node :param port: Can be used to point to a startup node

(
        self,
        host: Optional[str] = None,
        port: int = 6379,
        startup_nodes: Optional[List["ClusterNode"]] = None,
        cluster_error_retry_attempts: int = DEFAULT_RETRY_COUNT,
        retry: Optional["Retry"] = None,
        require_full_coverage: bool = True,
        reinitialize_steps: int = 5,
        read_from_replicas: bool = False,
        load_balancing_strategy: Optional["LoadBalancingStrategy"] = None,
        dynamic_startup_nodes: bool = True,
        url: Optional[str] = None,
        address_remap: Optional[Callable[[Tuple[str, int]], Tuple[str, int]]] = None,
        cache: Optional[CacheInterface] = None,
        cache_config: Optional[CacheConfig] = None,
        event_dispatcher: Optional[EventDispatcher] = None,
        policy_resolver: PolicyResolver = StaticPolicyResolver(),
        maint_notifications_config: Optional[MaintNotificationsConfig] = None,
        **kwargs,
    )

        version="6.0.0",
    )
    def __init__(
        self,
        host: Optional[str] = None,
        port: int = 6379,
        startup_nodes: Optional[List["ClusterNode"]] = None,
        cluster_error_retry_attempts: int = DEFAULT_RETRY_COUNT,
        retry: Optional["Retry"] = None,
        require_full_coverage: bool = True,
        reinitialize_steps: int = 5,
        read_from_replicas: bool = False,
        load_balancing_strategy: Optional["LoadBalancingStrategy"] = None,
        dynamic_startup_nodes: bool = True,
        url: Optional[str] = None,
        address_remap: Optional[Callable[[Tuple[str, int]], Tuple[str, int]]] = None,
        cache: Optional[CacheInterface] = None,
        cache_config: Optional[CacheConfig] = None,
        event_dispatcher: Optional[EventDispatcher] = None,
        policy_resolver: PolicyResolver = StaticPolicyResolver(),
        maint_notifications_config: Optional[MaintNotificationsConfig] = None,
        **kwargs,
    ):
        """
        Initialize a new RedisCluster client.

        :param startup_nodes:
            List of nodes from which initial bootstrapping can be done
        :param host:
            Can be used to point to a startup node
        :param port:
            Can be used to point to a startup node
        :param require_full_coverage:
            When set to False (default value): the client will not require a
            full coverage of the slots. However, if not all slots are covered,
            and at least one node has 'cluster-require-full-coverage' set to
            'yes,' the server will throw a ClusterDownError for some key-based
            commands. See -
            https://redis.io/topics/cluster-tutorial#redis-cluster-configuration-parameters
            When set to True: all slots must be covered to construct the
            cluster client. If not all slots are covered, RedisClusterException
            will be thrown.
        :param read_from_replicas:
            @deprecated - please use load_balancing_strategy instead
            Enable read from replicas in READONLY mode. You can read possibly
            stale data.
            When set to true, read commands will be assigned between the
            primary and its replications in a Round-Robin manner.
        :param load_balancing_strategy:
            Enable read from replicas in READONLY mode and defines the load balancing
            strategy that will be used for cluster node selection.
            The data read from replicas is eventually consistent with the data in primary nodes.
        :param dynamic_startup_nodes:
            Set the RedisCluster's startup nodes to all of the discovered nodes.
            If true (default value), the cluster's discovered nodes will be used to
            determine the cluster nodes-slots mapping in the next topology refresh.
            It will remove the initial passed startup nodes if their endpoints aren't
            listed in the CLUSTER SLOTS output.
            If you use dynamic DNS endpoints for startup nodes but CLUSTER SLOTS lists
            specific IP addresses, it is best to set it to false.