Skip to content

tinydantic.tinydb.operations ¤

TinyDB update operations.

replace ¤

replace(new: Mapping) -> Callable[[MutableMapping], None]

Build a TinyDB update transform that replaces a document.

The returned callable clears the target document and repopulates it from new, so it fully replaces the stored contents rather than merging. Pass it to tinydb.table.Table.update (this is how TinydanticModel.replace overwrites a document).

Parameters:

Name Type Description Default
new Mapping

The mapping to replace the document's contents with.

 required

Returns:

Type Description
Callable[[MutableMapping], None]

A transform suitable for TinyDB's update operations.
Source code in src/tinydantic/tinydb/operations.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
def replace(new: Mapping) -> Callable[[MutableMapping], None]:
    """Build a TinyDB update transform that replaces a document.

    The returned callable clears the target document and repopulates it
    from ``new``, so it fully replaces the stored contents rather than
    merging. Pass it to [tinydb.table.Table.update][] (this is how
    [TinydanticModel.replace][tinydantic.TinydanticModel.replace]
    overwrites a document).

    Args:
        new: The mapping to replace the document's contents with.

    Returns:
        A transform suitable for TinyDB's update operations.
    """

    def transform(doc: MutableMapping) -> None:
        """Replace ``doc``'s contents with ``new`` in place."""
        doc.clear()
        doc.update(new)

    return transform