academic_observatory_api.server.elastic

Module Contents

Functions

query_elasticsearch(agg: str, subagg: Optional[str]) → Union[dict, Tuple[str, int]]

param agg

get_pit_id(agg: str, subagg: Optional[str]) → Union[dict, Tuple[str, int]]

param agg
class academic_observatory_api.server.elastic.ElasticsearchIndex(es: elasticsearch.Elasticsearch, agg: str, subagg: Optional[str], index_date: Optional[str])[source]
property name(self) → str[source]
Returns

property agg_field(self) → str[source]
Returns

property subagg_field(self) → Optional[str][source]
Returns

property agg_mappings(self) → Dict[str, str][source]
Returns

property subagg_mappings(self) → Dict[str, str][source]
Returns

property invalid_combinations(self) → Dict[str, list][source]
Returns

set_alias(self) → [bool, str][source]
Returns

academic_observatory_api.server.elastic.query_elasticsearch(agg: str, subagg: Optional[str]) → Union[dict, Tuple[str, int]][source]
Parameters

  • agg –

  • subagg –

Returns

academic_observatory_api.server.elastic.get_pit_id(agg: str, subagg: Optional[str]) → Union[dict, Tuple[str, int]][source]
Parameters

  • agg –

  • subagg –

Returns