Function array_append

couchbase/subdocument.py:485–509

Creates a :class:`.Spec` for adding a value to the end of an array in a document. Args: path (str): The path to an element of an array. *values (Iterable[Any]): The values to add. create_parents (bool, optional): Whether or not the path to the field should be created

(path,              # type: str
                 *values,                 # type: Iterable[Any]
                 create_parents=False,     # type: Optional[bool]
                 xattr=False               # type: Optional[bool]
                 )

def array_append(path,              # type: str
                 *values,                 # type: Iterable[Any]
                 create_parents=False,     # type: Optional[bool]
                 xattr=False               # type: Optional[bool]
                 ) -> Spec:
    """Creates a :class:`.Spec` for adding a value to the end of an array in a document.

    Args:
        path (str): The path to an element of an array.
        *values (Iterable[Any]): The values to add.
        create_parents (bool, optional): Whether or not the path to the field should be created
            if it does not already exist.
        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`.

    """
    expand_macros = False
    if any(map(lambda m: isinstance(m, MutationMacro), values)):
        values = [v.value if isinstance(v, MutationMacro) else v for v in values]
        xattr = True
        expand_macros = True
    return Spec(SubDocOp.ARRAY_PUSH_LAST, path, create_parents, xattr, expand_macros, ArrayValues(*values))


def array_prepend(path,              # type: str