Créer des fonctions définies par l’utilisateur (moteur de base de données)

Article
08/23/2023

S’applique à :SQL Server Azure SQL Database Azure SQL Managed Instance Azure Synapse Analytics Analytics Platform System (PDW)

Cet article explique comment créer une fonction définie par l’utilisateur (UDF) dans SQL Server à l’aide de Transact-SQL.

Limitations et restrictions

Les fonctions définies par l’utilisateur ne peuvent pas être utilisées pour effectuer des actions qui modifient l’état de la base de données.
Les fonctions définies par l’utilisateur ne peuvent pas contenir de OUTPUT INTO clause qui a une table comme cible.
Les fonctions définies par l’utilisateur ne peuvent pas retourner plusieurs jeux de résultats. Utilisez une procédure stockée si vous devez renvoyer plusieurs jeux de résultats.
La gestion des erreurs est restreinte dans une fonction définie par l'utilisateur. Une fonction UDF ne prend pas en charge TRY...CATCH, @ERROR ou RAISERROR.
Les fonctions définies par l’utilisateur ne peuvent pas appeler une procédure stockée, mais peuvent appeler une procédure stockée étendue.
Les fonctions définies par l’utilisateur ne peuvent pas utiliser des tables SQL ou temporaires dynamiques. Les variables de table sont autorisées.
SET les instructions ne sont pas autorisées dans une fonction définie par l’utilisateur.
La FOR XML clause n’est pas autorisée.
Les fonctions définies par l'utilisateur peuvent être imbriquées ; en d'autres termes, une fonction définie par l'utilisateur peut en appeler une autre. Le niveau d'imbrication est incrémenté lorsque la fonction appelée commence à s'exécuter, et décrémenté lorsque l'exécution est terminée. Les fonctions définies par l'utilisateur peuvent être imbriquées jusqu'à 32 niveaux. Le dépassement des niveaux d'imbrication maximum autorisés, provoque l'échec de la totalité de la chaîne de fonctions appelantes. Toute référence à du code managé depuis une fonction Transact-SQL définie par l'utilisateur compte pour un niveau parmi les 32 niveaux d'imbrication possibles. Les méthodes appelées à partir du code managé ne comptent pas par rapport à cette limite.
Les instructions Service Broker suivantes ne peuvent pas être incluses dans la définition d’une fonction Transact-SQL définie par l’utilisateur :
- BEGIN DIALOG CONVERSATION
- END CONVERSATION
- GET CONVERSATION GROUP
- MOVE CONVERSATION
- RECEIVE
- SEND

Autorisations

Nécessite l’autorisation CREATE FUNCTION dans la base de données et l’autorisation ALTER sur le schéma dans lequel la fonction est créée. Si la fonction spécifie un type défini par l’utilisateur, elle nécessite l’autorisation EXECUTE sur le type.

Exemples de fonctions scalaires

Fonction scalaire (UDF scalaire)

L’exemple suivant crée une fonction scalaire à plusieurs instructions (UDF scalaire) dans la base de données AdventureWorks2022. À partir d'une valeur d'entrée unique ( ProductID), la fonction retourne une valeur de donnée unique, en l'occurrence, la quantité totale du produit spécifié en stock.

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;

Dans l'exemple suivant, la fonction ufnGetInventoryStock est utilisée pour déterminer la quantité en stock des produits dont la valeur ProductModelID est comprise entre 75 et 80.

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

Pour plus d’informations et des exemples de fonctions scalaires, consultez CREATE FUNCTION (Transact-SQL).

Exemples de fonctions table

Fonction table inline (TVF)

L’exemple suivant crée une fonction table inline (TVF) dans la base de données AdventureWorks2022. À partir d'un paramètre d'entrée unique (storeID), la fonction retourne les colonnes ProductID, Name, ainsi que le total cumulé des ventes ( YTD Total ) pour chaque produit vendu au magasin du client.

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

L'exemple suivant appelle la fonction et spécifie l'ID client 602.

SELECT * FROM Sales.ufn_SalesByStore (602);

Fonction table à plusieurs instructions (MSTVF)

L’exemple suivant crée une fonction table à plusieurs instructions (MSTVF) dans la base de données AdventureWorks2022. À partir d'un paramètre d'entrée unique, EmployeeID , la fonction retourne la liste de tous les employés qui sont sous la responsabilité directe ou indirecte de l'employé spécifié. La fonction est ensuite appelée en spécifiant l'ID d'employé 19.

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

L’exemple suivant appelle la fonction et spécifie l’ID d’employé 1.

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

Pour plus d’informations et des exemples de fonctions table inline (TVFs inline) et de fonctions table à plusieurs instructions (MSTVF), consultez CREATE FUNCTION (Transact-SQL).

Meilleures pratiques

Si une fonction définie par l’utilisateur (UDF) n’est pas créée avec la SCHEMABINDING clause, les modifications apportées aux objets sous-jacents peuvent affecter la définition de la fonction et produire des résultats inattendus lorsqu’elles sont appelées. Nous vous recommandons d’implémenter l’une des méthodes suivantes pour vous assurer que la fonction n’est pas obsolète en raison des modifications apportées à ses objets sous-jacents :

Spécifiez la WITH SCHEMABINDING clause lorsque vous créez la fonction UDF. Cela garantit que les objets référencés dans la définition de fonction ne peuvent pas être modifiés, sauf si la fonction est également modifiée.
Exécutez la procédure stockée sp_refreshsqlmodule après avoir modifié tout objet spécifié dans la définition de la fonction UDF.

Si vous créez une fonction UDF qui n’accède pas aux données, spécifiez l’option SCHEMABINDING . Elle empêche l’optimiseur de requête de générer des opérateurs de spool inutiles pour les plans de requête impliquant ces fonctions UDF. Pour plus d’informations sur les spools, consultez le Guide de référence des opérateurs Showplan logiques et physiques. Pour plus d’informations sur la création d’une fonction liée à un schéma, consultez Fonctions liées à un schéma.

Il est possible de se joindre à une fonction table à instructions multiples dans une clause FROM, mais cela peut nuire aux performances. SQL Server ne peut pas utiliser toutes les techniques optimisées sur certaines instructions qui peuvent être incluses dans un MSTVF, ce qui entraîne un plan de requête non optimal. Pour obtenir de meilleures performances, quand cela est possible, utilisez des jointures entre les tables de base au lieu des fonctions.

Les MSTVF ont une estimation de cardinalité fixe de 100 à partir de SQL Server 2014 (12.x) et 1 pour les versions antérieures de SQL Server.

À compter de SQL Server 2017 (14.x), l’optimisation d’un plan d’exécution qui utilise des fichiers MSTVF peut utiliser l’exécution entrelacée, ce qui entraîne l’utilisation de la cardinalité réelle au lieu des heuristiques ci-dessus.

Pour plus d’informations, consultez Exécution entrelacée pour les fonctions table à instructions multiples.

ANSI_WARNINGS n’est pas respecté lorsque vous passez des paramètres dans une procédure stockée, une fonction définie par l’utilisateur ou lorsque vous déclarez et définissez des variables dans une instruction batch. Par exemple, si une variable est définie comme char(3) et qu’une valeur de plus de trois caractères lui est attribuée, les données sont tronquées en fonction de la taille définie, et l’instruction INSERT ou UPDATE réussit.