Method set_add

couchbase/collection.py:1600–1643

Add an item to a set if the item does not yet exist. .. warning:: This method is deprecated and will be removed in the 4.7.0 version. Use :meth:`.CouchbaseSet.add` instead. Args: key (str): The key for the set document. value (Any):

(self,
                key: str,
                value: Any,
                create: Optional[bool] = False,
                **kwargs: object
                )

        return CouchbaseSet(key, self._impl)

    def set_add(self,
                key: str,
                value: Any,
                create: Optional[bool] = False,
                **kwargs: object
                ) -> Optional[OperationResult]:
        """Add an item to a set if the item does not yet exist.

        .. warning::
            This method is deprecated and will be removed in the 4.7.0 version.  Use :meth:`.CouchbaseSet.add`
            instead.

        Args:
            key (str): The key for the set document.
            value (Any): The value to add to the set.
            create (bool, optional): Whether the set should be created if it does not exist.
            **kwargs (Dict[str, Any]): keyword arguments that can be used as optional parameters
                for this operation.

        Returns:
            :class:`~couchbase.result.OperationResult`: An instance of :class:`~couchbase.result.OperationResult`.

        Raises:
            :class:`~couchbase.exceptions.DocumentNotFoundException`: If the key provided does not exist
                on the server.
        """
        op_type = DatastructureOperationType.SetAdd
        with ObservableRequestHandler(op_type, self._impl.observability_instruments) as ds_obs_handler:
            ds_obs_handler.create_kv_span(self._impl._request_builder._collection_dtls.get_details_as_dict())
            kv_op_type = KeyValueOperationType.MutateIn
            with ObservableRequestHandler(kv_op_type, self._impl.observability_instruments) as obs_handler:
                op = array_addunique('', value)
                try:
                    req = self._impl.request_builder.build_mutate_in_request(key, (op,), obs_handler, **kwargs)
                    sd_res = self._execute_deprecated_ds_func(self._impl.mutate_in,
                                                              req,
                                                              obs_handler,
                                                              ds_obs_handler.wrapped_span,
                                                              create=create,
                                                              create_type=list,
                                                              path_value=value)
                    return OperationResult(sd_res.cas, sd_res.mutation_token())
                except PathExistsException:
                    pass

    def set_remove(self, key: str, value: Any, **kwargs: object) -> Optional[OperationResult]:
        """Remove an item from a set.