Creare funzioni definite dall'utente (motore di database)

Articolo
03/19/2024

Si applica a:SQL Server Database SQL di Azure Istanza gestita di SQL di Azure Azure Synapse Analytics Piattaforma di strumenti analitici (PDW)

In questo articolo viene descritto come creare una funzione definita dall'utente in SSQL Server usando Transact-SQL.

Limitazioni e restrizioni

Non è possibile utilizzare funzioni definite dall'utente per eseguire azioni che modificano lo stato del database.
Le funzioni definite dall'utente non possono contenere una clausola OUTPUT INTO che ha una tabella come destinazione.
Le funzioni definite dall'utente non possono restituire più set di risultati. Utilizzare una stored procedure se è necessario restituire più set di risultati.
In una funzione definita dall'utente la gestione degli errori è limitata. Una funzione definita dall'utente non supporta TRY...CATCH, @ERROR o RAISERROR.
Tramite le funzioni definite dall'utente non è possibile chiamare una stored procedure normale, bensì una estesa.
Nelle funzioni definite dall'utente non è possibile utilizzare tabelle temporanee o SQL dinamiche. Sono consentite le variabili di tabella.
In una funzione definita dall'utente non sono consentite istruzioni SET.
La clausola FOR XML non è consentita.
È possibile nidificare le funzioni definite dall'utente, ovvero una funzione definita dall'utente ne può richiamare un'altra. Il livello di nidificazione aumenta all'avvio della funzione richiamata e diminuisce al termine dell'esecuzione della funzione. Le funzioni definite dall'utente possono essere nidificate fino a un massimo di 32 livelli. Se viene superato il livello massimo di nidificazioni, l'intera sequenza di funzioni chiamanti ha esito negativo. Qualsiasi riferimento al codice gestito presente in una funzione definita dall'utente Transact-SQL viene considerato come un livello nel contesto del limite di 32 livelli di nidificazione. I metodi richiamati dal codice gestito non vengono inclusi nel conteggio per questo limite.
Nella definizione di una funzione definita dall'utente Transact-SQL non è possibile includere le istruzioni di Service Broker seguenti:
- BEGIN DIALOG CONVERSATION
- END CONVERSATION
- GET CONVERSATION GROUP
- MOVE CONVERSATION
- RECEIVE
- SEND

Autorizzazioni

È necessario disporre dell'autorizzazione CREATE FUNCTION nel database e dell'autorizzazione ALTER per lo schema in cui la funzione è in fase di creazione. Se per la funzione viene specificato un tipo definito dall'utente, è necessario disporre dell'autorizzazione EXECUTE per tale tipo.

Esempi di funzioni scalari

Funzione scalare (funzione definita dall'utente scalare)

Nell'esempio seguente viene creata una funzione scalare (UDF scalare) con istruzioni multiple nel database AdventureWorks2022. La funzione accetta un valore di input, un valore ProductIDe restituisce un singolo valore di dati, la quantità aggregata del prodotto specificato nelle scorte.

IF OBJECT_ID (N'dbo.ufnGetInventoryStock', N'FN') IS NOT NULL
    DROP FUNCTION ufnGetInventoryStock;
GO
CREATE FUNCTION dbo.ufnGetInventoryStock(@ProductID int)
RETURNS int
AS
-- Returns the stock level for the product.
BEGIN
    DECLARE @ret int;
    SELECT @ret = SUM(p.Quantity)
    FROM Production.ProductInventory p
    WHERE p.ProductID = @ProductID
        AND p.LocationID = '6';
     IF (@ret IS NULL)
        SET @ret = 0;
    RETURN @ret;
END;

Nell'esempio seguente viene utilizzata la funzione ufnGetInventoryStock per conoscere la quantità di scorte corrente dei prodotti il cui valore ProductModelID è compreso tra 75 e 80.

SELECT ProductModelID, Name, dbo.ufnGetInventoryStock(ProductID)AS CurrentSupply
FROM Production.Product
WHERE ProductModelID BETWEEN 75 and 80;

Per altre informazioni ed esempi di funzioni scalari, vedere CREATE FUNCTION (Transact-SQL).

Funzione con valori di tabella di esempio

Funzioni con valori di tabella inline (TVF)

Nell'esempio seguente viene creata una funzione con valori di tabella inline con valori di tabella nel database AdventureWorks2022. La funzione accetta un parametro di input, un ID (punto vendita) cliente e restituisce le colonne ProductID, Namee l'aggregazione delle vendite per l'anno in corso come valore YTD Total per ogni prodotto venduto al punto vendita.

IF OBJECT_ID (N'Sales.ufn_SalesByStore', N'IF') IS NOT NULL
    DROP FUNCTION Sales.ufn_SalesByStore;
GO
CREATE FUNCTION Sales.ufn_SalesByStore (@storeid int)
RETURNS TABLE
AS
RETURN
(
    SELECT P.ProductID, P.Name, SUM(SD.LineTotal) AS 'Total'
    FROM Production.Product AS P
    JOIN Sales.SalesOrderDetail AS SD ON SD.ProductID = P.ProductID
    JOIN Sales.SalesOrderHeader AS SH ON SH.SalesOrderID = SD.SalesOrderID
    JOIN Sales.Customer AS C ON SH.CustomerID = C.CustomerID
    WHERE C.StoreID = @storeid
    GROUP BY P.ProductID, P.Name
);

Nell'esempio seguente viene richiamata la funzione e viene specificato l'ID cliente 602.

SELECT * FROM Sales.ufn_SalesByStore (602);

Funzioni con valori di tabella con istruzioni multiple (MSTVF)

Nell'esempio seguente viene creata una funzione con valori di tabella con istruzioni multiple nel database AdventureWorks2022. Nella funzione viene accettato un solo parametro di input, un valore EmployeeID , e tramite essa viene restituito un elenco di tutti i dipendenti che fanno riferimento direttamente o indirettamente al dipendente specificato. La funzione viene quindi richiamata specificando l'ID dipendente 109.

IF OBJECT_ID (N'dbo.ufn_FindReports', N'TF') IS NOT NULL
    DROP FUNCTION dbo.ufn_FindReports;
GO
CREATE FUNCTION dbo.ufn_FindReports (@InEmpID INTEGER)
RETURNS @retFindReports TABLE
(
    EmployeeID int primary key NOT NULL,
    FirstName nvarchar(255) NOT NULL,
    LastName nvarchar(255) NOT NULL,
    JobTitle nvarchar(50) NOT NULL,
    RecursionLevel int NOT NULL
)
--Returns a result set that lists all the employees who report to the
--specific employee directly or indirectly.*/
AS
BEGIN
WITH EMP_cte(EmployeeID, OrganizationNode, FirstName, LastName, JobTitle, RecursionLevel) -- CTE name and columns
    AS (
        SELECT e.BusinessEntityID, e.OrganizationNode, p.FirstName, p.LastName, e.JobTitle, 0 -- Get the initial list of Employees for Manager n
        FROM HumanResources.Employee e
INNER JOIN Person.Person p
ON p.BusinessEntityID = e.BusinessEntityID
        WHERE e.BusinessEntityID = @InEmpID
        UNION ALL
        SELECT e.BusinessEntityID, e.OrganizationNode, p.FirstName, p.LastName, e.JobTitle, RecursionLevel + 1 -- Join recursive member to anchor
        FROM HumanResources.Employee e
            INNER JOIN EMP_cte
            ON e.OrganizationNode.GetAncestor(1) = EMP_cte.OrganizationNode
INNER JOIN Person.Person p
ON p.BusinessEntityID = e.BusinessEntityID
        )
-- copy the required columns to the result of the function
   INSERT @retFindReports
   SELECT EmployeeID, FirstName, LastName, JobTitle, RecursionLevel
   FROM EMP_cte
   RETURN
END;
GO

Nell'esempio seguente viene richiamata la funzione e viene specificato l'ID dipendente 1.

SELECT EmployeeID, FirstName, LastName, JobTitle, RecursionLevel
FROM dbo.ufn_FindReports(1);

Per altre informazioni ed esempi sulle funzioni inline con valori di tabella e sulle funzioni con valori di tabella con istruzioni multiple, vedere CREATE FUNCTION (Transact-SQL).

Procedure consigliate

Se una funzione definita dall'utente non viene creata tramite la clausola SCHEMABINDING, le modifiche apportate agli oggetti sottostanti possono influire sulla definizione della funzione e generare risultati imprevisti quando viene richiamata. È consigliabile implementare uno dei metodi seguenti per assicurarsi che la funzione non diventi obsoleta in seguito a modifiche degli oggetti sottostanti:

Specificare la clausola WITH SCHEMABINDING quando si crea la funzione definita dall'utente. In questo modo, gli oggetti a cui si fa riferimento nella definizione della funzione possono essere modificati solo se viene modificata anche la funzione.
Eseguire la stored procedure sp_refreshsqlmodule dopo avere modificato qualsiasi oggetto specificato nella definizione della funzione definita dall'utente.

Se si crea una funzione definita dall'utente che non accede ai dati, specificare l'opzione SCHEMABINDING. In questo modo Query Optimizer non genererà operatori di spool inutili per piani di query che interessano queste funzioni. Per altre informazioni sugli spool, vedere Guida di riferimento a operatori Showplan logici e fisici. Per altre informazioni sulla creazione di una funzione associata a uno schema, vedere Funzioni associate a schema.

La creazione di un join di una funzione con valori di tabella con istruzioni multiple in una clausola FROM è possibile, ma può compromettere le prestazioni. In SQL Server non è possibile usare tutte le tecniche ottimizzate con alcune istruzioni che possono essere incluse in una funzione con valori di tabella con istruzioni multiple, comportando un piano di query non ottimale. Per ottenere le migliori prestazioni possibili, utilizzare i join tra le tabelle di base anziché tra le funzioni, quando possibile.

Le funzioni con valori di tabella con istruzioni multiple hanno una stima di cardinalità predefinita pari a 100 a partire da SQL Server 2014 (12.x) e pari a 1 nelle versioni di SQL Server precedenti.

A partire da SQL Server 2017 (14.x), è possibile ottimizzazione un piano di esecuzione che usa le funzioni con valori di tabella con istruzioni multiple per sfruttare l'esecuzione interleaved. In questo modo si usa la cardinalità effettiva anziché i valori euristici specificati in precedenza.

Per altre informazioni, vedere Esecuzione interleaved per funzioni con valori di tabella a più istruzioni.

ANSI_WARNINGS non viene applicata quando vengono passati parametri a una stored procedure, una funzione definita dall'utente oppure in caso di dichiarazione e impostazione delle variabili in un'istruzione batch. Se, ad esempio, la variabile viene definita come char(3) e quindi impostata su un valore maggiore di tre caratteri, i dati verranno troncati alle dimensioni definite e l'istruzione INSERT o UPDATE avrà esito positivo.