.alter function docstring command

Ändrar värdet för DocString en befintlig funktion.

DocString är fritext som du kan koppla till en tabell/funktion/kolumn som beskriver entiteten. Den här strängen visas i olika UX-inställningar bredvid entitetsnamnen.

Anteckning

Om funktionen inte finns returneras ett fel. Mer information om hur du skapar en ny funktion finns i .create function.

Behörigheter

Du måste ha minst funktionsbehörighet Admin behörighet att köra det här kommandot. Det huvudnamn som skapar funktionen görs automatiskt till en funktion Admin.

Syntax

.alter function FunctionNamedocstringDokumentation

Läs mer om syntaxkonventioner.

Parametrar

Namn	Typ	Obligatorisk	Beskrivning
FunctionName	string	✔️	Namnet på funktionen som ska ändras.
Dokumentation	string	✔️	Det nya docstring-värdet för funktionen.

Returer

Utdataparameter	Typ	Beskrivning
Name	string	Namnet på funktionen
Parametrar	string	De parametrar som krävs av funktionen
Brödtext	string	(Noll eller mer) let -instruktioner följt av ett giltigt CSL-uttryck som utvärderas när funktionen anropas
Mapp	string	En mapp som används för kategorisering av gränssnittsfunktioner. Den här parametern ändrar inte hur funktionen anropas
DocString	string	En beskrivning av funktionen i användargränssnittssyfte

Exempel

.alter function MyFunction1 docstring "Updated docstring"

Resultat

Name	Parametrar	Brödtext	Mapp	DocString
MyFunction2	(myLimit: long)	{StormEvents | take myLimit}	MyFolder	Docstring har uppdaterats