Команда .alter function docstring

Изменяет DocString значение существующей функции.

DocString — это свободный текст, который можно прикрепить к таблице, функции или столбцу, описывающей сущность. Эта строка представлена в различных параметрах пользовательского интерфейса рядом с именами сущностей.

Примечание

Если функция не существует, возвращается ошибка. Дополнительные сведения о создании новой функции см. в разделе .create function.

Разрешения

Для выполнения этой команды необходимо иметь по крайней мере разрешения Администратор функции. Субъект, создающий функцию, автоматически становится Администратор функции.

Синтаксис

.alterfunctionFunctionNamedocstringДокументации

Дополнительные сведения о соглашениях о синтаксисе.

Параметры

Имя	Тип	Обязательно	Описание
FunctionName	string	✔️	Имя изменяемой функции.
Документация	string	✔️	Новое значение docstring для функции.

Возвращаемое значение

Выходной параметр	Тип	Описание
Имя	string	Имя функции
Параметры	string	Параметры, необходимые для функции
Текст	string	(Ноль или более) let инструкции, за которыми следует допустимое выражение CSL, которое вычисляется при вызове функции
Папка	string	Папка, используемая для классификации функций пользовательского интерфейса. Этот параметр не изменяет способ вызова функции
DocString	string	Описание функции для целей пользовательского интерфейса

Пример

.alter function MyFunction1 docstring "Updated docstring"

Выходные данные

Название	Параметры	Текст	Папка	DocString
MyFunction2	(myLimit: long)	{StormEvents | take myLimit}	MyFolder	Обновлена строка документа