.alter function docstring-Befehl
Gilt für: ✅Microsoft Fabric✅Azure Data Explorer
Ändert den DocString Wert einer vorhandenen Funktion.
DocString ist Freitext, den Sie an eine Tabelle/Funktion/Spalte anfügen können, die die Entität beschreibt. Diese Zeichenfolge wird in verschiedenen UX-Einstellungen neben den Entitätsnamen angezeigt.
Hinweis
Wenn die Funktion nicht vorhanden ist, wird ein Fehler zurückgegeben. Weitere Informationen zum Erstellen einer neuen Funktion finden Sie unter .create function.
Berechtigungen
Sie müssen mindestens über Funktionsadministratorberechtigungen verfügen, um diesen Befehl auszuführen. Der Prinzipal, der die Funktion erstellt, wird automatisch zu einem Funktionsadministrator.
Syntax
.alterfunction Funktionsname-Dokumentation docstring
Erfahren Sie mehr über Syntaxkonventionen.
Parameter
| Name | Type | Erforderlich | Beschreibung |
|---|---|---|---|
| FunctionName | string |
✔️ | Der Name der zu ändernden Funktion. |
| Dokumentation | string |
✔️ | Der neue Docstring-Wert für die Funktion. |
Gibt zurück
| Ausgabeparameter | Typ | BESCHREIBUNG |
|---|---|---|
| Name | string |
Der Name der Funktion. |
| Parameter | string |
Die parameter, die von der Funktion benötigt werden |
| Text | string |
(Null oder mehr) let Anweisungen gefolgt von einem gültigen CSL-Ausdruck, der ausgewertet wird, wenn die Funktion aufgerufen wird |
| Ordner | string |
Ein Ordner, der für die Kategorisierung von UI-Funktionen verwendet wird. Dieser Parameter ändert nicht die Art und Weise, wie die Funktion aufgerufen wird. |
| DocString | string |
Eine Beschreibung der Funktion für UI-Zwecke |
Beispiel
Im folgenden Beispiel wird die Beschreibung (docstring) der Funktion "MyFunction1 " aktualisiert.
.alter function MyFunction1 docstring "Updated docstring"
Output
| Name | Parameter | Text | Ordner | DocString |
|---|---|---|---|---|
| MyFunction2 | (myLimit: long) | {StormEvents | take myLimit} | MyFolder | Aktualisierte Docstring-Datei |