Support data objects belong to a collection #396
Draft
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.
Solve #394. See issue for details.
Summary, this PR:
collection_name
argument toExportData
collection_name
is given, add it torelations.collections
in outgoing metadatarelations.collections
in schemaThis allows for multiple objects to be exported with a common tag defining a collection they all belong to. The purpose of this is for clients to quickly identify other data objects related to a data object. The produced
relations.collections
will beuuid4
and identical within a case.This is done by taking the provided
collections_name
argument and combining it with the currentfmu.case.uuid
.Use case: When looking at a volume table, identify if the same volumes are represented as a 3D parameter or a surface.
Clients would do this through the following workflow: Given a data object, if "relations.collections" is present, find other data objects with the same reference.
There are some unanswered questions:
relations.collections
is a list. But does this work in reality? E.g. if a data object has 3 entries inrelations.collections
- how will the consumer know which one he wants to unravel?fmu.case.uuid
does not exist when these data are made, hencerelations.collections
must probably be remade when dealing with preprocessed data.