mex.backend.merged package¶
Submodules¶
mex.backend.merged.helpers module¶
- mex.backend.merged.helpers.get_merged_item_from_graph(identifier: Identifier) MergedAccessPlatform | MergedActivity | MergedBibliographicResource | MergedConsent | MergedContactPoint | MergedDistribution | MergedOrganization | MergedOrganizationalUnit | MergedPerson | MergedPrimarySource | MergedResource | MergedVariable | MergedVariableGroup¶
Fetch and return the merged item for the given identifier.
- mex.backend.merged.helpers.merge_search_result_item(item: dict[str, Any], validation: Literal[Validation.LENIENT]) PreviewAccessPlatform | PreviewActivity | PreviewBibliographicResource | PreviewConsent | PreviewContactPoint | PreviewDistribution | PreviewOrganization | PreviewOrganizationalUnit | PreviewPerson | PreviewPrimarySource | PreviewResource | PreviewVariable | PreviewVariableGroup¶
- mex.backend.merged.helpers.merge_search_result_item(item: dict[str, Any], validation: Literal[Validation.STRICT]) MergedAccessPlatform | MergedActivity | MergedBibliographicResource | MergedConsent | MergedContactPoint | MergedDistribution | MergedOrganization | MergedOrganizationalUnit | MergedPerson | MergedPrimarySource | MergedResource | MergedVariable | MergedVariableGroup
- mex.backend.merged.helpers.merge_search_result_item(item: dict[str, Any], validation: Literal[Validation.IGNORE]) MergedAccessPlatform | MergedActivity | MergedBibliographicResource | MergedConsent | MergedContactPoint | MergedDistribution | MergedOrganization | MergedOrganizationalUnit | MergedPerson | MergedPrimarySource | MergedResource | MergedVariable | MergedVariableGroup | None
Merge a single search result into a merged item.
- Parameters:
item – Raw merged search result item from the graph response
validation – Merged items validate the existence of required fields and the lengths of lists by default, set this to LENIENT to avoid this and return a “preview” of a merged item instead of a valid merged item, or set this to IGNORE to return None in case of validation errors.
- Raises:
MergingError – When the given items cannot be merged
- Returns:
Instance of a merged or preview item
- mex.backend.merged.helpers.search_merged_items_in_graph(*, query_string: str | None = None, identifier: str | None = None, entity_type: list[str] | None = None, referenced_identifiers: list[str] | None = None, reference_field: str | None = None, skip: int = 0, limit: int = 100, validation: Literal[Validation.LENIENT] = Validation.LENIENT) PaginatedItemsContainer[PreviewAccessPlatform | PreviewActivity | PreviewBibliographicResource | PreviewConsent | PreviewContactPoint | PreviewDistribution | PreviewOrganization | PreviewOrganizationalUnit | PreviewPerson | PreviewPrimarySource | PreviewResource | PreviewVariable | PreviewVariableGroup]¶
- mex.backend.merged.helpers.search_merged_items_in_graph(*, query_string: str | None = None, identifier: str | None = None, entity_type: list[str] | None = None, referenced_identifiers: list[str] | None = None, reference_field: str | None = None, skip: int = 0, limit: int = 100, validation: Literal[Validation.STRICT] = Validation.STRICT) PaginatedItemsContainer[MergedAccessPlatform | MergedActivity | MergedBibliographicResource | MergedConsent | MergedContactPoint | MergedDistribution | MergedOrganization | MergedOrganizationalUnit | MergedPerson | MergedPrimarySource | MergedResource | MergedVariable | MergedVariableGroup]
- mex.backend.merged.helpers.search_merged_items_in_graph(*, query_string: str | None = None, identifier: str | None = None, entity_type: list[str] | None = None, referenced_identifiers: list[str] | None = None, reference_field: str | None = None, skip: int = 0, limit: int = 100, validation: Literal[Validation.IGNORE] = Validation.IGNORE) PaginatedItemsContainer[MergedAccessPlatform | MergedActivity | MergedBibliographicResource | MergedConsent | MergedContactPoint | MergedDistribution | MergedOrganization | MergedOrganizationalUnit | MergedPerson | MergedPrimarySource | MergedResource | MergedVariable | MergedVariableGroup]
Search for merged items.
- Parameters:
query_string – Full text search query term
identifier – Optional merged item identifier filter
entity_type – Optional entity type filter
referenced_identifiers – Optional merged item identifiers filter
reference_field – Optional field name to filter for
skip – How many items to skip for pagination
limit – How many items to return at most
validation – Merged items validate the existence of required fields and the lengths of lists by default, set this to LENIENT to avoid this and return a “preview” of a merged item instead of a valid merged item, or set this to IGNORE to return None in case of validation errors.
- Raises:
MergingError – When the given items cannot be merged
- Returns:
Search response for preview or merged items
mex.backend.merged.main module¶
- mex.backend.merged.main.get_merged_item(identifier: Identifier) MergedAccessPlatform | MergedActivity | MergedBibliographicResource | MergedConsent | MergedContactPoint | MergedDistribution | MergedOrganization | MergedOrganizationalUnit | MergedPerson | MergedPrimarySource | MergedResource | MergedVariable | MergedVariableGroup¶
Return one merged item for the given identifier.
- mex.backend.merged.main.search_merged_items(q: Annotated[str, Query(PydanticUndefined)] = '', identifier: Annotated[Identifier | None, Query(PydanticUndefined)] = None, entityType: Annotated[Sequence[MergedType], Query(PydanticUndefined)] = [], hadPrimarySource: Annotated[Sequence[Identifier] | None, Query(PydanticUndefined)] = None, referencedIdentifier: Annotated[Sequence[Identifier] | None, Query(PydanticUndefined)] = None, referenceField: Annotated[ReferenceFieldName | None, Query(PydanticUndefined)] = None, skip: Annotated[int, Query(PydanticUndefined)] = 0, limit: Annotated[int, Query(PydanticUndefined)] = 10) PaginatedItemsContainer[MergedAccessPlatform | MergedActivity | MergedBibliographicResource | MergedConsent | MergedContactPoint | MergedDistribution | MergedOrganization | MergedOrganizationalUnit | MergedPerson | MergedPrimarySource | MergedResource | MergedVariable | MergedVariableGroup]¶
Search for merged items by query text or by type and identifier.