Method remove

couchbase/collection.py:521–565

Removes an existing document. Failing if the document does not exist. Args: key (str): Key for the document to remove. opts (:class:`~couchbase.options.RemoveOptions`): Optional parameters for this operation. **kwargs (Dict[str, Any]): keyword arguments t

(self,
               key,  # type: str
               *opts,  # type: RemoveOptions
               **kwargs,  # type: Dict[str, Any]
               )

            return self._impl.replace(req, obs_handler)

    def remove(self,
               key,  # type: str
               *opts,  # type: RemoveOptions
               **kwargs,  # type: Dict[str, Any]
               ) -> MutationResult:
        """Removes an existing document. Failing if the document does not exist.

        Args:
            key (str): Key for the document to remove.
            opts (:class:`~couchbase.options.RemoveOptions`): Optional parameters for this operation.
            **kwargs (Dict[str, Any]): keyword arguments that can be used in place or to
                override provided :class:`~couchbase.options.RemoveOptions`

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

        Raises:
            :class:`~couchbase.exceptions.DocumentNotFoundException`: If the document does not exist on the
                server.

        Examples:

            Simple remove operation::

                bucket = cluster.bucket('travel-sample')
                collection = bucket.scope('inventory').collection('airline')

                res = collection.remove('airline_10')


            Simple remove operation with options::

                from couchbase.durability import DurabilityLevel, ServerDurability
                from couchbase.options import RemoveOptions

                # ... other code ...

                durability = ServerDurability(level=DurabilityLevel.MAJORITY)
                res = collection.remove('airline_10', RemoveOptions(durability=durability))

        """
        instruments = self._impl.observability_instruments
        with ObservableRequestHandler.create(KeyValueOperationType.Remove, instruments) as obs_handler:
            req = self._impl.request_builder.build_remove_request(key, obs_handler, *opts, **kwargs)
            return self._impl.remove(req, obs_handler)

    def touch(self,
              key,  # type: str