Comando .alter function docstring
Aplica-se a: ✅Microsoft Fabric✅Azure Data Explorer
Altera o DocString valor de uma função existente.
DocString é um texto livre que você pode anexar a uma tabela/função/coluna que descreve a entidade. Essa cadeia de caracteres é apresentada em várias configurações de experiência do usuário ao lado dos nomes das entidades.
Observação
Se a função não existir, um erro será retornado. Para obter mais informações sobre como criar uma nova função, consulte .create function.
Permissões
Você deve ter pelo menos permissões de Administrador de Funções para executar esse comando. A entidade de segurança que cria a função é automaticamente transformada em Administrador de Funções.
Sintaxe
.alterfunction Documentação do FunctionName docstring
Saiba mais sobre as convenções de sintaxe.
Parâmetros
| Nome | Digitar | Obrigatória | Descrição |
|---|---|---|---|
| FunctionName | string |
✔️ | O nome da função a ser alterada. |
| Documentação | string |
✔️ | O novo valor docstring para a função. |
Devoluções
| Parâmetro de saída | Tipo | Descrição |
|---|---|---|
| Nome | string |
O nome da função |
| Parâmetros | string |
Os parâmetros exigidos pela função |
| Corpo | string |
(Zero ou mais) let seguidas por uma expressão CSL válida que é avaliada quando a função é invocada |
| Pasta | string |
Uma pasta usada para categorização de funções de interface do usuário. Esse parâmetro não altera a maneira como a função é invocada |
| DocString | string |
Uma descrição da função para fins de interface do usuário |
Exemplo
O exemplo a seguir atualiza a descrição (docstring) da função MyFunction1 .
.alter function MyFunction1 docstring "Updated docstring"
Saída
| Nome | Parâmetros | Corpo | Pasta | DocString |
|---|---|---|---|---|
| MinhaFunção2 | (myLimit: long) | {StormEvents | take myLimit} | MyFolder | Docstring atualizada |