Method get

couchbase/collection.py:121–166

Retrieves the value of a document from the collection. Args: key (str): The key for the document to retrieve. opts (:class:`~couchbase.options.GetOptions`): Optional parameters for this operation. **kwargs (Dict[str, Any]): keyword arguments that can be u

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

        return self._impl.name

    def get(self,
            key,  # type: str
            *opts,  # type: GetOptions
            **kwargs,  # type: Dict[str, Any]
            ) -> GetResult:
        """Retrieves the value of a document from the collection.

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

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

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

        Examples:

            Simple get operation::

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

                res = collection.get('airline_10')
                print(f'Document value: {res.content_as[dict]}')


            Simple get operation with options::

                from datetime import timedelta
                from couchbase.options import GetOptions

                # ... other code ...

                res = collection.get('airline_10', GetOptions(timeout=timedelta(seconds=2)))
                print(f'Document value: {res.content_as[dict]}')

        """
        instruments = self._impl.observability_instruments
        with ObservableRequestHandler.create(KeyValueOperationType.Get, instruments) as obs_handler:
            req, transcoder = self._impl.request_builder.build_get_request(key, obs_handler, *opts, **kwargs)
            return self._impl.get(req, transcoder, obs_handler)

    def get_any_replica(self,
                        key,  # type: str