Datometry Documentation

You can add a custom query label to the Transact-SQL OPTION clause using the set_user_label hint. The label you specify is added to the LABEL statement.

You can use the OPTION clause in SELECT, DELETE, UPDATE and MERGE statements. To learn more, see the Microsoft article OPTION Clause (Transact-SQL).

A query label is a tag (or metadata) that you can apply to a query using the OPTION clause with the LABEL statement. This tag is helpful since the label is query-able and provides a mechanism for locating problem queries and can help to identify the progress of an ELT run.

SELECT
  --@dtm_set_user_label = MY_LABEL for query
  1;

SELECT
CAST ('1' AS smallint ) AS [1]
OPTION (LABEL = 'DTM_HASH:abd429e,DTM_BSID:c96.0001,USER_LABEL:MY_LABEL' )

You can then query the system management view sys.dm_pdw_exec_requests using the label you applied to retrieve information about the query.

SELECT  *
FROM    sys.dm_pdw_exec_requests r
WHERE   r.[label] like '%MY_LABEL%'
;

To learn more about query labels in Azure Synapse, see the Microsoft article Use query labels in Synapse SQL.

The syntax for set_user_label is:

set_user_label = user_label

where:

SELECT
  --@dtm_set_user_label = MY_LABEL for query
  1;

SELECT
CAST ('1' AS smallint ) AS [1]
OPTION (LABEL = 'DTM_HASH:abd429e,DTM_BSID:c96.0001,USER_LABEL:MY_LABEL' )

SELECT
  --@dtm_set_user_label = MY_LABEL for session
  1;