3.1.1.4. datanator_query_python.query_schema_2 package¶
3.1.1.4.1. Submodules¶
3.1.1.4.2. datanator_query_python.query_schema_2.ftx_search module¶
-
class
datanator_query_python.query_schema_2.ftx_search.
FTX
[source]¶ Bases:
datanator_query_python.config.query_schema_2_manager.QM
-
search_taxon
(msg, skip=0, limit=10, token_order='any', db='datanator-test')[source]¶ Search for taxon names. (https://docs.atlas.mongodb.com/reference/atlas-search)
- Parameters
msg (
str
) – query message.skip (
int
, optional) – number of records to skip.limit (
int
, optional) – max number of documents to return.token_order (
str
, optional) – token order, i.e. sequential or any.db (
str
, optional) – name of database in which the result resides.
- Returns
MongDB CommandCursor after aggregation.
- Return type
(
CommandCursor
)
-
3.1.1.4.3. datanator_query_python.query_schema_2.query_entity module¶
-
class
datanator_query_python.query_schema_2.query_entity.
QueryEn
(db='datanator-demo')[source]¶ Bases:
datanator_query_python.config.query_schema_2_manager.QM
-
query_entity
(identifier, datatype='metabolite', collection='entity', limit=10, skip=0, projection={'_id': 0})[source]¶ Get entity with identifier.
- Parameters
identifier (
Obj
) – identifier used for the entity.datatype (
Obj
, optional) – Datatype to be retrieved.collection (
str
) – name of the collection in which data resides.limit (
int
, optional) – number of results to return.skip (
int
, optional) – number of documents to skip.projection (
Obj
, optional) – MongoDB projection.
- Returns
pymongo iterables.
- Return type
(
list
)
-
3.1.1.4.4. datanator_query_python.query_schema_2.query_observation module¶
-
class
datanator_query_python.query_schema_2.query_observation.
QueryObs
(db='datanator-demo')[source]¶ Bases:
datanator_query_python.config.query_schema_2_manager.QM
-
get_entity_datatype
(identifier, entity='protein', datatype='half-life', collection='observation', limit=10, skip=0, projection={'_id': 0})[source]¶ Get entity datatype.
- Parameters
identifier (
Obj
) – identifier used for the entity.entity (
Obj
, optional) – entity type. i.e. “protein”, “RNA”, etc.datatype (
Obj
, optional) – Datatype to be retrieved.collection (
str
, optional) – name of collection in which values reside.limit (
int
, optional) – number of results to return.skip (
int
, optional) – number of documents to skip.
- Returns
pymongo iterables.
- Return type
(
list
)
-