Udostępnij przez

Polecenie docstring funkcji .alter

Dotyczy: ✅Microsoft Fabric✅Azure Data Explorer

DocString Zmienia wartość istniejącej funkcji.

DocString to dowolny tekst, który można dołączyć do tabeli/funkcji/kolumny opisującej jednostkę. Ten ciąg jest wyświetlany w różnych ustawieniach środowiska użytkownika obok nazw jednostek.

Uwaga

Jeśli funkcja nie istnieje, zostanie zwrócony błąd. Aby uzyskać więcej informacji na temat tworzenia nowej funkcji, zobacz .create function.

Uprawnienia

Aby uruchomić to polecenie, musisz mieć co najmniej uprawnienia administratora funkcji. Podmiot zabezpieczeń tworzący funkcję jest automatycznie tworzony jako administrator funkcji.

Składnia

.alterfunction Dokumentacja funkcji FunctionName docstring

Dowiedz się więcej na temat konwencji składni.

Parametry

Nazwisko Type Wymagania opis
Nazwa funkcji string ✔️ Nazwa funkcji do zmiany.
Dokumentacja string ✔️ Nowa wartość docstring dla funkcji.

Zwraca

Parametr wyjściowy Type opis
Nazwa/nazwisko string Nazwa funkcji
Parametry string Parametry wymagane przez funkcję
Treść string (Zero lub więcej) let instrukcje, po których następuje prawidłowe wyrażenie CSL, które jest oceniane podczas wywoływanej funkcji
Folder string Folder używany do kategoryzacji funkcji interfejsu użytkownika. Ten parametr nie zmienia sposobu wywoływana funkcji
DocString string Opis funkcji dla celów interfejsu użytkownika

Przykład

Poniższy przykład aktualizuje opis (docstring) funkcji MyFunction1 .

.alter function MyFunction1 docstring "Updated docstring"

Wyjście

Nazwisko Parametry Treść Folder DocString
MyFunction2 (myLimit: long) {StormEvents | take myLimit} Mójfolder Zaktualizowano dokument
  • Last updated on