ORM: Add the Entity.get_collection classmethod
#6107
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thank you @sphuber ! I will do some test soon |
|
I feel that we are still missing many points where we use the global backend and not the instance backend, see for example sphuber#14 that makes it only for my use case that is the initialization of a ready-to use aiida database. |
sphuber
force-pushed
the
fix/6105/get-collection-specify-backend
branch
from
5bad5d8
to
3364209
Compare
|
Thanks @rikigigi . I have merged your PR. I have found some additional places as well and merged that with your commit. I have now thoroughly searched all the code in |
sphuber
force-pushed
the
fix/6105/get-collection-specify-backend
branch
2 times, most recently
from
bf49bc4
to
ebfd4d5
Compare
This is an alternative for the `collection` class property. Where the
`collection` property uses the current default storage backend, the
`get_collection` allows to specify another specific backend.
The original design intended to support this use-case by allowing a
`Collection` instance to be "called" with a specific backend:
Entity.collection(backend)
The `.collection` returns a `Collection` instance which is then called
with passing the `backend`, which would return a new `Collection` for
the same entity type, but with the other backend. However, this doesn't
always work, because the `collection` property will load the backend
from the default profile, which will except if not loaded. Although this
scenario is unlikely for normal usage, application developers may use
AiiDA's API with multiple active backends where no default profile is
defined.
The reason for a new method instead of changing the `collection`
property is that that would be backwards incompatible.
The classproperty will try to load the default storage backend first, before recreating the collection with the specified backend. Not only is this inefficient as the collection is recreated if the `backend` is not the current default one, but it can also fail in situations where there is no default profile is available and the caller wants to directly specify the backend.
Whenever an ORM entity instance instantiates another entry, it should explicitly pass its own backend as the storage backend to use. Similarly, functions that accept a storage backend as an argument, should consistently pass whenever instantiating a new entity or its collection. Co-Authored-By: Riccardo Bertossa <[email protected]>
sphuber
force-pushed
the
fix/6105/get-collection-specify-backend
branch
from
ebfd4d5
to
480ccd8
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #6105