Function increment

couchbase/subdocument.py:624–653

Creates a :class:`.Spec` for incrementing the value of a field in a document. Args: path (str): The path to the field. delta (int): The value to increment from the document. xattr (bool, optional): Whether this operation should reference the document body or the

(path,                   # type: str
              delta,                  # type: int
              xattr=False,            # type: Optional[bool]
              create_parents=False    # type: Optional[bool]
              )

def increment(path,                   # type: str
              delta,                  # type: int
              xattr=False,            # type: Optional[bool]
              create_parents=False    # type: Optional[bool]
              ) -> Spec:
    """Creates a :class:`.Spec` for incrementing the value of a field in a document.

    Args:
        path (str): The path to the field.
        delta (int): The value to increment from the document.
        xattr (bool, optional): Whether this operation should reference the document body or the
            extended attributes data for the document.
        create_parents (bool, optional): Whether or not the path to the field should be created
            if it does not already exist.

    Returns:
        :class:`.Spec`: An instance of :class:`.Spec`.


    Raises:
        :class:`~couchbase.exceptions.InvalidArgumentException`: If the delta arugment is not >= 0 or not
            of type int.
    """
    if not isinstance(delta, int):
        raise InvalidArgumentException("Delta must be integer")
    if delta <= 0:
        raise InvalidArgumentException(
            "Delta must be integer greater than or equal to 0")

    return Spec(SubDocOp.COUNTER, path, create_parents, xattr, False, delta)


def decrement(path,                   # type: str