dace_query.target package

Submodules

dace_query.target.target module

dace_query.target.target.Target: TargetClass = <dace_query.target.target.TargetClass object>

Target instance

class dace_query.target.target.TargetClass(dace_instance: DaceClass | None = None)

Bases: object

The target class. Use to retrieve data from the target module.

A target instance is already provided, to use it :

>>> from dace_query.target import Target

query_database(limit: int | None = 10000, filters: dict | None = None, sort: dict | None = None, output_format: str | None = None) → dict[str, ndarray] | DataFrame | Table | dict

Query the target database to retrieve data in the chosen format.

Filters and sorting order can be applied to the query via named arguments (see Filtering and sorting).

All available formats are defined in this section (see Output formats).

Parameters:

• limit (Optional[int]) – Maximum number of rows to return

• filters (Optional[dict]) – Filters to apply to the query

• sort (Optional[dict]) – Sort order to apply to the query

• output_format (Optional[str]) – Type of data returns

Returns:

The desired data in the chosen output format

Return type:

dict[str, ndarray] or DataFrame or Table or dict

>>> from dace_query.target import Target
>>> values = Target.query_database()

Module contents