Class TransactionConfig

couchbase/options.py:1728–1798

class TransactionConfig:
    _TXN_ALLOWED_KEYS = {"durability", "cleanup_window", "timeout",
                         "expiration_time", "cleanup_lost_attempts", "cleanup_client_attempts",
                         "metadata_collection", "scan_consistency"}

    @overload
    def __init__(self,
                 durability=None,   # type: Optional[ServerDurability]
                 cleanup_window=None,  # type: Optional[timedelta]
                 kv_timeout=None,  # type: Optional[timedelta]
                 expiration_time=None,  # type: Optional[timedelta]
                 cleanup_lost_attempts=None,  # type: Optional[bool]
                 cleanup_client_attempts=None,  # type: Optional[bool]
                 metadata_collection=None,  # type: Optional[TransactionKeyspace]
                 scan_consistency=None  # type: Optional[QueryScanConsistency]
                 ):
        """
        Configuration for Transactions.

        Args:
            durability (:class:`ServerDurability`, optional): Desired durability level for all transaction operations.
            cleanup_window (timedelta, optional): The query metadata is cleaned up over a the cleanup_window.
              Longer windows mean less background activity, shorter intervals will clean things faster.
            kv_timeout: (timedelta, optional): **DEPRECATED** Currently a no-op. KV operation timeout.
            expiration_time: (timedelta, optional): **DEPRECATED** Use timeout instead. Maximum amount of time a transaction can take before rolling back.
            cleanup_lost_attempts: (bool, optional): If False, then we don't do any background cleanup.
            cleanup_client_attempts: (bool, optional): if False, we don't do any cleanup as a transaction finishes.
            metadata_collection: (:class:`couchbase.transactions.TransactionKeyspace, optional): All transaction
              metadata uses the specified bucket/scope/collection.
            scan_consistency: (:class:`QueryScanConsistency`, optional): Scan consistency to use for all transactional
              queries.
            timeout: (timedelta, optional): Maximum amount of time a transaction can take before rolling back.
        """  # noqa: E501

    def __init__(self,   # noqa: C901
                 **kwargs  # type: dict[str, Any]
                 ):   # noqa: C901
        # CXXCBC-391: Adds support for ExtSDKIntegration which removes kv_timeout, the cluster kv_durable
        # timeout is used internally
        if 'kv_timeout' in kwargs:
            kwargs.pop('kv_timeout')
            Supportability.option_deprecated('kv_timeout')
        kwargs = {k: v for k, v in kwargs.items() if k in TransactionConfig._TXN_ALLOWED_KEYS}
        # convert everything here...
        durability = kwargs.pop("durability", None)
        if durability:
            kwargs["durability_level"] = durability.level.value
        if kwargs.get('cleanup_window', None):
            kwargs['cleanup_window'] = int(kwargs['cleanup_window'].total_seconds() * 1e6)
        coll = kwargs.pop("metadata_collection", None)
        # CXXCBC-391: Adds support for ExtSDKIntegration which changes expiration_time -> timeout
        if 'expiration_time' in kwargs or 'timeout' in kwargs:
            Supportability.option_deprecated('expiration_time', 'timeout')
            timeout = kwargs.pop('expiration_time', None)
            # if timeout is also in the options, override expiration_time
            if 'timeout' in kwargs:
                timeout = kwargs.get('timeout', None)
            if timeout: