Class Cluster

couchbase/cluster.py:57–744

Create a Couchbase Cluster instance. The cluster instance exposes the operations which are available to be performed against a cluster. .. note:: Although creating an instance of :class:`.Cluster` is allowed, it is recommended to use the Cluster's static :meth:`.Cluster.con

class Cluster:
    """Create a Couchbase Cluster instance.

    The cluster instance exposes the operations which are available to be performed against a cluster.

    .. note::
        Although creating an instance of :class:`.Cluster` is allowed, it is recommended to
        use the Cluster's static :meth:`.Cluster.connect` method. See :meth:`.Cluster.connect` for connect
        for examples.

    Args:
        connstr (str):
            The connection string to use for connecting to the cluster.
            This is a URI-like string allowing specifying multiple hosts.

            The format of the connection string is the *scheme*
            (``couchbase`` for normal connections, ``couchbases`` for
            SSL enabled connections); a list of one or more *hostnames*
            delimited by commas
        options (:class:`~couchbase.options.ClusterOptions`): Global options to set for the cluster.
            Some operations allow the global options to be overriden by passing in options to the
            operation.
        **kwargs (Dict[str, Any]): keyword arguments that can be used in place or to
            overrride provided :class:`~couchbase.options.ClusterOptions`

    Raises:
        :class:`~couchbase.exceptions.InvalidArgumentException`: If no :class:`~couchbase.auth.Authenticator`
            is provided.  Also raised if an invalid `ClusterOption` is provided.
        :class:`~couchbase.exceptions.AuthenticationException`: If provided :class:`~couchbase.auth.Authenticator`
            has incorrect credentials.

    """

    def __init__(self,
                 connstr,  # type: str
                 *options,  # type: ClusterOptions
                 **kwargs,  # type: Dict[str, Any]
                 ) -> None:
        self._impl = ClusterImpl(connstr, *options, **kwargs)

    @property
    def transactions(self) -> Transactions:
        """
            :class:`~couchbase.transactions.Transactions`: A Transactions instance which can be used to
                perform transactions on this cluster.
        """
        return self._impl.transactions

    def close(self) -> None:
        """Shuts down this cluster instance. Cleaning up all resources associated with it.

        .. warning::
            Use of this method is almost *always* unnecessary.  Cluster resources should be cleaned
            up once the cluster instance falls out of scope.  However, in some applications tuning resources
            is necessary and in those types of applications, this method might be beneficial.

        """
        self._impl.close_connection()