query

Service.query(query_type: str = 'Item', filter: str | None = '', item_filter: str | None = '') → list

Query the database.

Parameters:

query_typestr, optional

Type of objects to query. The default is "Item". Options are "Item", "Session", and "Dataset".

filterstr, optional

DEPRECATED. Use item_filter instead. Query string for filtering. The default is "". The syntax corresponds to the syntax for Ansys Dynamic Reporting. For more information, see _Query in the documentation for Ansys Dynamic Reporting.

item_filterstr, optional

Query string for filtering. The default is "". The syntax corresponds to the syntax for Ansys Dynamic Reporting. For more information, see _Query in the documentation for Ansys Dynamic Reporting.

Returns:

list

List of queried objects.

Examples

import ansys.dynamicreporting.core as adr
adr_service = adr.Service(ansys_installation = r'C:\Program Files\ANSYS Inc\v232')
ret = adr_service.connect()
imgs = adr_service.query(query_type='Item', item_filter='A|i_type|cont|image;')