Команда .alter function docstring
Область применения: ✅Microsoft Fabric✅Azure Data Explorer
Изменяет DocString значение существующей функции.
DocString — это свободный текст, который можно вложить в таблицу или функцию или столбец, описывающий сущность. Эта строка представлена в различных параметрах пользовательского интерфейса рядом с именами сущностей.
Примечание.
Если функция не существует, возвращается ошибка. Дополнительные сведения о создании новой функции см. в статье .create function.
Разрешения
Для выполнения этой команды необходимо иметь по крайней мере разрешения администратора функций. Субъект, создающий функцию, автоматически создается администратором функции.
Синтаксис
.alterfunction docstring Документация по имени функции
Дополнительные сведения о соглашениях синтаксиса.
Параметры
| Имя (название) | Type | Обязательно | Описание |
|---|---|---|---|
| Имя функции | string |
✔️ | Имя функции для изменения. |
| Документация | string |
✔️ | Новое значение документации для функции. |
Возвраты
| Выходной параметр | Тип | Description |
|---|---|---|
| Имя. | string |
Имя функции |
| Параметры | string |
Параметры, необходимые функции |
| Текст | string |
(Ноль или больше) let операторы, за которым следует допустимое выражение CSL, вычисляемое при вызове функции |
| Папка | string |
Папка, используемая для классификации функций пользовательского интерфейса. Этот параметр не изменяет способ вызова функции |
| DocString | string |
Описание функции для целей пользовательского интерфейса |
Пример
В следующем примере обновляется описание функцииdocstring MyFunction1.
.alter function MyFunction1 docstring "Updated docstring"
Выходные данные
| Имя. | Параметры | Текст | Папка | DocString |
|---|---|---|---|---|
| MyFunction2 | (myLimit: long) | {StormEvents | take myLimit} | MyFolder | Обновленная документация |