Creazione di funzioni definite dall'utente (Motore di database)Create User-defined Functions (Database Engine)

In questo argomento viene descritto come creare una funzione definita dall'utente in SQL ServerSQL Server usando Transact-SQLTransact-SQL.This topic describes how to create a user-defined function (UDF) in SQL ServerSQL Server by using Transact-SQLTransact-SQL.

Prima di iniziare Before You Begin

Limitazioni e restrizioni Limitations and restrictions

  • Non è possibile utilizzare funzioni definite dall'utente per eseguire azioni che modificano lo stato del database.User-defined functions cannot be used to perform actions that modify the database state.

  • Le funzioni definite dall'utente non possono contenere una clausola OUTPUT INTO che ha una tabella come destinazione.User-defined functions cannot contain an OUTPUT INTO clause that has a table as its target.

  • Tramite le funzioni definite dall'utente non possono essere restituiti più set di risultati.User-defined functions can not return multiple result sets. Utilizzare una stored procedure se è necessario restituire più set di risultati.Use a stored procedure if you need to return multiple result sets.

  • In una funzione definita dall'utente la gestione degli errori è limitata.Error handling is restricted in a user-defined function. Una funzione definita dall'utente non supporta TRY…CATCH, @ERROR o RAISERROR.A UDF does not support TRY…CATCH, @ERROR or RAISERROR.

  • Tramite le funzioni definite dall'utente non è possibile chiamare una stored procedure normale, bensì una estesa.User-defined functions cannot call a stored procedure, but can call an extended stored procedure.

  • Nelle funzioni definite dall'utente non è possibile utilizzare tabelle temporanee o SQL dinamiche.User-defined functions cannot make use of dynamic SQL or temp tables. Sono consentite le variabili di tabella.Table variables are allowed.

  • In una funzione definita dall'utente non sono consentite istruzioni SET.SET statements are not allowed in a user-defined function.

  • La clausola FOR XML non è consentitaThe FOR XML clause is not allowed

  • È possibile nidificare le funzioni definite dall'utente, ovvero una funzione definita dall'utente ne può richiamare un'altra.User-defined functions can be nested; that is, one user-defined function can call another. Il livello di nidificazione aumenta all'avvio della funzione richiamata e diminuisce al termine dell'esecuzione della funzione.The nesting level is incremented when the called function starts execution, and decremented when the called function finishes execution. Le funzioni definite dall'utente possono essere nidificate fino a un massimo di 32 livelli.User-defined functions can be nested up to 32 levels. Se viene superato il livello massimo di nidificazioni, l'intera sequenza di funzioni chiamanti ha esito negativo.Exceeding the maximum levels of nesting causes the whole calling function chain to fail. 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.Any reference to managed code from a Transact-SQL user-defined function counts as one level against the 32-level nesting limit. I metodi richiamati da codice gestito non vengono inclusi nel conteggio per questo limite.Methods invoked from within managed code do not count against this limit.

  • Nella definizione di una funzione definita dall'utente Transact-SQL non è possibile includere le istruzioni di Service Broker seguenti:The following Service Broker statements cannot be included in the definition of a Transact-SQL user-defined function:

    • BEGIN DIALOG CONVERSATIONBEGIN DIALOG CONVERSATION

    • END CONVERSATIONEND CONVERSATION

    • GET CONVERSATION GROUPGET CONVERSATION GROUP

    • MOVE CONVERSATIONMOVE CONVERSATION

    • RECEIVERECEIVE

    • SENDSEND

Autorizzazioni Permissions

È necessario disporre dell'autorizzazione CREATE FUNCTION nel database e dell'autorizzazione ALTER per lo schema in cui la funzione è in fase di creazione.Requires CREATE FUNCTION permission in the database and ALTER permission on the schema in which the function is being created. Se per la funzione viene specificato un tipo definito dall'utente, è necessario disporre dell'autorizzazione EXECUTE per tale tipo.If the function specifies a user-defined type, requires EXECUTE permission on the type.

Funzioni scalari Scalar Functions

Negli esempi seguenti viene creata una funzione scalare a più istruzioni nel database AdventureWorks2012AdventureWorks2012 .The following example creates a multistatement scalar function in the AdventureWorks2012AdventureWorks2012 database. La funzione accetta un valore di input, un valore ProductIDe restituisce un singolo valore di dati, la quantità aggregata del prodotto specificato nelle scorte.The function takes one input value, a ProductID, and returns a single data value, the aggregated quantity of the specified product in inventory.

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;  
GO  

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.The following example uses the ufnGetInventoryStock function to return the current inventory quantity for products that have a ProductModelID between 75 and 80.

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

Funzioni con valori di tabella Table-Valued Functions

Nell'esempio seguente viene creata una funzione inline con valori di tabella nel database AdventureWorks2012AdventureWorks2012 .The following example creates an inline table-valued function in the AdventureWorks2012AdventureWorks2012 database. 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.The function takes one input parameter, a customer (store) ID, and returns the columns ProductID, Name, and the aggregate of year-to-date sales as YTD Total for each product sold to the store.

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.The following example invokes the function and specifies customer ID 602.

SELECT * FROM Sales.ufn_SalesByStore (602);  

Nell'esempio seguente viene creata una funzione con valori di tabella nel database AdventureWorks2012AdventureWorks2012 .The following example creates a table-valued function in the AdventureWorks2012AdventureWorks2012 database. 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.The function takes a single input parameter, an EmployeeID and returns a list of all the employees who report to the specified employee directly or indirectly. La funzione viene quindi richiamata specificando l'ID dipendente 109.The function is then invoked specifying employee ID 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  
-- Example invocation  
SELECT EmployeeID, FirstName, LastName, JobTitle, RecursionLevel  
FROM dbo.ufn_FindReports(1);  

Altri esempiMore examples