Query
QueryInterface
Bases: ABC
Abstract interface for querying the Monarch KG in a SQL way
query
abstractmethod
Parameters:
Name | Type | Description | Default |
---|---|---|---|
q |
str
|
Query string to match against |
required |
category |
str
|
Limit results to only this category |
required |
taxon |
str
|
Limit results to only this taxon |
required |
offset |
int
|
Offset of the first result to return, defaults to 0 |
required |
limit |
int
|
Limit the number of results to return, defaults to 20 |
required |
Raises:
Type | Description |
---|---|
NotImplementedError
|
Use a specific implementation (see the documentation for a list of implementations) |
Returns:
Name | Type | Description |
---|---|---|
EntityResults |
EntityResults
|
Dataclass representing results of a generic entity search. |