Соглашения о синтаксисе для справочной документации

  • Статья

В этой статье описаны соглашения о синтаксисе, которые следуют в справочной документации по язык запросов Kusto (KQL) и командам управления.

Синтаксические обозначения

Обозначение Описание
Block Строковые литералы, которые нужно ввести точно так, как показано ниже.
Наклонный Параметры, которые должны быть предоставлены при использовании функции или команды.
[ ] Указывает, что вложенный элемент является необязательным.
( ) Указывает, что требуется по крайней мере один из вложенных элементов.
| (канал) Используется в квадратных или круглых скобках для обозначения того, что можно указать один из элементов, разделенных символом канала. В этой форме канал эквивалентен логическому оператору OR. В блоке (|) канал является частью синтаксиса запроса KQL.
[, ...] Указывает, что предыдущий параметр можно повторять несколько раз, разделяя их запятыми.
; Признак конца инструкции запроса.

Примеры

Скалярные функции

В этом примере показан синтаксис и пример использования хэш-функции, а затем объяснение того, как каждый компонент синтаксиса преобразуется в пример использования.

Синтаксис

hash(source [,mod])

Пример использования

hash("World")
  • Имя функции , hashи открываемая круглая скобка вводятся точно так, как показано ниже.
  • "World" передается в качестве аргумента для обязательного параметра source .
  • Аргумент не передается для параметра mod , который является необязательным, как указано в квадратных скобках.
  • Закрывающая скобка вводится точно так, как показано ниже.

Табличный оператор

В этом примере показан синтаксис и пример использования оператора sort, а затем объяснение того, как каждый компонент синтаксиса преобразуется в пример использования.

Синтаксис

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

Пример использования

StormEvents
| sort by State asc, StartTime desc
  • Таблица StormEvents передается в качестве аргумента для обязательного параметра T .
  • | sort by вводится точно так, как показано. В этом случае символ канала является частью синтаксиса оператора табличного выражения , представленного блочный текст. Дополнительные сведения см. в статье Что такое оператор запроса.
  • Столбец State передается в качестве аргумента для обязательного параметра столбца с необязательным asc флагом.
  • После запятой передается другой набор аргументов: столбец StartTime с необязательным desc флагом . Синтаксис [, ...] указывает, что может быть передано больше наборов аргументов, но они не являются обязательными.

Работа с необязательными параметрами

Чтобы указать аргумент для необязательного параметра, который следует за другим необязательным параметром, необходимо указать аргумент для предыдущего параметра. Это требование связано с тем, что аргументы должны соответствовать порядку, указанному в синтаксисе . Если для параметра нет определенного значения, используйте пустое значение того же типа.

Пример последовательных необязательных параметров

Рассмотрим синтаксис подключаемого модуля http_request:

evaluatehttp_request(URI [,RequestHeaders [,Параметры]] )

RequestHeaders и Options являются необязательными параметрами типа dynamic. Чтобы указать аргумент для параметра Options , необходимо также указать аргумент для параметра RequestHeaders . В следующем примере показано, как предоставить пустое значение для первого необязательного параметра RequestHeaders, чтобы иметь возможность указать значение для второго необязательного параметра Options.

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

См. также