Comando .alter function docstring

Mude de serviço usando a lista suspensa de Versões . Saiba mais sobre navegação.
Aplica-se a: ✅ Microsoft Fabric ✅ Azure Data Explorer

Altera o DocString valor de uma função existente.

DocString é texto livre que podes anexar a uma tabela/função/coluna que descreve a entidade. Esta cadeia é apresentada em várias definições de UX ao lado dos nomes das entidades.

Observação

Se a função não existir, é devolto um erro. Para mais informações sobre como criar uma nova função, veja .create function.

Permissions

Deves ter pelo menos permissões de Administrador de Função para executar este comando. O principal que cria a função é automaticamente criado como Administrador de Funções.

Sintaxe

.alter function Função NomedocstringDocumentação

Saiba mais sobre convenções de sintaxe.

Parâmetros

Nome Tipo Obrigatório Description
Nome da função string ✔️ O nome da função a alterar.
Documentação string ✔️ O novo valor docstring para a função.

Devoluções

Parâmetro de saída Tipo Description
Nome string O nome da função
Parâmetros string Os parâmetros exigidos pela função
Body string (Zero ou mais) let instruções seguidas por uma expressão CSL válida que é avaliada quando a função é invocada
Folder string Uma pasta usada para categorização de funções de interface. Este parâmetro não altera a forma como a função é invocada
DocString string Uma descrição da função para fins de UI

Example

O exemplo seguinte atualiza a descrição (docstring) da função MyFunction1 .

.alter function MyFunction1 docstring "Updated docstring"

Output

Nome Parâmetros Body Folder DocString
MyFunction2 (myLimit: longo) {StormEvents | take myLimit} MyFolder Docstring atualizado