Partager via

  • Article

ALTER FUNCTION (Transact-SQL)

Modifie une fonction existante Transact-SQL ou clr, créée précédemment à l'aide de l'instruction CREATE FUNCTION, sans changer les autorisations ni affecter les fonctions, les procédures stockées ou les déclencheurs dépendant de celle-ci.

Icône Lien de rubriqueConventions de syntaxe de Transact-SQL

Syntaxe

Scalar Functions
ALTER FUNCTION [ schema_name. ] function_name ( [ { @parameter_name [ AS ][ type_schema_name. ] parameter_data_type 
    [ =default ] } 
    [ ,...n ]
  ]
)
RETURNS return_data_type
    [ WITH <function_option> [ ,...n ] ]
    [ AS ]
    BEGIN 
        function_body 
        RETURN scalar_expression
    END
[ ; ]

Inline Table-valued Functions
ALTER FUNCTION [ schema_name. ] function_name ( [ { @parameter_name [ AS ] [ type_schema_name. ] parameter_data_type 
    [ =default ] } 
    [ ,...n ]
  ]
)
RETURNS TABLE
    [ WITH <function_option> [ ,...n ] ]
    [ AS ]
    RETURN [ ( ] select_stmt [ ) ]
[ ; ]

Multistatement Table-valued Functions
ALTER FUNCTION [ schema_name. ] function_name ( [ { @parameter_name [ AS ] [ type_schema_name. ] parameter_data_type 
    [ =default ] } 
    [ ,...n ]
  ]
)
RETURNS @return_variable TABLE <table_type_definition>
    [ WITH <function_option> [ ,...n ] ]
    [ AS ]
    BEGIN 
        function_body 
        RETURN
    END
[ ; ]

CLR Functions
ALTER FUNCTION [ schema_name. ] function_name ( { @parameter_name [AS] [ type_schema_name. ] parameter_data_type 
    [ =default ] } 
    [ ,...n ]
)
RETURNS { return_data_type | TABLE <clr_table_type_definition> }
    [ WITH <clr_function_option> [ ,...n ] ]
    [ AS ] EXTERNAL NAME <method_specifier>
[ ; ]

<method_specifier>::=
    assembly_name.class_name.method_nameFunction Options<function_option>::= 
{
    [ ENCRYPTION ]
  | [ SCHEMABINDING ]
  | [ RETURNS NULL ON NULL INPUT | CALLED ON NULL INPUT ]
  | [ EXECUTE_AS_Clause ]
}

<clr_function_option>::=
}
    [ RETURNS NULL ON NULL INPUT | CALLED ON NULL INPUT ]
  | [ EXECUTE_AS_Clause ]
}

Table Type Definitions<table_type_definition>:: = ( { <column_definition> <column_constraint> 
  | <computed_column_definition> } 
    [ <table_constraint> ] [ ,...n ]
)<clr_table_type_definition>:: = ( { column_name data_type } [ ,...n ] )<column_definition>::=
{
    { column_name data_type }
    [ [ DEFAULT constant_expression ] 
      [ COLLATE collation_name ] | [ ROWGUIDCOL ]
    ]
    | [ IDENTITY [ (seed ,increment ) ] ]
    [ <column_constraint> [ ...n ] ] 
}
<column_constraint>::= 
{
    [ NULL | NOT NULL ] 
    { PRIMARY KEY | UNIQUE }
      [ CLUSTERED | NONCLUSTERED ] 
        [ WITH FILLFACTOR = fillfactor 
        | WITH ( < index_option > [ , ...n ] )
      [ ON { filegroup | "default" } ]
  | [ CHECK (logical_expression ) ] [ ,...n ]
}

<computed_column_definition>::=column_name AS computed_column_expression<table_constraint>::=
{ 
    { PRIMARY KEY | UNIQUE }
      [ CLUSTERED | NONCLUSTERED ] 
      (column_name [ ASC | DESC ] [ ,...n ] )
        [ WITH FILLFACTOR = fillfactor 
        | WITH ( <index_option> [ , ...n ] )
  | [ CHECK (logical_expression ) ] [ ,...n ]
}

<index_option>::=
{ 
    PAD_INDEX = { ON | OFF } 
  | FILLFACTOR = fillfactor 
  | IGNORE_DUP_KEY = { ON | OFF }
  | STATISTICS_NORECOMPUTE = { ON | OFF } 
  | ALLOW_ROW_LOCKS = { ON | OFF }
  | ALLOW_PAGE_LOCKS ={ ON | OFF } 
}

Arguments

  • schema_name
    Nom du schéma auquel appartient la fonction définie par l'utilisateur.

  • function_name
    Fonction à modifier, définie par l'utilisateur.

    [!REMARQUE]

    Les parenthèses sont requises après le nom de fonction même si aucun paramètre n'est spécifié.

  • **@**parameter_name
    Paramètre dans la fonction définie par l'utilisateur. Un ou plusieurs paramètres peuvent être déclarés.

    Une fonction peut comprendre au maximum 2 100 paramètres. La valeur de chaque paramètre déclaré doit être fournie par l'utilisateur lors de l'exécution de la fonction, sauf si vous définissez une valeur par défaut pour le paramètre.

    Spécifiez un nom de paramètre en plaçant le signe @ comme premier caractère. Le nom de paramètre doit suivre les règles applicables aux identificateurs. Un paramètre étant local à une fonction, vous pouvez utiliser le même nom dans d'autres fonctions. Les paramètres ne peuvent que prendre la place de constantes ; ils ne peuvent pas être utilisés à la place de noms de tables, de colonnes ou d'autres objets de base de données.

    [!REMARQUE]

    ANSI_WARNINGS n'est pas honoré lors de la transmission de paramètres dans une procédure stockée, dans une fonction définie par l'utilisateur ou lors de la déclaration et de la définition de variables dans une instruction par lot. Par exemple, si vous définissez une variable en tant que char(3), puis que vous lui attribuez une valeur comprenant plus de trois caractères, les données sont tronquées au niveau de la taille définie et l'instruction INSERT ou UPDATE réussit.

  • [ type_schema_name. ] parameter_data_type
    Type de données de paramètre et, éventuellement, schéma auquel il appartient. Dans le cas des fonctions Transact-SQL, tous les types de données, y compris les types CLR définis par l'utilisateur, sont autorisés, à l'exception du type de données timestamp. Dans le cas des fonctions CLR, tous les types de données, y compris les types CLR définis par l'utilisateur, sont autorisés, à l'exception des types de données text, ntext, image et timestamp. Les types non scalaires cursor et table ne peuvent pas être spécifiés en tant que type de données de paramètre dans les fonctions Transact-SQL ou CLR.

    Si l'argument type_schema_name n'est pas précisé, le moteur de base de données SQL Server 2005 cherche la valeur de parameter_data_type dans l'ordre suivant :

    • Schéma qui contient les noms des types de données système SQL Server.

    • Schéma par défaut de l'utilisateur actuel dans la base de données active.

    • Le schéma dbo dans la base de données active.

  • [ **=**default ]
    Valeur par défaut pour le paramètre. Si vous avez défini une valeur par défaut indiquée par default, la fonction peut être exécutée sans spécifier de valeur pour ce paramètre.

    [!REMARQUE]

    Les valeurs de paramètre par défaut peuvent être spécifiées pour les fonctions CLR, à l'exception des types de données varchar(max) et varbinary(max).

    Lorsqu'un des paramètres de la fonction possède une valeur par défaut, le mot clé DEFAULT doit être spécifié lors de l'appel de la fonction afin d'extraire la valeur par défaut. Ce comportement est différent de l'utilisation de paramètres avec valeurs par défaut des procédures stockées pour lesquels l'omission du paramètre implique également la prise en compte de la valeur par défaut.

  • return_data_type
    Valeur de retour d'une fonction scalaire définie par l'utilisateur. Dans le cas des fonctions Transact-SQL, tous les types de données, y compris les types CLR définis par l'utilisateur, sont autorisés, à l'exception du type de données timestamp. Dans le cas des fonctions CLR, tous les types de données, y compris les types CLR définis par l'utilisateur, sont autorisés, à l'exception des types de données text, ntext, image et timestamp. Les types non scalaires cursor et table ne peuvent pas être spécifiés en tant que type de données de retour dans les fonctions Transact-SQL ou CLR.

  • function_body
    Spécifie qu'une série d'instructions Transact-SQL qui ne produisent pas ensemble un effet secondaire, tel que la modification d'une table, définissent la valeur de la fonction. function_body est uniquement utilisé dans les fonctions scalaires et les fonctions à instructions multiples comportant des valeurs de table.

    Dans les fonctions scalaires, function_body représente une série d'instructions Transact-SQL qui, ensemble, retournent une valeur scalaire.

    Dans les fonctions à instructions multiples comportant des valeurs de table, function_body est une série d'instructions Transact-SQL qui remplissent une variable de retour TABLE.

  • scalar_expression
    Indique que la fonction scalaire retourne une valeur scalaire.

  • TABLE
    Indique que la valeur de retour de la fonction table est une table. Seules les constantes et les **@**local_variables peuvent être transmis aux fonctions table.

    Dans les fonctions table en ligne, la valeur de retour TABLE est définie par le biais d'une instruction SELECT unique. Aucune variable retournée n'est associée à une fonction en ligne.

    Dans les fonctions table à instructions multiples, **@**return_variable est une variable TABLE utilisée pour stocker et accumuler les lignes à retourner en guise de valeur de la fonction. **@**return_variable peut être spécifié uniquement pour les fonctions Transact-SQL, pas pour les fonctions CLR.

  • select-stmt
    Représente l'instruction SELECT unique qui définit la valeur de retour d'une fonction table en ligne.

  • EXTERNAL NAME <method_specifier>, assembly_name.class_name.method_name
    Spécifie la méthode d'un assembly à lier à la fonction. assembly_name doit correspondre à un assembly existant visible sous SQL Server dans la base de données active. class_name doit être un identificateur SQL Server valide et faire office de classe dans l'assembly. Si la classe porte un nom qualifié par un espace de noms dont les parties sont séparées par un point (.), ce nom doit être délimité à l'aide de crochets ([]) ou de guillemets (""). method_name doit être un identificateur SQL Server valide et faire office de méthode statique dans la classe spécifiée.

    [!REMARQUE]

    Par défaut, SQL Server ne peut pas exécuter le code CLR. Vous pouvez créer, modifier et supprimer des objets de base de données qui référencent des modules CLR (Common Language Runtime) ; toutefois, vous ne pouvez pas exécuter ces références dans SQL Server tant que vous n'avez pas activé l'option clr enabled option. Pour activer l'option, utilisez sp_configure.

  • <table_type_definition>( { <column_definition> <column_constraint>   | <computed_column_definition> }   [ <table_constraint> ] [ ,...n ])
    Définit le type de données de table pour une fonction Transact-SQL. La déclaration de table comprend des définitions de colonne et des contraintes de colonne ou de table.

  • < clr_table_type_definition > ( { column_namedata_type } [ ,...n ] )
    Définit les types de données de table pour une fonction clr. La déclaration de table ne comprend que des types de données et des noms de colonne.

<function_option>::= et <clr_function_option>::=

Spécifie que la fonction aura une ou plusieurs des options suivantes.

  • ENCRYPTION
    Indique que le moteur de base de données chiffre les colonnes d'affichage catalogue qui contiennent le texte de l'instruction ALTER FUNCTION. L'utilisation de l'argument ENCRYPTION évite la publication de la fonction dans le cadre de la réplication SQL Server. L'argument ENCRYPTION ne peut pas être spécifié pour les fonctions CLR.

  • SCHEMABINDING
    Indique que la fonction est liée aux objets de base de données auxquels elle fait référence. Cette condition empêche que des modifications ne soient apportées à la fonction si d'autres objets liés au schéma y font référence.

    La liaison de la fonction aux objets auxquels elle fait référence est supprimée uniquement lorsqu'une des actions suivantes se produit :

    • La fonction est supprimée.

    • La fonction est modifiée, avec l'instruction ALTER, sans spécification de l'option SCHEMABINDING.

    Pour connaître la liste des conditions à réunir pour qu'une fonction soit liée à un schéma, consultez CREATE FUNCTION (Transact-SQL).

  • RETURNS NULL ON NULL INPUT | CALLED ON NULL INPUT
    Spécifie l'attribut OnNULLCall d'une fonction scalaire. S'il n'est pas spécifié, l'argument CALLED ON NULL INPUT est implicite par défaut. Cela signifie que le corps de la fonction est exécuté même si la valeur NULL est transmise comme argument.

    Si l'argument RETURNS NULL ON NULL INPUT est spécifié dans une fonction clr, il indique que SQL Server peut retourner NULL lorsque n'importe lequel des arguments qu'il reçoit a pour valeur NULL, sans réellement appeler le corps de la fonction. Si la méthode spécifiée dans <method_specifier> possède déjà un attribut personnalisé qui indique RETURNS NULL ON NULL INPUT, mais que l'instruction ALTER FUNCTION indique CALLED ON NULL INPUT, cette instruction est prioritaire. L'attribut OnNULLCall ne peut pas être spécifié pour les fonctions table CLR.

  • Clause EXECUTE AS
    Spécifie le contexte de sécurité dans lequel la fonction définie par l'utilisateur est exécutée. Par conséquent, vous pouvez choisir le compte d'utilisateur que SQL Server doit utiliser pour valider les autorisations sur tous les objets de base de données référencés par la fonction.

    [!REMARQUE]

    La clause EXECUTE AS ne peut pas être spécifiée pour les fonctions en ligne définies par l'utilisateur.

    Pour plus d'informations, consultez Clause EXECUTE AS (Transact-SQL).

< column_definition >::=

Définit le type de données de la table. La déclaration de table comprend des contraintes et des définitions de colonne. Dans le cas des fonctions clr, seules les valeurs de column_name et de data_type peuvent être spécifiées.

  • column_name
    Nom d'une colonne de la table. Les noms de colonnes doivent respecter les règles gouvernant les identificateurs et doivent être uniques dans la table. column_name peut comporter entre 1 et 128 caractères.

  • data_type
    Indique le type de données de la colonne. Dans le cas des fonctions Transact-SQL, tous les types de données, y compris les types CLR définis par l'utilisateur, sont autorisés, à l'exception du type de données timestamp. Dans le cas des fonctions CLR, tous les types de données, y compris les types CLR définis par l'utilisateur, sont autorisés, à l'exception des types de données text, ntext, image, char, varchar, varchar(max) et timestamp. Le type non scalaire cursor ne peut pas être spécifié en tant que type de données de colonne dans les fonctions Transact-SQL ou CLR.

  • DEFAULT constant_expression
    Spécifie la valeur fournie pour la colonne lorsque vous n'avez pas spécifié explicitement de valeur lors d'une insertion. constant_expression est une valeur de constante, la valeur NULL ou une valeur de fonction système. Les définitions DEFAULT peuvent être appliquées à n'importe quelle colonne, sauf à celles qui possèdent la propriété IDENTITY. L'argument DEFAULT ne peut pas être spécifié pour les fonctions table CLR.

  • COLLATE collation_name
    Indique le classement de la colonne. Sans autre indication, le classement par défaut de la base de données est attribué à la colonne. Le nom du classement peut être un nom de classement Windows ou SQL. Pour obtenir une liste ou des informations complémentaires, consultez Nom de classement Windows (Transact-SQL) et Nom du classement SQL Server (Transact-SQL).

    La clause COLLATE peut être utilisée pour modifier uniquement les classements des colonnes comportant les types de données char, varchar, nchar et nvarchar.

    L'argument COLLATE ne peut pas être spécifié pour les fonctions table CLR.

  • ROWGUIDCOL
    Indique que la nouvelle colonne est une colonne d'identificateur unique global de ligne. Une seule colonne uniqueidentifier par table peut servir de colonne ROWGUIDCOL. La propriété ROWGUIDCOL ne peut être affectée qu'à une colonne uniqueidentifier.

    La propriété ROWGUIDCOL n'assure pas l'unicité des valeurs stockées dans la colonne. Elle ne peut de plus générer automatiquement de valeurs pour les nouvelles lignes insérées dans la table. Pour générer des valeurs uniques pour chaque colonne, utilisez la fonction NEWID dans des instructions INSERT. Une valeur par défaut peut être spécifiée, mais ce ne peut pas être NEWID.

  • IDENTITY
    Indique que la nouvelle colonne est une colonne d'identité. Lorsqu'une ligne est ajoutée à la table, SQL Server affecte une valeur incrémentée unique à la colonne. Les colonnes d'identité sont généralement utilisées avec les contraintes PRIMARY KEY comme identificateur unique de ligne pour la table. La propriété IDENTITY peut être affectée aux colonnes tinyint, smallint, int, bigint, decimal(p,0) ou numeric(p,0). Une seule colonne d'identité peut être créée par table. Il n'est pas possible d'utiliser des valeurs par défaut liées et des contraintes DEFAULT avec une colonne d'identité. Vous devez spécifier à la fois seed et increment, ou bien aucun des deux. Si vous n'en spécifiez aucun, la valeur par défaut est (1,1).

    L'argument IDENTITY ne peut pas être spécifié pour les fonctions table CLR.

    • seed
      Valeur entière à affecter à la première ligne de la table.

    • increment
      Entier à ajouter à la valeur seed pour les lignes successives de la table.

< column_constraint >::= et < table_constraint>::=

Définit la contrainte d'une colonne ou table spécifiée. Dans le cas des fonctions CLR, le seul type de contrainte autorisé est NULL. L'utilisation de contraintes nommées n'est pas autorisée.

  • NULL | NOT NULL
    Détermine si les valeurs NULL sont autorisées dans la colonne. NULL n'est pas strictement une contrainte, mais peut être spécifié comme NOT NULL. L'argument NOT NULL ne peut pas être spécifié pour les fonctions table CLR.

  • PRIMARY KEY
    Contrainte assurant l'intégrité de l'entité d'une colonne spécifiée au moyen d'un seul index. Dans les fonctions table définies par l'utilisateur, la contrainte PRIMARY KEY ne peut être créée que sur une colonne par table. L'argument PRIMARY KEY ne peut pas être spécifié pour les fonctions table CLR.

  • UNIQUE
    Contrainte assurant l'intégrité de l'entité d'une colonne ou de plusieurs colonnes spécifiées au moyen d'un seul index. Une table peut comprendre plusieurs contraintes UNIQUE. L'argument UNIQUE ne peut pas être spécifié pour les fonctions table CLR.

  • CLUSTERED | NONCLUSTERED
    Indique qu'un index, cluster ou non cluster, est créé pour la contrainte PRIMARY KEY ou UNIQUE. Les contraintes PRIMARY KEY utilisent CLUSTERED, tandis que les contraintes UNIQUE recourent à NONCLUSTERED.

    CLUSTERED peut être spécifié pour une seule contrainte. Si CLUSTERED est spécifié pour une contrainte UNIQUE et qu'une contrainte PRIMARY KEY est également spécifiée, la contrainte PRIMARY KEY utilise NONCLUSTERED.

    Les arguments CLUSTERED et NONCLUSTERED ne peuvent pas être spécifiés pour les fonctions table CLR.

  • CHECK
    Contrainte qui assure l'intégrité du domaine en limitant les valeurs possibles pouvant être entrées dans une ou plusieurs colonnes. Les contraintes CHECK ne peuvent pas être spécifiées pour les fonctions table CLR.

    • logical_expression
      Expression logique qui retourne TRUE ou FALSE.

<computed_column_definition>::=

Spécifie une colonne calculée. Pour plus d'informations sur les colonnes calculées, consultez CREATE TABLE (Transact-SQL).

  • column_name
    Nom de la colonne calculée.

  • computed_column_expression
    Expression définissant la valeur d'une colonne calculée.

<index_option>::=

Spécifie les options de l'index PRIMARY KEY ou UNIQUE. Pour plus d'informations sur les options d'index, consultez CREATE INDEX (Transact-SQL).

  • PAD_INDEX = { ON | OFF }
    Spécifie le remplissage de l'index. La valeur par défaut est OFF.

  • FILLFACTOR = fillfactor
    Spécifie un pourcentage qui indique l'espace occupé par le niveau feuille de chaque page d'index opéré par le moteur de base de données lors de la création ou la modification d'index. fillfactor doit être une valeur de type entier comprise entre 1 et 100. La valeur par défaut est 0.

  • IGNORE_DUP_KEY = { ON | OFF }
    Spécifie la réponse d'erreur lorsqu'une opération d'insertion essaie d'insérer des valeurs de clé en double dans un index unique. L'option IGNORE_DUP_KEY s'applique uniquement aux opérations d'insertion après la création ou la régénération de l'index. La valeur par défaut est OFF.

  • STATISTICS_NORECOMPUTE = { ON | OFF }
    Spécifie si les statistiques de distribution sont recalculées. La valeur par défaut est OFF.

  • ALLOW_ROW_LOCKS = { ON | OFF }
    Indique si les verrous de ligne sont autorisés. La valeur par défaut est ON.

  • ALLOW_PAGE_LOCKS = { ON | OFF }
    Indique si les verrous de page sont autorisés. La valeur par défaut est ON.

Notes

ALTER FUNCTION ne peut pas être utilisé pour convertir une fonction à valeur scalaire en une fonction à valeur de table, et inversement. En outre, ALTER FUNCTION ne peut pas être utilisé pour convertir une fonction Inline en une fonction à instructions multiples, et inversement. ALTER FUNCTION ne peut pas être utilisé pour convertir une fonction Transact-SQL en une fonction clr, et inversement.

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 ALTER sur la fonction ou sur le schéma. Si la fonction spécifie un type défini par l'utilisateur, elle requiert l'autorisation EXECUTE sur le type.