Skip to main content
Version: 3.0.0

Event SQL Filter

An event filter that filters based on an SQL query expression.

EventSqlFilter​

info

EventSqlFilter is defined beneath the following ancestor nodes in the YAML structure:

Below are the properties for the EventSqlFilter. Each property links to the specific details section further down in this page.

PropertyDefaultTypeRequiredDescription
typesarray[string]YesList of event types.
sql_filterstringYesSQL query expression used to filter events from the event stream.

Property Details​

Automation​

An automation defines a set of actions to be performed when defined sensor or event triggers occur.

PropertyDefaultTypeRequiredDescription
automationAutomationOptionsYesConfiguration options for the automation.

AutomationOptions​

Configuration options for an automation.

PropertyDefaultTypeRequiredDescription
descriptionstring
NoA brief description of what the model does.
metadataResourceMetadata
NoMeta information of a resource. In most cases it doesn't affect the system behavior but may be helpful to analyze project resources.
namestringYesThe name of the model
enabledboolean
NoA boolean flag indicating whether the automation is enabled (or not). Defaults to True.
actionsarray[Any of: (ActionOptions, string)]
NoList of actions that the automation performs when triggered.
triggersEventTrigger
NoList of automation triggers.

EventTrigger​

A pre-defined set of conditions within an automation that activates in response to specific events. When a trigger is fired, it initiates the execution of corresponding actions for that automation.

PropertyDefaultTypeRequiredDescription
eventsarray[One of: (EventSqlFilter, EventPythonFilter, EventTypeFilter)]
NoList of event filters used to identify events that trigger the automation.
sensorsarray[Any of: (SensorOptions, string)]
NoList of sensors that trigger the automation.