search_search_dictionaries_by_item_inverse

Given a data dictionary, identify candidate item columns that align and validate

Functions

async pydelfini.delfini_core.api.search.search_search_dictionaries_by_item_inverse.asyncio(*, client, body)[source]

Given a data dictionary, identify candidate item columns that align and validate

This performs a ‘reverse search’ for columns in the provided item that are likely to align with data elements in the provided source. The results are returned per data element, without pagination currently.

The current method uses the same approach as the ‘forward search’, performing full-text search queries using the column names against the data element definitions. These hits are then collated by data element and ranked to provide the most likely column hits for each data element.

Parameters:
Raises:

  • errors.UnexpectedStatus – If the server returns a status code greater than or equal to 300.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Union[SearchDictionariesByItemInverseResponse]

Return type:

SearchDictionariesByItemInverseResponse

async pydelfini.delfini_core.api.search.search_search_dictionaries_by_item_inverse.asyncio_detailed(*, client, body)[source]

Given a data dictionary, identify candidate item columns that align and validate

This performs a ‘reverse search’ for columns in the provided item that are likely to align with data elements in the provided source. The results are returned per data element, without pagination currently.

The current method uses the same approach as the ‘forward search’, performing full-text search queries using the column names against the data element definitions. These hits are then collated by data element and ranked to provide the most likely column hits for each data element.

Parameters:
Raises:

  • errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Response[Union[SearchDictionariesByItemInverseResponse, ServerError]]

Return type:

Response[SearchDictionariesByItemInverseResponse | ServerError]

pydelfini.delfini_core.api.search.search_search_dictionaries_by_item_inverse.sync(*, client, body)[source]

Given a data dictionary, identify candidate item columns that align and validate

This performs a ‘reverse search’ for columns in the provided item that are likely to align with data elements in the provided source. The results are returned per data element, without pagination currently.

The current method uses the same approach as the ‘forward search’, performing full-text search queries using the column names against the data element definitions. These hits are then collated by data element and ranked to provide the most likely column hits for each data element.

Parameters:
Raises:

  • errors.UnexpectedStatus – If the server returns a status code greater than or equal to 300.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Union[SearchDictionariesByItemInverseResponse]

Return type:

SearchDictionariesByItemInverseResponse

pydelfini.delfini_core.api.search.search_search_dictionaries_by_item_inverse.sync_detailed(*, client, body)[source]

Given a data dictionary, identify candidate item columns that align and validate

This performs a ‘reverse search’ for columns in the provided item that are likely to align with data elements in the provided source. The results are returned per data element, without pagination currently.

The current method uses the same approach as the ‘forward search’, performing full-text search queries using the column names against the data element definitions. These hits are then collated by data element and ranked to provide the most likely column hits for each data element.

Parameters:
Raises:

  • errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Response[Union[SearchDictionariesByItemInverseResponse, ServerError]]

Return type:

Response[SearchDictionariesByItemInverseResponse | ServerError]