Команда .create-or-alter function

  • Статья

Создает хранимую функцию или изменяет существующую функцию и сохраняет ее в метаданных базы данных.

Правила для типов параметров и инструкций CSL такие же, как и для операторов let.

Разрешения

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

Синтаксис

.create-or-alterfunction [ with(propertyName=propertyValue [, ...])] functionName(Параметры){Тела}

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

Параметры

Имя Тип Обязательно Описание
functionName string ✔️ Имя создаваемой или изменяемой функции.
propertyName, propertyValue string Разделенный запятыми список пар свойств "ключ-значение". См. раздел Поддерживаемые свойства.
parameters string Разделенный запятыми список параметров, необходимых для функции. Формат каждого параметра должен иметь формат ParameterName:ParameterDataType.
body string ✔️ Ноль или более let операторов, за которыми следует допустимое выражение CSL, которое вычисляется при вызове функции.

Примечание

Если функция с указанным functionName не существует в метаданных базы данных, команда создает новую функцию. В противном случае эта функция будет изменена.

Поддерживаемые свойства

Имя Тип Описание
docstring string Описание функции в целях пользовательского интерфейса.
folder string Имя папки, используемой для классификации функций пользовательского интерфейса.

Пример

.create-or-alter function with (docstring = 'Demo function with parameter', folder='MyFolder') TestFunction(myLimit:int)
{
    StormEvents | take myLimit 
}

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

Название Параметры Текст Папка DocString
TestFunction (myLimit:int) { StormEvents | take myLimit } MyFolder Демонстрация функции с параметром