Method insert

acouchbase/collection.py:297–362

Inserts a new document to the collection, failing if the document already exists. Args: key (str): Document key to insert. value (JSONType): The value of the document to insert. opts (:class:`~couchbase.options.InsertOptions`): Optional parameters for thi

(self,
                     key,  # type: str
                     value,  # type: JSONType
                     *opts,  # type: InsertOptions
                     **kwargs,  # type: Any
                     )

            return await self._impl.exists(req, obs_handler)

    async def insert(self,
                     key,  # type: str
                     value,  # type: JSONType
                     *opts,  # type: InsertOptions
                     **kwargs,  # type: Any
                     ) -> MutationResult:
        """Inserts a new document to the collection, failing if the document already exists.

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

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

        Raises:
            :class:`~couchbase.exceptions.DocumentExistsException`: If the document already exists on the
                server.

        Examples:

            Simple insert operation::

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

                key = 'airline_8091'
                airline = {
                    "type": "airline",
                    "id": 8091,
                    "callsign": "CBS",
                    "iata": None,
                    "icao": None,
                    "name": "Couchbase Airways",
                }
                res = await collection.insert(key, doc)


            Simple insert operation with options::

                from couchbase.durability import DurabilityLevel, ServerDurability
                from couchbase.options import InsertOptions

                # ... other code ...

                key = 'airline_8091'
                airline = {
                    "type": "airline",
                    "id": 8091,
                    "callsign": "CBS",
                    "iata": None,
                    "icao": None,
                    "name": "Couchbase Airways",
                }