ExperimentSession.append_plugin_data_query()#

ExperimentSession.append_plugin_data_query(query: dict)[source]#

Appends a query dictionary to the internal list of plugin data queries.

The query dictionary must have the following basic structure:

{
    "title": "Short title",
    "type": "data_type",
    "query": {
        "filter": {"field1": "val1"},
        ...
    }
}

The ‘filter’ subfield of ‘query’ contains the actual filter to be passed on to the database. You can also define a ‘projection’ subfield to control exactly which field will be returned by the query. If part of the data is saved in encrypted form, you should specify the field 'encrypted': True.

Raises

ValueError – If the input dictionary does not conform to the specifications.