Function count

couchbase/subdocument.py:365–379

Creates a :class:`.Spec` that returns the number of elements in the array referenced by the path. Args: path (str): The path to the field. xattr (bool, optional): Whether this operation should reference the document body or the extended attributes data for the docume

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

def count(path,  # type: str
          xattr=False  # type: Optional[bool]
          ) -> Spec:
    """Creates a :class:`.Spec` that returns the number of elements in the array referenced by the path.

    Args:
        path (str): The path to the field.
        xattr (bool, optional): Whether this operation should reference the document body or the
            extended attributes data for the document.

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

    """
    return Spec(SubDocOp.GET_COUNT, path, xattr)


def insert(path,                     # type: str