quartzbio.global_search module

class quartzbio.global_search.GlobalSearch(query=None, filters=None, entities=None, entities_match='any', vault_scope='all', ordering=None, limit=inf, page_size=100, result_class=<class 'dict'>, debug=False, raw_results=False, **kwargs)

Bases: Query

GlobalSearch acts as a request wrapper that generates a request from Filter objects, and can iterate through streaming result sets.

entity(**kwargs)

Returns GlobalSearch instance with the query args combined with existing set with AND.

kwargs can contain only one entity, entity_type as parameter name and entity as its value. If entity is already set for the GlobalSearch, it will be overridden.

execute(offset=0, **query)

Executes a query. Additional query parameters can be passed as keyword arguments.

Returns: The request parameters and the raw query response.

subjects()

Returns the list of subjects

subjects_count()

Returns the number of subjects

vaults()

Returns the list of vaults