Merge pull request #32015 from rwestMSFT/rw-1008-fix-9900

Update sys-fn-stmt-sql-handle-from-sql-stmt (PR 9900)

Author: denrea

docs/relational-databases/system-functions/sys-fn-stmt-sql-handle-from-sql-stmt-transact-sql.md

@@ -1,22 +1,22 @@
 ---
 title: "sys.fn_stmt_sql_handle_from_sql_stmt (Transact-SQL)"
-description: "sys.fn_stmt_sql_handle_from_sql_stmt (Transact-SQL)"
+description: Gets the stmt_sql_handle for a Transact-SQL statement under a given parameterization type (simple or forced).
 author: rwestMSFT
 ms.author: randolphwest
-ms.date: 09/09/2023
+ms.date: 10/08/2024
 ms.service: sql
 ms.subservice: system-objects
 ms.topic: "reference"
 dev_langs:
   - "TSQL"
-monikerRange: "=azuresqldb-current||>=sql-server-2016||>=sql-server-linux-2017||=azuresqldb-mi-current"
+monikerRange: "=azuresqldb-current || >=sql-server-2016 || >=sql-server-linux-2017 || =azuresqldb-mi-current"
 ---
 
 # sys.fn_stmt_sql_handle_from_sql_stmt (Transact-SQL)
 
 [!INCLUDE [sqlserver2016-asdb-asdbmi](../../includes/applies-to-version/sqlserver2016-asdb-asdbmi.md)]
 
-Gets the **stmt_sql_handle** for a [!INCLUDE [tsql](../../includes/tsql-md.md)] statement under given parameterization type (simple or forced). This allows you to refer to queries stored in the Query Store by using their **stmt_sql_handle** when you know their text.
+Gets the `stmt_sql_handle` for a [!INCLUDE [tsql](../../includes/tsql-md.md)] statement under the given parameterization type (simple or forced). You can refer to queries stored in the Query Store by using their `stmt_sql_handle` when you know their text.
 
 :::image type="icon" source="../../includes/media/topic-link-icon.svg" border="false"::: [Transact-SQL syntax conventions](../../t-sql/language-elements/transact-sql-syntax-conventions-transact-sql.md)
 
@@ -25,78 +25,84 @@ Gets the **stmt_sql_handle** for a [!INCLUDE [tsql](../../includes/tsql-md.md)]
 ```syntaxsql
 sys.fn_stmt_sql_handle_from_sql_stmt
 (
-    'query_sql_text' ,
-    [ query_param_type
-) [;]
+    N'query_sql_text'
+    , [ query_param_type ]
+)
+[ ; ]
 ```
 
 ## Arguments
 
-*query_sql_text*  
-Is the text of the query in the query store that you want the handle of. *query_sql_text* is a **nvarchar(max)**, with no default.
+#### *query_sql_text*
 
-*query_param_type*  
-Is the parameter type of the query. *query_param_type* is a **tinyint**. Possible values are:
+The text of the query in the query store that you want the handle of. *query_sql_text* is **nvarchar(max)** with no default.
 
-- NULL - defaults to 0
+#### *query_param_type*
 
-- 0 - None
+The parameter type of the query. *query_param_type* is **tinyint**, with a default of `NULL`. Possible values are:
 
-- 1 - User
+| Value | Description |
+| --- | --- |
+| `NULL` (default) | Defaults to `0` |
+| 0 | None |
+| 1 | User |
+| 2 | Simple |
+| 3 | Forced |
 
-- 2 - Simple
-
-- 3 - Forced
-
-## Columns Returned
+## Columns returned
 
 The following table lists the columns that `sys.fn_stmt_sql_handle_from_sql_stmt` returns.
 
 | Column name | Type | Description |
 | --- | --- | --- |
-| **statement_sql_handle** | **varbinary(64)** | The SQL handle. |
-| **query_sql_text** | **nvarchar(max)** | The text of the [!INCLUDE [tsql](../../includes/tsql-md.md)] statement. |
-| **query_parameterization_type** | **tinyint** | The query parameterization type. |
+| `statement_sql_handle` | **varbinary(64)** | The SQL handle. |
+| `query_sql_text` | **nvarchar(max)** | The text of the [!INCLUDE [tsql](../../includes/tsql-md.md)] statement. |
+| `query_parameterization_type` | **tinyint** | The query parameterization type. |
 
 ## Return code values
 
-0 (success) or 1 (failure)
-
-## Remarks
+`0` (success) or `1` (failure).
 
 ## Permissions
 
-Requires the **EXECUTE** permission on the database, and **DELETE** permission on the query store catalog views.
+Requires `EXECUTE` permission on the database, and `DELETE` permission on the query store catalog views.
 
 ## Examples
 
 The following example executes a statement, and then uses `sys.fn_stmt_sql_handle_from_sql_stmt` to return the SQL handle of that statement.
 
-```
-SELECT * FROM sys.databases;
-SELECT * FROM sys.fn_stmt_sql_handle_from_sql_stmt('SELECT * FROM sys.databases', NULL);
+```sql
+SELECT *
+FROM sys.databases;
+
+SELECT *
+FROM sys.fn_stmt_sql_handle_from_sql_stmt('SELECT * FROM sys.databases', NULL);
 ```
 
 Use the function to correlate Query Store data with other dynamic management views. The following example:
 
-```
-SELECT qt.query_text_id, q.query_id, qt.query_sql_text, qt.statement_sql_handle,
-q.context_settings_id, qs.statement_context_id
+```sql
+SELECT qt.query_text_id,
+       q.query_id,
+       qt.query_sql_text,
+       qt.statement_sql_handle,
+       q.context_settings_id,
+       qs.statement_context_id
 FROM sys.query_store_query_text AS qt
-JOIN sys.query_store_query AS q
-    ON qt.query_text_id = q.query_id
-CROSS APPLY sys.fn_stmt_sql_handle_from_sql_stmt (qt.query_sql_text, null) AS fn_handle_from_stmt
-JOIN sys.dm_exec_query_stats AS qs
-    ON fn_handle_from_stmt.statement_sql_handle = qs.statement_sql_handle;
+     INNER JOIN sys.query_store_query AS q
+         ON qt.query_text_id = q.query_text_id
+CROSS APPLY sys.fn_stmt_sql_handle_from_sql_stmt(qt.query_sql_text, NULL) AS fn_handle_from_stmt
+     INNER JOIN sys.dm_exec_query_stats AS qs
+         ON fn_handle_from_stmt.statement_sql_handle = qs.statement_sql_handle;
 ```
 
-## See also
+## Related content
 
-- [sp_query_store_force_plan (Transact-SQL)](../../relational-databases/system-stored-procedures/sp-query-store-force-plan-transact-sql.md)
-- [sp_query_store_remove_plan (Transact-SQL)](../../relational-databases/system-stored-procedures/sp-query-store-remove-plan-transact-sql.md)
-- [sp_query_store_unforce_plan (Transact-SQL)](../../relational-databases/system-stored-procedures/sp-query-store-unforce-plan-transact-sql.md)
-- [sp_query_store_reset_exec_stats (Transact-SQL)](../../relational-databases/system-stored-procedures/sp-query-store-reset-exec-stats-transact-sql.md)
-- [sp_query_store_flush_db (Transact-SQL)](../../relational-databases/system-stored-procedures/sp-query-store-flush-db-transact-sql.md)
-- [sp_query_store_remove_query (Transact-SQL)](../../relational-databases/system-stored-procedures/sp-query-store-remove-query-transact-sql.md)
-- [Query Store Catalog Views (Transact-SQL)](../../relational-databases/system-catalog-views/query-store-catalog-views-transact-sql.md)
-- [Monitoring Performance By Using the Query Store](../../relational-databases/performance/monitoring-performance-by-using-the-query-store.md)
+- [sp_query_store_force_plan (Transact-SQL)](../system-stored-procedures/sp-query-store-force-plan-transact-sql.md)
+- [sp_query_store_remove_plan (Transact-SQL)](../system-stored-procedures/sp-query-store-remove-plan-transact-sql.md)
+- [sp_query_store_unforce_plan (Transact-SQL)](../system-stored-procedures/sp-query-store-unforce-plan-transact-sql.md)
+- [sp_query_store_reset_exec_stats (Transact-SQL)](../system-stored-procedures/sp-query-store-reset-exec-stats-transact-sql.md)
+- [sp_query_store_flush_db (Transact-SQL)](../system-stored-procedures/sp-query-store-flush-db-transact-sql.md)
+- [sp_query_store_remove_query (Transact-SQL)](../system-stored-procedures/sp-query-store-remove-query-transact-sql.md)
+- [Query Store catalog views (Transact-SQL)](../system-catalog-views/query-store-catalog-views-transact-sql.md)
+- [Monitor performance by using the Query Store](../performance/monitoring-performance-by-using-the-query-store.md)