Příkaz .alter function docstring
Platí pro: ✅Microsoft Fabric✅Azure Data Explorer
DocString Změní hodnotu existující funkce.
DocString je volný text, který můžete připojit k tabulce, funkci nebo sloupci popisující entitu. Tento řetězec se zobrazí v různých nastaveních uživatelského prostředí vedle názvů entit.
Poznámka:
Pokud funkce neexistuje, vrátí se chyba. Další informace o tom, jak vytvořit novou funkci, naleznete v tématu .create function.
Oprávnění
Ke spuštění tohoto příkazu musíte mít alespoň oprávnění správce funkce. Objekt zabezpečení, který funkci vytvoří, se automaticky vytvoří jako správce funkce.
Syntaxe
.alterfunction Dokumentace k functionName docstring
Přečtěte si další informace o konvencích syntaxe.
Parametry
| Název | Type | Požadováno | Popis |
|---|---|---|---|
| FunctionName | string |
✔️ | Název funkce, která se má změnit. |
| Dokumentace | string |
✔️ | Nová hodnota řetězce docstring pro funkci. |
Návraty
| Výstupní parametr | Typ | Popis |
|---|---|---|
| Name | string |
Název funkce |
| Parametry | string |
Parametry vyžadované funkcí |
| Text | string |
(Nula nebo více) let příkazy následované platným výrazem CSL, který se vyhodnotí při vyvolání funkce. |
| Složka | string |
Složka používaná pro kategorizaci funkcí uživatelského rozhraní. Tento parametr nemění způsob vyvolání funkce. |
| DocString | string |
Popis funkce pro účely uživatelského rozhraní |
Příklad
Následující příklad aktualizuje popis (docstring) funkce MyFunction1 .
.alter function MyFunction1 docstring "Updated docstring"
Výstup
| Název | Parametry | Text | Složka | DocString |
|---|---|---|---|---|
| MyFunction2 | (myLimit: long) | {StormEvents | take myLimit} | MyFolder | Aktualizace docstringu |