SQL Query Definition Excerpt

QueryDefinition Configuration

More information on configuring these values can be found in Creating a Query Definition for the SQL Connector

Property Name	Default Value	Data Type	Description
`Name`		String	The name of the query definition. This value will be used as part of the Data ID. Changing this value after analyses have been created will break those worksheets/topics.
`Type`		Enum SIGNAL CONDITION SCALAR	Defines whether this query will result in a set of Signals, Conditions, or Scalars.
`Sql`		String	The base SQL query that will be used for this query.
`Enabled`		Boolean	If true, the query is used to discover new data items. If false, no data will be indexed from this query.
EpochTimeUnit	null	SECONDS MILLISECONDS MICROSECONDS NANOSECONDS	The units of time used in epoch format time columns for this query. Leave this set to “null” for all other time formats.
`TestMode`		Boolean	If true, every discovered value will attempt to be queried for to determine if the query is valid. This should be set to false once the query has been identified to be working.
`Variables`		Array[Variable]	Allows for dynamic value replacements in a Query Configuration. See using variables in the SQL connector configuration.
`Properties`		Array[Property]	Specifies the properties that will be indexed as metadata for the data item.
`CapsuleProperties`		Array[CapsuleProperty]	Only valid when `Type` is `CONDITION`. The properties that should be associated with each capsule.
`TestQueriesDuringSync`	true	Boolean	When set to `true`, the queries used to retrieve samples/capsules will be tested when the signals/conditions are indexed. Any problems encountered are logged. This allows query problems to be discovered prior to trending the signal/condition. This should be set to false once the configuration is successful.
`InProgressCapsulesEnabled`	false	Boolean	Whether Capsules with a `NULL` end and starting within the interval from `Now - Max Duration` to `Now` should be considered in-progress. When this option is `true`, such Capsules have their end displayed as `Now` (i.e., the current time) and the interval mentioned is considered uncertain (since the real ends are still unknown). When this option is `false`, such Capsules are ignored.
`RecentCapsuleLookaheadSeconds`	0	Integer	The duration into the future, following the current time, within which the system searches for the latest capsule that has a non-null end time.

Property Configuration

Property Name	Data Type	Description
`Name`	String	The name of the property.
`Value`	String	The value of the property.
`Uom`	String	The unit of measure for the property value, or `string` for unitless property values.

CapsuleProperty Configuration

Property Name	Data Type	Description
`Name`	String	The name of the capsule property.
`Value`	String	The value of the capsule property.
`Column`	String	Optional: The column from the result set that the value should be taken.
`Uom`	String	The unit of measure for the capsule property value, or `string` for unitless property values.

Variable Configuration

Property Name	Data Type	Description
`Names`	Array[String]	A list of names that represent the individual variable names.
`Values`	Array[Array[String]]	A list of values that are associated with the names. There must be an equal number of values as there are names. Position is important between the `Name` and `Value` arrays.
`Sql`	String	Optional: The query that will produce the values for the variable names.