swh.search.interface module

class swh.search.interface.SearchInterface

Bases: object

check()

Dedicated method to execute some specific check per implementation.

flush() → None

Blocks until all previous calls to _update() are completely applied.

origin_update(documents: Iterable[Dict]) → None

Persist documents to the search backend.

origin_search(*, url_pattern: Optional[str] = None, metadata_pattern: Optional[str] = None, with_visit: bool = False, page_token: Optional[str] = None, limit: int = 50) → swh.core.api.classes.PagedResult[Dict[str, Any], str]

Searches for origins matching the url_pattern.

Parameters

• url_pattern – Part of the URL to search for

• with_visit – Whether origins with no visit are to be filtered out

• page_token – Opaque value used for pagination

• limit – number of results to return

Returns

PagedResult of origin dicts matching the search criteria. If next_page_token is None, there is no longer data to retrieve.