Method map_add

couchbase/collection.py:1438–1481

Set a value for a key in a map. .. warning:: This method is deprecated and will be removed in the 4.7.0 version. Use :meth:`.CouchbaseMap.add` instead. Args: key (str): The key for the map document. mapkey (str): The key in the map t

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

        return CouchbaseMap(key, self._impl)

    def map_add(self,
                key: str,
                mapkey: str,
                value: Any,
                create: Optional[bool] = False,
                **kwargs: object
                ) -> OperationResult:
        """Set a value for a key in a map.

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

        Args:
            key (str): The key for the map document.
            mapkey (str): The key in the map to set.
            value (Any): The value to use.
            create (bool, optional): Whether the map 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.MapAdd
        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_upsert(mapkey, value)
                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=dict,
                                                          path_value=mapkey)
                return OperationResult(sd_res.cas, sd_res.mutation_token())

    def map_get(self, key: str, mapkey: str, **kwargs: object) -> Any:
        """Retrieve a value from a map.