swh.search.api.client module¶

class swh.search.api.client.RemoteSearch(url, api_exception=None, timeout=None, chunk_size=4096, reraise_exceptions=None, **kwargs)[source]¶

Bases: swh.core.api.RPCClient

Proxy to a remote search API

backend_class¶: alias of swh.search.elasticsearch.ElasticSearch

check()¶

flush() → None¶: Blocks until all previous calls to _update() are completely applied.

origin_search(*, url_pattern: str = None, metadata_pattern: str = None, with_visit: bool = False, page_token: str = None, count: int = 50) → Dict[str, object]¶

Searches for origins matching the url_pattern.

Parameters

url_pattern (str) – Part of thr URL to search for
with_visit (bool) – Whether origins with no visit are to be filtered out
page_token (str) – Opaque value used for pagination.
count (int) – number of results to return.

Returns

next_page_token: opaque value used for fetching more results. None if there are no more result.
results: list of dictionaries with key: * url: URL of a matching origin

Return type

a dictionary with keys

origin_update(documents: Iterable[dict]) → None¶