ODBC Data Stream Parameters

The ODBC plugin provides configurable data streams to query SQL data.

Each configurable data stream exposes a set of parameters that lets you filter the data you retrieve. The following information describes the available configurable data streams and their parameters in detail.

Custom ODBC Metrics Query

Parameter	Description
Query	Enter a SQL query which returns metrics. For example, `SELECT label,timestamp,value FROM MyPerformanceTable WHERE myObjectId = {{sourceId}}` When writing a Metrics query, the below three columns are mandatory and all others will be ignored. `label`: The label for the value passed in, for example ‘Percent Utilization’. Each distinct ‘label’ value will get its own line color which includes only values for that label. `timestamp`: A DateTime value of when this reading occurred. `value`: A numerical non-null value to be visualized.

Parameter

Description

Query

Enter a SQL query which returns metrics. For example, SELECT label,timestamp,value FROM MyPerformanceTable WHERE myObjectId = {{sourceId}}

When writing a Metrics query, the below three columns are mandatory and all others will be ignored.

label: The label for the value passed in, for example ‘Percent Utilization’. Each distinct ‘label’ value will get its own line color which includes only values for that label.
timestamp: A DateTime value of when this reading occurred.
value: A numerical non-null value to be visualized.

Custom ODBC State Query

Parameter	Description
Query	Enter a SQL query which returns state. For example, `SELECT label,id,state FROM MyRecentState WHERE myObjectId = {{sourceId}}` When writing a State query, the below three columns are mandatory and all others will be ignored. `label`: The label for the state passed in, for example ‘Deliveries’. These ‘label’ values must be distinct and will each produce their own status block `id`: If this state will be tied to an object, then that object’s sourceId should be used, otherwise passing the ‘label’ value a second time will work effectively. `state`: The state of the labeled object, options are ‘Success’, ‘Warning’, ‘Error’, and ‘Unknown’.

Parameter

Description

Query

Enter a SQL query which returns state. For example, SELECT label,id,state FROM MyRecentState WHERE myObjectId = {{sourceId}}

When writing a State query, the below three columns are mandatory and all others will be ignored.

label: The label for the state passed in, for example ‘Deliveries’. These ‘label’ values must be distinct and will each produce their own status block
id: If this state will be tied to an object, then that object’s sourceId should be used, otherwise passing the ‘label’ value a second time will work effectively.
state: The state of the labeled object, options are ‘Success’, ‘Warning’, ‘Error’, and ‘Unknown’.

Custom ODBC Table Query

Parameter	Description
Query	Enter a SQL query. For example, `SELECT Name FROM MyTable WHERE myObjectId IN ({{sourceIds}})`

Was this article helpful?

Have more questions or facing an issue?

Submit a ticket