Method remove

couchbase/datastructures.py:484–507

Removes a specific key from the map. Args: mapkey (str): The key in the map to remove. Raises: :class:`~couchbase.exceptions.InvalidArgumentException`: If the key is not in the map.

(self, mapkey: str)

                return sd_res.value[0].get('value', None)

    def remove(self, mapkey: str) -> None:
        """Removes a specific key from the map.

        Args:
            mapkey (str): The key in the map to remove.

        Raises:
            :class:`~couchbase.exceptions.InvalidArgumentException`: If the key is not in the map.

        """
        op_type = DatastructureOperationType.MapRemove
        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:
                try:
                    op = remove(mapkey)
                    req = self._impl.request_builder.build_mutate_in_request(self._key,
                                                                             (op,),
                                                                             obs_handler,
                                                                             parent_span=ds_obs_handler.wrapped_span)
                    self._impl.mutate_in(req, obs_handler)
                except PathNotFoundException:
                    raise InvalidArgumentException(message=f'Key: {mapkey} is not in the map.') from None

    def size(self) -> int:
        """Returns the number of items in the map.