Skip to content

Commit

Permalink
Update relations.md (#904)
Browse files Browse the repository at this point in the history
Update BackLink docs to include the fact that they are virtual.
  • Loading branch information
JBorrow committed Apr 16, 2024
1 parent 4378451 commit fc79936
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/tutorial/relations.md
Original file line number Diff line number Diff line change
Expand Up @@ -294,8 +294,8 @@ class Person(Document):

The `original_field` parameter is required for the back link field.

Back links support all the operations that normal links support.
Back links support all the operations that normal links support, but are virtual. This means that when searching the database, you will need to include `fetch_links=True` (see [Finding documents](find.md)), or you will recieve an empty 'BackLink' virtual object. It is not possible to `fetch()` this virtual link after the initial search.

## Limitations

- Find operations with the `fetch_links` parameter can not be used in the chaning with `delete` and `update` methods.
- Find operations with the `fetch_links` parameter can not be used in the chaning with `delete` and `update` methods.

0 comments on commit fc79936

Please sign in to comment.