Commande .alter function docstring

Modifie la DocString valeur d’une fonction existante.

DocString est du texte libre que vous pouvez attacher à une table/fonction/colonne décrivant l’entité. Cette chaîne est présentée dans différents paramètres d’expérience utilisateur en regard des noms d’entité.

Remarque

Si la fonction n’existe pas, une erreur est retournée. Pour plus d’informations sur la création d’une fonction, consultez .create function.

autorisations

Vous devez disposer au moins des autorisations d’administrateur de fonction pour exécuter cette commande. Le principal qui crée la fonction est automatiquement créé comme administrateur de fonction.

Syntaxe

.alterfunction Documentation FunctionName docstring

En savoir plus sur les conventions de syntaxe.

Paramètres

Nom	Type	Requise	Description
FunctionName	string	✔️	Nom de la fonction à modifier.
Documentation	string	✔️	Nouvelle valeur de docstring pour la fonction.

Retours

Paramètre de sortie	Type	Description
Nom	string	Nom de la fonction
Paramètres	string	Paramètres requis par la fonction
Corps	string	(Zéro ou plus) let instructions suivies d’une expression CSL valide évaluée lorsque la fonction est appelée
Dossier	string	Dossier utilisé pour la catégorisation des fonctions d’interface utilisateur. Ce paramètre ne modifie pas la façon dont la fonction est appelée
DocString	string	Description de la fonction à des fins d’interface utilisateur

Exemple

.alter function MyFunction1 docstring "Updated docstring"

Sortie

Nom	Paramètres	Corps	Dossier	DocString
MyFunction2	(myLimit : long)	{StormEvents | take myLimit}	MyFolder	Mise à jour de docstring