msticpy.data.core.query_source module
Intake kql driver.
- class msticpy.data.core.query_source.QuerySource(name: str, source: Dict[str, Any], defaults: Dict[str, Any], metadata: Dict[str, Any])
Bases:
object
Query definition class for templated queries.
- query_store
The query store object that the query belongs to
- Type
Initialize query source definition.
- Parameters
Notes
A data source can belong to multiple families (e.g. a query that joins data from several sources)
- create_doc_string() str
Return a doc string for the query.
- Returns
New-line delimited docstring dynamically created from query definition properties.
- Return type
- create_query(formatters: Optional[Dict[str, Callable]] = None, **kwargs) str
Return query with values from kwargs and defaults substituted.
- Parameters
- Returns
The populated query
- Return type
- Raises
ValueError – If one or more parameters with no default values are not supplied.
Notes
Parameters supplied as arguments will override any parameter defaults (see default_params property).
- property data_families: List[str]
Return the list of data families used by the query.
- Returns
The list of data families. A data family is usually equivalent to a table or entity set.
- Return type
List[str]
- property default_params: Dict[str, dict]
Return the set of parameters with default values.
- Returns
List of parameters
- Return type
Iterable[dict]
- help()
Print help for query.
- property required_params: Dict[str, dict]
Return the set of parameters with no default values.
- Returns
List of parameters
- Return type
Iterable[dict]