Method map_remove

couchbase/collection.py:1519–1552

Remove an item from a map. .. warning:: This method is deprecated and will be removed in the 4.7.0 version. Use :meth:`.CouchbaseMap.remove` instead. Args: key (str): The key for the map document. mapkey (str): The key in the map to

(self, key: str, mapkey: str, **kwargs: object)

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

    def map_remove(self, key: str, mapkey: str, **kwargs: object) -> OperationResult:
        """Remove an item from a map.

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

        Args:
            key (str): The key for the map document.
            mapkey (str): The key in the map to set.
            **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.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:
                op = subdoc_remove(mapkey)
                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,
                                                          path_value=mapkey)
                return OperationResult(sd_res.cas, sd_res.mutation_token())

    def map_size(self, key: str, **kwargs: object) -> int:
        """Get the number of items in the map.