Method clear

couchbase/datastructures.py:331–348

Clears the list. Raises: :class:`~couchbase.exceptions.DocumentNotFoundException`: If the list does not already exist.

(self)

            return list_.content_as[list]

    def clear(self) -> None:
        """Clears the list.

        Raises:
            :class:`~couchbase.exceptions.DocumentNotFoundException`: If the list does not already exist.
        """
        op_type = DatastructureOperationType.ListClear
        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.Remove
            with ObservableRequestHandler(kv_op_type, self._impl.observability_instruments) as obs_handler:
                try:
                    req = self._impl.request_builder.build_remove_request(self._key,
                                                                          obs_handler,
                                                                          parent_span=ds_obs_handler.wrapped_span)
                    self._impl.remove(req, obs_handler)
                except DocumentNotFoundException:
                    pass

    def __iter__(self):
        list_ = self._get()