docs: add new upsert behavior information

msiemens · Jul 17, 2021 · b567d2a · b567d2a
1 parent 3b93b4b
commit b567d2a
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/docs/usage.rst b/docs/usage.rst
@@ -328,6 +328,11 @@ This will update all users with the name John to have ``logged-in`` set to ``Tru
 If no matching user is found, a new document is inserted with both the name set
 and the ``logged-in`` flag.
 
+To use the ID of the document as matching criterion a :class:`~tinydb.table.Document`
+with ``doc_id`` is passed instead of a query:
+
+>>> db.upsert(Document({'name': 'John', 'logged-in': True}, doc_id=12))
+
 Retrieving data
 ...............