| title | description | author | ms.author | ms.date | ms.service | ms.subservice | ms.topic | f1_keywords | helpviewer_keywords | dev_langs | monikerRange | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sys.dm_external_script_execution_stats |
sys.dm_external_script_execution_stats |
rwestMSFT |
randolphwest |
06/17/2023 |
sql |
machine-learning |
reference |
|
|
|
>=sql-server-2016||>=sql-server-linux-ver15||=azuresqldb-mi-current |
[!INCLUDE SQL Server 2016 SQL MI]
Returns one row for each type of external script request. The external script requests are grouped by the supported external script language. One row is generated for each registered external script function. Arbitrary external script functions aren't recorded unless sent by a parent process, such as rxExec.
Note
This dynamic management view (DMV) is available only if you have installed and enabled the feature that supports external script execution. For more information, see R Services in SQL Server 2016, Machine Learning Services (R, Python) in SQL Server 2017 and later and Azure SQL Managed Instance Machine Learning Services.
| Column name | Data type | Description |
|---|---|---|
language |
nvarchar | Name of the registered external script language. Each external script must specify the language in the script request to start the associated launcher. |
counter_name |
nvarchar | Name of a registered external script function. Isn't nullable. |
counter_value |
integer | Total number of instances that the registered external script function has been called on the server. This value is cumulative, beginning with the time that the feature was installed on the instance, and can't be reset. |
For [!INCLUDE sssql19-md] and previous versions, requires VIEW SERVER STATE permission on server.
For [!INCLUDE sssql22-md] and later versions, requires VIEW SERVER PERFORMANCE STATE permission on the server.
Users who run external scripts must have the additional permission EXECUTE ANY EXTERNAL SCRIPT. However, this DMV can be used by administrators without this permission.
This DMV is provided for internal telemetry, to monitor overall usage of the new external script execution feature provided in [!INCLUDE ssNoVersion_md]. The telemetry service starts when LaunchPad does and increments a disk-based counter each time a registered external script function is called.
Generally speaking, performance counters are valid only as long as the process that generated them is active. Therefore, a query on a DMV can't show detailed data for services that have stopped running. For example, if a launcher executes external script and yet completes them quickly, a conventional DMV might not show any data.
Therefore, the counters tracked by this DMV are kept running, and state for sys.dm_external_script_requests is preserved by using writes to disk, even if the instance is shut down.
In [!INCLUDE sssql16-md], the only external language supported is R and the external script requests are handled by [!INCLUDE rsql_productname_md]. In [!INCLUDE sssql17-md] and later versions, and on Azure SQL Managed Instance, both R and Python are supported external languages and the external script requests are handled by [!INCLUDE rsql_productname_md].
For R, this DMV tracks the number of R calls that are made on an instance. For example, if rxLinMod is called and run in parallel, the counter increments by 1.
For the R language, the counter values displayed in the counter_name field represent the names of registered ScaleR functions. The values in the counter_value field represent the cumulative number of instances that the specific ScaleR function.
For Python, this DMV tracks the number of Python calls that are made on an instance.
The count begins when the feature is installed and enabled on the instance, and is cumulative until the file that maintains state is deleted or overwritten by an administrator. Therefore, it's generally not possible to reset the values in counter_value. If you want to monitor usage by session, calendar times, or other intervals, we recommend that you capture the counts to a table.
R supports arbitrary scripts, and the R community provides thousands of packages, each with their own functions and methods. However, this DMV monitors only the ScaleR functions that are installed with [!INCLUDE sssql16-md] R Services.
Registration of these functions is performed when the feature is installed, and registered functions can't be added or deleted.
The following example displays the cumulative number of external script executions for the R language.
SELECT counter_name, counter_value
FROM sys.dm_external_script_execution_stats
WHERE language = 'R';The following example displays the cumulative number of external script executions for the Python language.
SELECT counter_name, counter_value
FROM sys.dm_external_script_execution_stats
WHERE language = 'Python';