Method lookup_in

acouchbase/collection.py:751–812

Performs a lookup-in operation against a document, fetching individual fields or information about specific fields inside the document value. Args: key (str): The key for the document look in. spec (Iterable[:class:`~couchbase.subdocument.Spec`]): A list of

(self,
                        key,  # type: str
                        spec,  # type: Iterable[Spec]
                        *opts,  # type: LookupInOptions
                        **kwargs,  # type: Any
                        )

            await self._impl.unlock(req, obs_handler)

    async def lookup_in(self,
                        key,  # type: str
                        spec,  # type: Iterable[Spec]
                        *opts,  # type: LookupInOptions
                        **kwargs,  # type: Any
                        ) -> LookupInResult:
        """Performs a lookup-in operation against a document, fetching individual fields or information
        about specific fields inside the document value.

        Args:
            key (str): The key for the document look in.
            spec (Iterable[:class:`~couchbase.subdocument.Spec`]):  A list of specs describing the data to fetch
                from the document.
            opts (:class:`~couchbase.options.LookupInOptions`): Optional parameters for this operation.
            **kwargs (Dict[str, Any]): keyword arguments that can be used in place or to
                override provided :class:`~couchbase.options.LookupInOptions`

        Returns:
            Awaitable[:class:`~couchbase.result.LookupInResult`]: A future that contains an instance
            of :class:`~couchbase.result.LookupInResult` if successful.

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

        Examples:

            Simple look-up in operation::

                import couchbase.subdocument as SD

                # ... other code ...

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

                key = 'hotel_10025'
                res = await collection.lookup_in(key, (SD.get("geo"),))
                print(f'Hotel {key} coordinates: {res.content_as[dict](0)}')


            Simple look-up in operation with options::

                from datetime import timedelta

                import couchbase.subdocument as SD
                from couchbase.options import LookupInOptions

                # ... other code ...

                key = 'hotel_10025'
                res = await collection.lookup_in(key,
                                            (SD.get("geo"),),
                                            LookupInOptions(timeout=timedelta(seconds=2)))
                print(f'Hotel {key} coordinates: {res.content_as[dict](0)}')

        """
        instruments = self._impl.observability_instruments