Convenções de sintaxe para documentação de referência

  • Artigo

Este artigo descreve as convenções de sintaxe seguidas na documentação de referência Linguagem de Pesquisa Kusto (KQL) e comandos de gestão.

Convenções de sintaxe

Convenção Description
Block Literais de cadeia a introduzir exatamente conforme mostrado.
Itálico Parâmetros a fornecer um valor após a utilização da função ou comando.
[ ] Indica que o item incluído é opcional.
( ) Indica que é necessário, pelo menos, um dos itens incluídos.
| (pipe) Utilizado entre parênteses retos ou redondos para indicar que pode especificar um dos itens separados pelo caráter de pipe. Neste formulário, o pipe é equivalente ao operador OR lógico. Quando está num bloco (|), o pipe faz parte da sintaxe da consulta KQL.
[, ...] Indica que o parâmetro anterior pode ser repetido várias vezes, separado por vírgulas.
; Terminador da instrução de consulta.

Exemplos

Função escalar

Este exemplo mostra a sintaxe e uma utilização de exemplo da função hash, seguida de uma explicação de como cada componente de sintaxe se traduz na utilização de exemplo.

Syntax

hash(origem [,mod])

Utilização de exemplo

hash("World")
  • O nome da função , hashe os parênteses de abertura são introduzidos exatamente conforme mostrado.
  • "World" é transmitido como um argumento para o parâmetro de origem necessário.
  • Não é transmitido nenhum argumento para o parâmetro mod , que é opcional conforme indicado pelos parênteses retos.
  • Os parênteses de fecho são introduzidos exatamente conforme mostrado.

Operador tabular

Este exemplo mostra a sintaxe e uma utilização de exemplo do operador de ordenação, seguido de uma explicação de como cada componente de sintaxe se traduz na utilização de exemplo.

Syntax

T| sort bycoluna [asc | desc] [nulls first | nulls last] [, ...]

Utilização de exemplo

StormEvents
| sort by State asc, StartTime desc
  • A tabela StormEvents é transmitida como um argumento para o parâmetro T necessário.
  • | sort by é introduzido exatamente conforme mostrado. Neste caso, o caráter de pipe faz parte da sintaxe da instrução de expressão tabular , representada pelo texto de bloco. Para saber mais, veja O que é uma instrução de consulta.
  • A coluna Estado é transmitida como um argumento para o parâmetro de coluna necessário com o sinalizador opcional asc .
  • Depois de uma vírgula, é transmitido outro conjunto de argumentos: a coluna StartTime com o sinalizador opcional desc . A sintaxe [, ...] indica que podem ser transmitidos mais conjuntos de argumentos, mas não são necessários.

Trabalhar com parâmetros opcionais

Para fornecer um argumento para um parâmetro opcional que vem atrás de outro parâmetro opcional, tem de fornecer um argumento para o parâmetro anterior. Este requisito deve-se ao facto de os argumentos terem de seguir a ordem especificada na sintaxe. Se não tiver um valor específico para transmitir para o parâmetro, utilize um valor vazio do mesmo tipo.

Exemplo de parâmetros opcionais sequenciais

Considere a sintaxe do plug-in http_request:

evaluatehttp_request(Uri [,RequestHeaders [,Opções]] )

RequestHeaders e Opções são parâmetros opcionais do tipo dinâmico. Para fornecer um argumento para o parâmetro Opções , também tem de fornecer um argumento para o parâmetro RequestHeaders . O exemplo seguinte mostra como fornecer um valor vazio para o primeiro parâmetro opcional, RequestHeaders, para poder especificar um valor para o segundo parâmetro opcional, Opções.

evaluate http_request ( "https://contoso.com/", dynamic({}), dynamic({ EmployeeName: Nicole }) )

Conteúdo relacionado