Class ClusterOptions

couchbase/options.py:325–453

Available options to set when creating a cluster. .. warning:: Importing options from ``couchbase.cluster`` is deprecated. All options should be imported from ``couchbase.options``. Cluster options enable the configuration of various global cluster settings. Some option

class ClusterOptions(ClusterOptionsBase):
    """Available options to set when creating a cluster.

    .. warning::
        Importing options from ``couchbase.cluster`` is deprecated.
        All options should be imported from ``couchbase.options``.

    Cluster options enable the configuration of various global cluster settings.
    Some options can be set globally for the cluster, but overridden for specific
    operations (i.e. ClusterTimeoutOptions)

    .. note::

        The authenticator is mandatory, all the other cluster options are optional.

    Args:
        authenticator (Union[:class:`~.PasswordAuthenticator`, :class:`~.CertificateAuthenticator`]): An
            authenticator instance
        timeout_options (:class:`~.ClusterTimeoutOptions`): Timeout options for
            various SDK operations. See :class:`~.options.ClusterTimeoutOptions` for details.
        orphan_reporting_options (:class:`~.ClusterOrphanReportingOptions`): Options for SDK orphaned response reporting.
            See :class:`~.ClusterOrphanReportingOptions` for details.
        tracing_options (:class:`~.options.ClusterTimeoutOptions`): Tracing options for SDK tracing bevavior.
            See :class:`~.options.ClusterTracingOptions` for details.  These are ignored if an external tracer
            is specified.
        enable_tls (bool, optional): Set to True to enable tls. Defaults to False (disabled).
        enable_mutation_tokens (bool, optional): Set to False to disable mutation tokens in mutation results.
            Defaults to True (enabled).
        enable_tcp_keep_alive (bool, optional): Set to False to disable tcp keep alive. Defaults to True (enabled).
        ip_protocol (Union[str, :class:`.IpProtocol`): Set IP protocol. Defaults to IpProtocol.Any.
        enable_dns_srv (bool, optional): Set to False to disable DNS SRV. Defaults to True (enabled).
        show_queries (bool, optional): Set to True to enabled showing queries. Defaults to False (disabled).
        enable_unordered_execution (bool, optional): Set to False to disable unordered query execution.
            Defaults to True (enabled).
        enable_clustermap_notification (bool, optional): Set to False to disable cluster map notification.
            Defaults to True (enabled).
        enable_compression (bool, optional): Set to False to disable compression. Defaults to True (enabled).
        enable_tracing (bool, optional): Set to False to disable default threshold log tracing (enables no-op tracer).
            Defaults to True (enabled).
        enable_metrics (bool, optional): Set to False to disable default logging meter (enables no-op meter).
            Defaults to True (enabled).
        enable_orphan_reporting (bool, optional): Set to False to disable orphaned response reporting.
            Defaults to True (enabled).
        network (str, optional): Set network resolution method. Can be set to 'default' (if the client is running on the
            same network as the server) or 'external' (if the client is running on a different network). Defaults to
            'auto'.
        tls_verify (Union[str, :class:`.TLSVerifyMode`], optional): Set tls verify mode. Defaults to
            TLSVerifyMode.PEER.
        disable_mozilla_ca_certificates (bool, optional): Set to True to disable loading Mozilla's list of CA
            certificates for TLS verification. Defaults to False (enabled).
        serializer (:class:`~.serializer.Serializer`, optional): Global serializer to translate JSON to Python objects.
            Defaults to :class:`~.serializer.DefaultJsonSerializer`.
        transcoder (:class:`~.transcoder.Transcoder`, optional): Global transcoder to use for kv-operations.
            Defaults to :class:`~.transcoder.JsonTranscoder`.
        tcp_keep_alive_interval (timedelta, optional): TCP keep-alive interval. Defaults to None.
        config_poll_interval (timedelta, optional): Config polling floor interval.
            Defaults to None.
        config_poll_floor (timedelta, optional): Config polling floor interval.