Codecov Report

Merging #610 (5619e2c) into main (944b91b) will increase coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main     #610      +/-   ##
==========================================
+ Coverage   84.91%   84.92%   +0.01%     
==========================================
  Files         133      133              
  Lines        6715     6715              
==========================================
+ Hits         5702     5703       +1     
+ Misses       1013     1012       -1     

Flags with carried forward coverage won't be shown. Click here to find out more.

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@JoanFM The examples given are correct to the latest release of docarray.

However, the considerations are not necessary for all backends. Some persist even when not using the context manager. Though the correctness of these backends will be unaffected by following the suggestions.

If these are the intended considerations for using DocArrays backed by vector databases I think it's best to document it that way rather than go through all the nuance and minutiae of which implementations of which methods on which backend may or may not require context manager. Which we don't define and can't guarantee will be consistent in future releases.

Basically. By enforcing these considerations, we are telling users that if they perform any mutations, using context manager or scopes is guaranteed to have the expected behaviour of persistence.

Outside of this, we cannot guarantee anything. So users should probably not do any mutations outside of context manager or scope.

Thanks @NicholasDunham 👍🏻

Basically. By enforcing these considerations, we are telling users that if they perform any mutations, using context manager or scopes is guaranteed to have the expected behaviour of persistence.

Outside of this, we cannot guarantee anything. So users should probably not do any mutations outside of context manager or scope.

I agree with this philosophy for the reason than @Jackmin801, and also for a slightly different one: If we tell users to always use a context manager they will have a much easier time switching between storage backends.

Additionally I think we should come up with a soft guideline for backend developers, do we generally prefer eager or lazy persistence?

Merging the mirror of this branch in Jina repo is better. Closing this PR