"A model builder plugin to reference relations"
Project description
Relations plugin for model builder
Relation data type
The relation data type marks part of the metadata that will be filled with a related object.
Example usage - part of dataset model:
primary-article:
type: relation
name: article
model: article
keys: ['metadata.title', 'metadata.authors']
The element "primary-article" will be connected to the article record. The record class and properties will be taken from the "article" model that is registered in "oarepo_models" entrypoint.
When returned to the user/serialized to ES, it will take the title and author fields from the related model and copy them into the primary-article field.
It will automatically generate the following schema:
will generate:
// schema
{
"primary-article": {
"type": "object",
"properties": {
"id": {"type": "string"},
"@v": {"type": "string"},
"title": {}, // copied from registered article model
"authors": {} // copied from registered article model
}
}
}
class Record:
# ...
relations = MultiRelationsField(
article=PIDRelation( # "name" from above
"...primary-article", # path inside the dataset model
"keys": ['metadata.title', 'metadata.authors'], # copied keys
pid_field: Article.pid # resolved model name and PID field
)
)
All arguments:
primary-article:
type: relation
name: ...
model: ...
keys: [...]
model-class:
relation-classes:
list: PIDListRelation
nested: PIDNestedListRelation
single: PIDRelation
relation-class:
relation-args:
attrs: []
keys: []
_value_key_suffix: id
_clear_empty: true
cache_key:
value_check:
pid_field: model-class.pid
imports:
- import: invenio_records_resources.records.system_fields.relations.PIDRelation
alias: PIDRelation
Field | Description |
---|---|
name | Relation name, will be used as param name inside RelationsField |
model | Name of the referenced model - from oarepo.models entrypoint or passed on commandline via --include parameter |
keys | Array of paths or dicts. If item is a path, that path will be copied from the referenced model. If it is dict it must contain the whole model definition. |
model-class | Class representing the related model |
relation-classes | If the field is not an array and not nested inside an array, "single" is used. If the field is an array "list" is used. If the field is inside an array field, "nested" is used |
relation-class | can be used to override relation-classes |
relation-args | A dictionary of arguments that will be passes to the relation class |
imports | You can define your own imports/aliases here. The defaults are thise for list, nested and single relation classes |
Internal relations
Sometimes it you might want to reference part of your document for indexing purposes etc. and not split the document into two records. For these, internal relations can be used:
properties:
metadata:
properties:
obj{}:
^id: anchor-obj
test: keyword
id: keyword
On object/array item, define the "id" field containing your "symbolic" name of the target of the relation. Then the definition of the relation will look like:
properties:
metadata:
properties:
internal-ref:
type: relation
model: "#anchor-obj"
keys: [id, test]
Supported relations
See referrer.yaml for a list of supported relations.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for oarepo-model-builder-relations-4.0.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cbedd3d239a529673866c259090b3cd8878c30dcbd4a3fa05c46c3db28694bc6 |
|
MD5 | 20e76354f1d7aa3a25cf1e8ba97e807f |
|
BLAKE2b-256 | d798a38abd35f1e98fae67a52fc5fc4102aabb76b1f8d180d8adab3f80e1ecc4 |
Hashes for oarepo_model_builder_relations-4.0.6-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 27b74e67f7871d406f9e5c0012bc3fcc718d03943dec762aa125ab5b26ea4a5b |
|
MD5 | a6c20fc3019ca92efd637ecd476acee4 |
|
BLAKE2b-256 | 10494e7178632abf791761936a74444c96ac8a2107f2135c6d43446b3d6a0514 |