msticpy.data.core.query_template module

MSTICPy query template definition.

class msticpy.data.core.query_template.Query(description, args=<factory>, metadata=<factory>, parameters=<factory>)

Bases: object

A Query definition.

Parameters:

  • description (str)

  • args (QueryArgs)

  • metadata (dict[str, Any] | None)

  • parameters (dict[str, QueryParameter] | None)

args: QueryArgs
description: str
metadata: dict[str, Any] | None
parameters: dict[str, QueryParameter] | None
class msticpy.data.core.query_template.QueryArgs(query='', uri=None)

Bases: object

Query arguments.

Parameters:

  • query (str)

  • uri (str | None)

query: str = ''
uri: str | None = None
class msticpy.data.core.query_template.QueryCollection(metadata, defaults=None, sources=<factory>, file_name=None)

Bases: object

Query Collection class - a query template.

Parameters:
defaults: QueryDefaults | None = None
file_name: str | None = None
metadata: QueryMetadata
sources: dict[str, Query]
class msticpy.data.core.query_template.QueryDefaults(metadata=None, parameters=<factory>)

Bases: object

Default values for query definitions.

Parameters:

  • metadata (dict[str, Any] | None)

  • parameters (dict[str, QueryParameter])

metadata: dict[str, Any] | None = None
parameters: dict[str, QueryParameter]
class msticpy.data.core.query_template.QueryMetadata(version, description, data_environments, data_families, database=None, cluster=None, clusters=None, cluster_groups=None, tags=<factory>, data_source=None, aliases=None, query_macros=None)

Bases: object

Metadata for query definitions.

Parameters:

  • version (int)

  • description (str)

  • data_environments (list[str])

  • data_families (list[str])

  • database (str | None)

  • cluster (str | None)

  • clusters (list[str] | None)

  • cluster_groups (list[str] | None)

  • tags (list[str])

  • data_source (str | None)

  • aliases (str | list[str] | None)

  • query_macros (dict[str, Any] | None)

aliases: str | list[str] | None = None
cluster: str | None = None
cluster_groups: list[str] | None = None
clusters: list[str] | None = None
data_environments: list[str]
data_families: list[str]
data_source: str | None = None
database: str | None = None
description: str
query_macros: dict[str, Any] | None = None
tags: list[str]
version: int
class msticpy.data.core.query_template.QueryParameter(description, datatype, default=None, aliases=None)

Bases: object

Query parameter.

Parameters:

  • description (str)

  • datatype (str)

  • default (Any)

  • aliases (list[str] | None)

aliases: list[str] | None = None
datatype: str
default: Any = None
description: str