Описание функций

Описание SRL-функций разделено на несколько глав в зависимости от её назначения:

О типах аргументов

Функция может принимать значения определенного типа (типов), что указано в описании функции. Типы значений функций соответствуют из типам колонок PolyAnalyst.

Типы колонок PolyAnalyst не всегда соответствуют названиям типов данных в распространенных языках программирования, например, Булево значение выражается в виде колонки типа Да/Нет (Yes/No).

Например:

имя_функции(yes/no)

будет требовать использования "yes/no" или "True/False" при написании функции, однако колонка с результатами всегда будет отображаться только с использованием значений "да/нет" (вы никогда не увидите "True" или "False" в результатах узлов).

О значениях аргументов

Описание функций соответствует структуре имя_функции(некоторое значение), при этом необходимо помнить, что большинство SRL-функций могут принимать не только литерал (т.е. конкректное значение), но и целую колонку (т.е. все значения колонки).

Например:

upper("usa")

вернет "USA".

Например:

upper([USA])

возвращает все значения колонки USA в верхнем регистре.

Обратите внимание, что имя колонки всегда рекомендуется указывать в квадратных скобках, например: [имя используемой колонки].

О необязательных аргументах

Некоторые функции принимают необязательные аргументы. Если аргумент необязателен, он будет показан в квадратных скобках:

num(строка или текст[, language:=])

Обратите внимание, что в этом случае квадратные скобки показывают только необязательность аргументов. При написании реального запроса их нужно убрать:

num("1234", language:=eng)

Однако если в качестве обязательного аргумента вы используете колонку, то имя колонки всегда рекомендуется указывать в квадратных скобках:

num([имя колонки], language:=eng)

В этом случае функция будет применена ко всем строкам переданной колонки.

Об аргументах типа Дата/время

Обратите внимание, что значения типа Дата/время, используемые для работы с Датой/временем, приведены в виде литералов только для наглядности.

Например в функции

day(#2001-01-18#)

используется формат #год-месяц-день.

Но вы всегда можете использовать колонку типа Дата/время вместо конкретного значения.

Например в функции

day([колонка с датой и временем])

используется формат [название колонки] для обработки всех строк указанной колонки.

О значениях, возвращаемых функциями

Если возвращаемое значение является Текстовым или Строковым, оно будет указано с использованием кавычек (также только для наглядности). Однако при написании Строковых и Текстовых литералов, наличие кавычек обязательно.

Например:

trim("2WordMS",digit:=yes) возвращает "WordMS"

Обратите внимание, что в итоговой таблице такое возвращаемое значение будет показано без кавычек.

О функциях SRL/PDL с одинаковыми названиями

Обратите внимание, что такие SRL-функции, как andn(), orn() и macro(), отличаются от таковых в PDL, хотя и имеют одинаковые с ними названия.