Skip to main content

ETL Functions

ETL functions help you transform, clean, and format target-field values while creating a replication task. On the mapping page, you can write field expressions for target columns to handle common text, numeric, date, and JSON operations.

Entry

When you create or edit a replication task, configure ETL expressions in Configuration Mapping > Mapping and Filtering > Field Expression.

Writing Rules

  • ETL expressions only work on target columns that already exist. You cannot add new target columns on this page.
  • The expression result must be compatible with the target column type. Otherwise, the task may fail to write data correctly.
  • Source columns can be referenced directly by name, for example name, amount, or created_at.
  • String literals are typically written in single quotes such as 'demo'; numbers and booleans can be written directly as 1 or true.
  • If you are unsure which form to choose, start with the simplest overload with fewer arguments.
  • Field names in the examples are placeholders. Replace them with your own source columns.

How To Read This Catalog

  • The catalog is grouped by function name and includes 232 user-facing functions with 324 documented forms.
  • Different overloads of the same function are shown together so you can compare them in one place.
  • Internal helper forms are intentionally hidden to keep the catalog practical for everyday use.

Common Examples

  • Remove leading and trailing spaces: trimtoempty(name)
  • Convert text to uppercase: uppercase(code)
  • Get the absolute value: math_abs(amount)
  • Read a key from JSON: json_getstring(ext_json,'name')
  • Build a JSON object: json_object('name',name,'amount',amount)

Function Catalog

String Functions (148)

abbreviate

Purpose

Shorten text to a maximum length.

Recommended Example

abbreviate(product_name,20)

Supported FormHow To Fill The Arguments
abbreviate(String,int)Argument 1 is the source text to abbreviate; Argument 2 is the maximum length to keep.
abbreviate(String,String,int)Argument 1 is the source text to abbreviate; Argument 2 is the marker shown during abbreviation, for example '...'; Argument 3 is the maximum length to keep.
abbreviate(String,int,int)Argument 1 is the source text to abbreviate; Argument 2 is the position from which content should be kept; Argument 3 is the maximum length to keep.
abbreviate(String,String,int,int)Argument 1 is the source text to abbreviate; Argument 2 is the marker shown during abbreviation, for example '...'; Argument 3 is the position from which content should be kept; Argument 4 is the maximum length to keep.

abbreviatemiddle

Purpose

Keep the beginning and the end, and shorten the middle part.

Recommended Example

abbreviatemiddle(order_no,'...',12)

Supported FormHow To Fill The Arguments
abbreviatemiddle(String,String,int)Argument 1 is the source text; Argument 2 is the middle replacement marker, for example '...'; Argument 3 is the final total length to keep.

appendifmissing

Purpose

Add a prefix or suffix only when it is missing.

Recommended Example

appendifmissing(name,'demo','demo')

Supported FormHow To Fill The Arguments
appendifmissing(String,CharSequence,CharSequence)Argument 1 is the source text; Argument 2 is the suffix to add when it is missing; Argument 3 is an extra suffix that should also count as already present.
appendifmissing(String,CharSequence,boolean,CharSequence)Argument 1 is the source text; Argument 2 is the suffix to add when it is missing; Argument 3 is whether the check should ignore case; Argument 4 is an extra suffix that should also count as already present.

appendifmissingignorecase

Purpose

Add a prefix or suffix only when it is missing.

Recommended Example

appendifmissingignorecase(name,'demo','demo')

Supported FormHow To Fill The Arguments
appendifmissingignorecase(String,CharSequence,CharSequence)Argument 1 is the source text; Argument 2 is the suffix to add when it is missing; Argument 3 is an extra suffix that should also count as already present.

capitalize

Purpose

Convert the first letter to uppercase.

Recommended Example

capitalize(name)

Supported FormHow To Fill The Arguments
capitalize(String)Argument 1 is the source text.

center

Purpose

Pad text to a target length and center it.

Recommended Example

center(code,10,'0')

Supported FormHow To Fill The Arguments
center(String,int)Argument 1 is the source text; Argument 2 is the target length.
center(String,int,String)Argument 1 is the source text; Argument 2 is the target length; Argument 3 is the character or text used for padding.
center(String,int,char)Argument 1 is the source text; Argument 2 is the target length; Argument 3 is the character or text used for padding.

chomp

Purpose

Apply the chomp text operation.

Recommended Example

chomp(name)

Supported FormHow To Fill The Arguments
chomp(String)Argument 1 is the parameter written as a String value.
chomp(String,String)Argument 1 and Argument 2 are parameters written as String values.

chop

Purpose

Apply the chop text operation.

Recommended Example

chop(name)

Supported FormHow To Fill The Arguments
chop(String)Argument 1 is the parameter written as a String value.

compare

Purpose

Apply the compare text operation.

Recommended Example

compare(name,'demo')

Supported FormHow To Fill The Arguments
compare(String,String)Argument 1 is the first text value to compare; Argument 2 is the second text value to compare.
compare(String,String,boolean)Argument 1 is the first text value to compare; Argument 2 is the second text value to compare; Argument 3 is the switch that controls how null values are treated.

compareignorecase

Purpose

Apply the compareignorecase text operation.

Recommended Example

compareignorecase(name,'demo')

Supported FormHow To Fill The Arguments
compareignorecase(String,String)Argument 1 is the first text value to compare; Argument 2 is the second text value to compare.
compareignorecase(String,String,boolean)Argument 1 is the first text value to compare; Argument 2 is the second text value to compare; Argument 3 is the switch that controls how null values are treated.

concat

Purpose

Concatenate text values in order.

Recommended Example

concat(first_name,last_name)

Supported FormHow To Fill The Arguments
concat(String value1, String value2)Argument 1 is the first text value to join; Argument 2 is the second text value to join.

contains

Purpose

Check whether the text meets the requested match rule.

Recommended Example

contains(remark,'urgent')

Supported FormHow To Fill The Arguments
contains(CharSequence,CharSequence)Argument 1 is the text to check; Argument 2 is the target character, fragment, or candidate content.

containsany

Purpose

Check whether the text meets the requested match rule.

Recommended Example

containsany(name,'demo')

Supported FormHow To Fill The Arguments
containsany(CharSequence,CharSequence)Argument 1 is the text to check; Argument 2 is the target character, fragment, or candidate content.
containsany(CharSequence,char)Argument 1 is the text to check; Argument 2 is the target character, fragment, or candidate content.

containsanyignorecase

Purpose

Check whether the text meets the requested match rule.

Recommended Example

containsanyignorecase(name,'demo')

Supported FormHow To Fill The Arguments
containsanyignorecase(CharSequence,CharSequence)Argument 1 is the text to check; Argument 2 is the target character, fragment, or candidate content.

containsignorecase

Purpose

Check whether the text meets the requested match rule.

Recommended Example

containsignorecase(name,'demo')

Supported FormHow To Fill The Arguments
containsignorecase(CharSequence,CharSequence)Argument 1 is the text to check; Argument 2 is the target character, fragment, or candidate content.

containsnone

Purpose

Check whether the text meets the requested match rule.

Recommended Example

containsnone(name,'demo')

Supported FormHow To Fill The Arguments
containsnone(CharSequence,String)Argument 1 is the text to check; Argument 2 is the set of characters used for the check.
containsnone(CharSequence,char)Argument 1 is the text to check; Argument 2 is the set of characters used for the check.

containsonly

Purpose

Check whether the text meets the requested match rule.

Recommended Example

containsonly(name,'demo')

Supported FormHow To Fill The Arguments
containsonly(CharSequence,String)Argument 1 is the text to check; Argument 2 is the set of characters used for the check.
containsonly(CharSequence,char)Argument 1 is the text to check; Argument 2 is the set of characters used for the check.

containswhitespace

Purpose

Check whether the text meets the requested match rule.

Recommended Example

containswhitespace(name)

Supported FormHow To Fill The Arguments
containswhitespace(CharSequence)Argument 1 is the text to check.

countmatches

Purpose

Count how many times a character or fragment appears.

Recommended Example

countmatches(code,'-')

Supported FormHow To Fill The Arguments
countmatches(CharSequence,CharSequence)Argument 1 is the text to count in; Argument 2 is the character or fragment to count.
countmatches(CharSequence,char)Argument 1 is the text to count in; Argument 2 is the character or fragment to count.

defaultifblank

Purpose

Return a fallback value when the text is blank.

Recommended Example

defaultifblank(nickname,'anonymous')

Supported FormHow To Fill The Arguments
defaultifblank(CharSequence,CharSequence)Argument 1 is the source text; Argument 2 is the fallback text returned when the source value is empty.

defaultifempty

Purpose

Return a fallback value when the text is empty.

Recommended Example

defaultifempty(email,'unknown@example.com')

Supported FormHow To Fill The Arguments
defaultifempty(CharSequence,CharSequence)Argument 1 is the source text; Argument 2 is the fallback text returned when the source value is empty.

defaultstring

Purpose

Convert a null value into a safe string.

Recommended Example

defaultstring(name)

Supported FormHow To Fill The Arguments
defaultstring(String)Argument 1 is the source text.
defaultstring(String,String)Argument 1 is the source text; Argument 2 is the fallback text returned when the source value is empty.

deletewhitespace

Purpose

Remove all whitespace characters.

Recommended Example

deletewhitespace(phone)

Supported FormHow To Fill The Arguments
deletewhitespace(String)Argument 1 is the source text.

difference

Purpose

Return the part that becomes different after the first mismatch.

Recommended Example

difference(name,'demo')

Supported FormHow To Fill The Arguments
difference(String,String)Argument 1 is the first text value; Argument 2 is the second text value.

endswith

Purpose

Check whether the text meets the requested match rule.

Recommended Example

endswith(file_name,'.csv')

Supported FormHow To Fill The Arguments
endswith(CharSequence,CharSequence)Argument 1 is the text to check; Argument 2 is the prefix, suffix, or candidate fragment to match.
endswith(CharSequence,CharSequence,boolean)Argument 1 is the text to check; Argument 2 is the prefix, suffix, or candidate fragment to match; Argument 3 is whether the match should ignore case.

endswithany

Purpose

Check whether the text meets the requested match rule.

Recommended Example

endswithany(name,'demo')

Supported FormHow To Fill The Arguments
endswithany(CharSequence,CharSequence)Argument 1 is the text to check; Argument 2 is the prefix, suffix, or candidate fragment to match.

endswithignorecase

Purpose

Check whether the text meets the requested match rule.

Recommended Example

endswithignorecase(name,'demo')

Supported FormHow To Fill The Arguments
endswithignorecase(CharSequence,CharSequence)Argument 1 is the text to check; Argument 2 is the prefix, suffix, or candidate fragment to match.

equals

Purpose

Check whether the text meets the requested match rule.

Recommended Example

equals(status,'done')

Supported FormHow To Fill The Arguments
equals(CharSequence,CharSequence)Argument 1 is the first text value; Argument 2 is the second text value.

equalsany

Purpose

Check whether the text meets the requested match rule.

Recommended Example

equalsany(name,'demo')

Supported FormHow To Fill The Arguments
equalsany(CharSequence,CharSequence)Argument 1 is the text to compare; Argument 2 is the candidate value or fragment.

equalsanyignorecase

Purpose

Check whether the text meets the requested match rule.

Recommended Example

equalsanyignorecase(name,'demo')

Supported FormHow To Fill The Arguments
equalsanyignorecase(CharSequence,CharSequence)Argument 1 is the text to compare; Argument 2 is the candidate value or fragment.

equalsignorecase

Purpose

Check whether the text meets the requested match rule.

Recommended Example

equalsignorecase(name,'demo')

Supported FormHow To Fill The Arguments
equalsignorecase(CharSequence,CharSequence)Argument 1 is the first text value; Argument 2 is the second text value.

firstnonblank

Purpose

Apply the firstnonblank text operation.

Recommended Example

firstnonblank(name)

Supported FormHow To Fill The Arguments
firstnonblank(CharSequence)Argument 1 is a list of text values processed in order.

firstnonempty

Purpose

Apply the firstnonempty text operation.

Recommended Example

firstnonempty(name)

Supported FormHow To Fill The Arguments
firstnonempty(CharSequence)Argument 1 is a list of text values processed in order.

getbytes

Purpose

Read or calculate a value from the input text.

Recommended Example

getbytes(name,'UTF-8')

Supported FormHow To Fill The Arguments
getbytes(String,Charset)Argument 1 is the source text; Argument 2 is the charset name, for example 'UTF-8'.
getbytes(String,String)Argument 1 is the source text; Argument 2 is the charset name, for example 'UTF-8'.

getcommonprefix

Purpose

Read or calculate a value from the input text.

Recommended Example

getcommonprefix(name)

Supported FormHow To Fill The Arguments
getcommonprefix(String)Argument 1 is a list of text values processed in order.

getdigits

Purpose

Extract only the digit characters.

Recommended Example

getdigits(order_code)

Supported FormHow To Fill The Arguments
getdigits(String)Argument 1 is the source text that contains digits.

getfuzzydistance

Purpose

Read or calculate a value from the input text.

Recommended Example

getfuzzydistance(name,'demo','zh_CN')

Supported FormHow To Fill The Arguments
getfuzzydistance(CharSequence,CharSequence,Locale)Argument 1 is the first text value; Argument 2 is the second text value; Argument 3 is the locale used for comparison, for example 'zh_CN'.

getjarowinklerdistance

Purpose

Read or calculate a value from the input text.

Recommended Example

getjarowinklerdistance(name,'demo')

Supported FormHow To Fill The Arguments
getjarowinklerdistance(CharSequence,CharSequence)Argument 1 is the first text value; Argument 2 is the second text value.

getlevenshteindistance

Purpose

Read or calculate a value from the input text.

Recommended Example

getlevenshteindistance(name,'demo')

Supported FormHow To Fill The Arguments
getlevenshteindistance(CharSequence,CharSequence)Argument 1 is the first text value; Argument 2 is the second text value.
getlevenshteindistance(CharSequence,CharSequence,int)Argument 1 is the first text value; Argument 2 is the second text value; Argument 3 is the maximum allowed edit distance.

indexof

Purpose

Find where the target content appears.

Recommended Example

indexof(email,'@')

Supported FormHow To Fill The Arguments
indexof(CharSequence,CharSequence)Argument 1 is the source text; Argument 2 is the character or fragment to search for.
indexof(CharSequence,int)Argument 1 is the source text; Argument 2 is the character or fragment to search for.
indexof(CharSequence,CharSequence,int)Argument 1 is the source text; Argument 2 is the character or fragment to search for; Argument 3 is the position from which the search should start.
indexof(CharSequence,int,int)Argument 1 is the source text; Argument 2 is the character or fragment to search for; Argument 3 is the position from which the search should start.

indexofany

Purpose

Find where the target content appears.

Recommended Example

indexofany(name,'demo')

Supported FormHow To Fill The Arguments
indexofany(CharSequence,CharSequence)Argument 1 is the source text; Argument 2 is the character or fragment to search for.
indexofany(CharSequence,String)Argument 1 is the source text; Argument 2 is the character or fragment to search for.
indexofany(CharSequence,char)Argument 1 is the source text; Argument 2 is the character or fragment to search for.

indexofanybut

Purpose

Find where the target content appears.

Recommended Example

indexofanybut(name,'demo')

Supported FormHow To Fill The Arguments
indexofanybut(CharSequence,CharSequence)Argument 1 is the source text; Argument 2 is the character or fragment to search for.
indexofanybut(CharSequence,char)Argument 1 is the source text; Argument 2 is the character or fragment to search for.

indexofdifference

Purpose

Find where the target content appears.

Recommended Example

indexofdifference(name)

Supported FormHow To Fill The Arguments
indexofdifference(CharSequence)Argument 1 is the source text; Argument 2 is the character or fragment to search for.
indexofdifference(CharSequence,CharSequence)Argument 1 is the source text; Argument 2 is the character or fragment to search for.

indexofignorecase

Purpose

Find where the target content appears.

Recommended Example

indexofignorecase(name,'demo')

Supported FormHow To Fill The Arguments
indexofignorecase(CharSequence,CharSequence)Argument 1 is the source text; Argument 2 is the character or fragment to search for.
indexofignorecase(CharSequence,CharSequence,int)Argument 1 is the source text; Argument 2 is the character or fragment to search for; Argument 3 is the position from which the search should start.

isallblank

Purpose

Check whether the text meets the requested condition.

Recommended Example

isallblank(name)

Supported FormHow To Fill The Arguments
isallblank(CharSequence)Argument 1 is the text to evaluate.

isallempty

Purpose

Check whether the text meets the requested condition.

Recommended Example

isallempty(name)

Supported FormHow To Fill The Arguments
isallempty(CharSequence)Argument 1 is the text to evaluate.

isalllowercase

Purpose

Check whether the text meets the requested condition.

Recommended Example

isalllowercase(name)

Supported FormHow To Fill The Arguments
isalllowercase(CharSequence)Argument 1 is the text to evaluate.

isalluppercase

Purpose

Check whether the text meets the requested condition.

Recommended Example

isalluppercase(name)

Supported FormHow To Fill The Arguments
isalluppercase(CharSequence)Argument 1 is the text to evaluate.

isalpha

Purpose

Check whether the text meets the requested condition.

Recommended Example

isalpha(name)

Supported FormHow To Fill The Arguments
isalpha(CharSequence)Argument 1 is the text to evaluate.

isalphanumeric

Purpose

Check whether the text meets the requested condition.

Recommended Example

isalphanumeric(name)

Supported FormHow To Fill The Arguments
isalphanumeric(CharSequence)Argument 1 is the text to evaluate.

isalphanumericspace

Purpose

Check whether the text meets the requested condition.

Recommended Example

isalphanumericspace(name)

Supported FormHow To Fill The Arguments
isalphanumericspace(CharSequence)Argument 1 is the text to evaluate.

isalphaspace

Purpose

Check whether the text meets the requested condition.

Recommended Example

isalphaspace(name)

Supported FormHow To Fill The Arguments
isalphaspace(CharSequence)Argument 1 is the text to evaluate.

isanyblank

Purpose

Check whether the text meets the requested condition.

Recommended Example

isanyblank(name)

Supported FormHow To Fill The Arguments
isanyblank(CharSequence)Argument 1 is the text to evaluate.

isanyempty

Purpose

Check whether the text meets the requested condition.

Recommended Example

isanyempty(name)

Supported FormHow To Fill The Arguments
isanyempty(CharSequence)Argument 1 is the text to evaluate.

isasciiprintable

Purpose

Check whether the text meets the requested condition.

Recommended Example

isasciiprintable(name)

Supported FormHow To Fill The Arguments
isasciiprintable(CharSequence)Argument 1 is the text to evaluate.

isblank

Purpose

Check whether the text meets the requested condition.

Recommended Example

isblank(name)

Supported FormHow To Fill The Arguments
isblank(CharSequence)Argument 1 is the text to evaluate.

isempty

Purpose

Check whether the text meets the requested condition.

Recommended Example

isempty(name)

Supported FormHow To Fill The Arguments
isempty(CharSequence)Argument 1 is the text to evaluate.

ismixedcase

Purpose

Check whether the text meets the requested condition.

Recommended Example

ismixedcase(name)

Supported FormHow To Fill The Arguments
ismixedcase(CharSequence)Argument 1 is the text to evaluate.

isnoneblank

Purpose

Check whether the text meets the requested condition.

Recommended Example

isnoneblank(name)

Supported FormHow To Fill The Arguments
isnoneblank(CharSequence)Argument 1 is the text to evaluate.

isnoneempty

Purpose

Check whether the text meets the requested condition.

Recommended Example

isnoneempty(name)

Supported FormHow To Fill The Arguments
isnoneempty(CharSequence)Argument 1 is the text to evaluate.

isnotblank

Purpose

Check whether the text meets the requested condition.

Recommended Example

isnotblank(name)

Supported FormHow To Fill The Arguments
isnotblank(CharSequence)Argument 1 is the text to evaluate.

isnotempty

Purpose

Check whether the text meets the requested condition.

Recommended Example

isnotempty(name)

Supported FormHow To Fill The Arguments
isnotempty(CharSequence)Argument 1 is the text to evaluate.

isnumeric

Purpose

Check whether the text meets the requested condition.

Recommended Example

isnumeric(name)

Supported FormHow To Fill The Arguments
isnumeric(CharSequence)Argument 1 is the text to evaluate.

isnumericspace

Purpose

Check whether the text meets the requested condition.

Recommended Example

isnumericspace(name)

Supported FormHow To Fill The Arguments
isnumericspace(CharSequence)Argument 1 is the text to evaluate.

iswhitespace

Purpose

Check whether the text meets the requested condition.

Recommended Example

iswhitespace(name)

Supported FormHow To Fill The Arguments
iswhitespace(CharSequence)Argument 1 is the text to evaluate.

join

Purpose

Join a list of values into one string.

Recommended Example

join(tag_list,',')

Supported FormHow To Fill The Arguments
join(Object)Argument 1 is the list of values to join.
join(Iterable,char)Argument 1 is the list of values to join; Argument 2 is the separator; use the simpler form when no separator is needed.
join(boolean,char)Argument 1 is the list of values to join; Argument 2 is the separator; use the simpler form when no separator is needed.
join(byte,char)Argument 1 is the list of values to join; Argument 2 is the separator; use the simpler form when no separator is needed.
join(char,char)Argument 1 is the list of values to join; Argument 2 is the separator; use the simpler form when no separator is needed.
join(double,char)Argument 1 is the list of values to join; Argument 2 is the separator; use the simpler form when no separator is needed.
join(float,char)Argument 1 is the list of values to join; Argument 2 is the separator; use the simpler form when no separator is needed.
join(int,char)Argument 1 is the list of values to join; Argument 2 is the separator; use the simpler form when no separator is needed.
join(long,char)Argument 1 is the list of values to join; Argument 2 is the separator; use the simpler form when no separator is needed.
join(short,char)Argument 1 is the list of values to join; Argument 2 is the separator; use the simpler form when no separator is needed.
join(List,String,int,int)Argument 1 is the list of values to join; Argument 2 is the separator; use the simpler form when no separator is needed; Argument 3 is the index at which joining should start; Argument 4 is the index at which joining should stop.
join(boolean,char,int,int)Argument 1 is the list of values to join; Argument 2 is the separator; use the simpler form when no separator is needed; Argument 3 is the index at which joining should start; Argument 4 is the index at which joining should stop.
join(byte,char,int,int)Argument 1 is the list of values to join; Argument 2 is the separator; use the simpler form when no separator is needed; Argument 3 is the index at which joining should start; Argument 4 is the index at which joining should stop.
join(char,char,int,int)Argument 1 is the list of values to join; Argument 2 is the separator; use the simpler form when no separator is needed; Argument 3 is the index at which joining should start; Argument 4 is the index at which joining should stop.
join(double,char,int,int)Argument 1 is the list of values to join; Argument 2 is the separator; use the simpler form when no separator is needed; Argument 3 is the index at which joining should start; Argument 4 is the index at which joining should stop.
join(float,char,int,int)Argument 1 is the list of values to join; Argument 2 is the separator; use the simpler form when no separator is needed; Argument 3 is the index at which joining should start; Argument 4 is the index at which joining should stop.
join(int,char,int,int)Argument 1 is the list of values to join; Argument 2 is the separator; use the simpler form when no separator is needed; Argument 3 is the index at which joining should start; Argument 4 is the index at which joining should stop.
join(short,char,int,int)Argument 1 is the list of values to join; Argument 2 is the separator; use the simpler form when no separator is needed; Argument 3 is the index at which joining should start; Argument 4 is the index at which joining should stop.

lastindexof

Purpose

Find where the target content appears.

Recommended Example

lastindexof(name,'demo')

Supported FormHow To Fill The Arguments
lastindexof(CharSequence,CharSequence)Argument 1 is the source text; Argument 2 is the character or fragment to search for.
lastindexof(CharSequence,int)Argument 1 is the source text; Argument 2 is the character or fragment to search for.
lastindexof(CharSequence,CharSequence,int)Argument 1 is the source text; Argument 2 is the character or fragment to search for; Argument 3 is the position from which the search should start.
lastindexof(CharSequence,int,int)Argument 1 is the source text; Argument 2 is the character or fragment to search for; Argument 3 is the position from which the search should start.

lastindexofany

Purpose

Find where the target content appears.

Recommended Example

lastindexofany(name,'demo')

Supported FormHow To Fill The Arguments
lastindexofany(CharSequence,CharSequence)Argument 1 is the source text; Argument 2 is the character or fragment to search for.

lastindexofignorecase

Purpose

Find where the target content appears.

Recommended Example

lastindexofignorecase(name,'demo')

Supported FormHow To Fill The Arguments
lastindexofignorecase(CharSequence,CharSequence)Argument 1 is the source text; Argument 2 is the character or fragment to search for.
lastindexofignorecase(CharSequence,CharSequence,int)Argument 1 is the source text; Argument 2 is the character or fragment to search for; Argument 3 is the position from which the search should start.

lastordinalindexof

Purpose

Find where the target content appears.

Recommended Example

lastordinalindexof(name,'demo',1)

Supported FormHow To Fill The Arguments
lastordinalindexof(CharSequence,CharSequence,int)Argument 1 is the source text; Argument 2 is the target fragment to search for; Argument 3 is which occurrence should be located.

left

Purpose

Keep the leftmost part of the text.

Recommended Example

left(order_no,8)

Supported FormHow To Fill The Arguments
left(String,int)Argument 1 is the source text; Argument 2 is the length to keep or the starting position.

leftpad

Purpose

Apply the leftpad text operation.

Recommended Example

leftpad(name,1)

Supported FormHow To Fill The Arguments
leftpad(String,int)Argument 1 is the source text; Argument 2 is the target length.
leftpad(String,int,String)Argument 1 is the source text; Argument 2 is the target length; Argument 3 is the character or text used for padding.
leftpad(String,int,char)Argument 1 is the source text; Argument 2 is the target length; Argument 3 is the character or text used for padding.

length

Purpose

Return the text length.

Recommended Example

length(name)

Supported FormHow To Fill The Arguments
length(CharSequence)Argument 1 is the source text.

like

Purpose

Check whether the text matches a LIKE pattern.

Recommended Example

like(code,'A%')

Supported FormHow To Fill The Arguments
like(String,String)Argument 1 is the source text to match; Argument 2 is the LIKE pattern, for example 'A%' or '__01'.
like(ValueObject,ValueObject)Argument 1 is the source text to match; Argument 2 is the LIKE pattern, for example 'A%' or '__01'.

lowercase

Purpose

Convert text to lowercase.

Recommended Example

lowercase(email)

Supported FormHow To Fill The Arguments
lowercase(String)Argument 1 is the source text.

matches

Purpose

Check whether the text matches a regular expression.

Recommended Example

matches(phone,'^1[0-9]{10}$')

Supported FormHow To Fill The Arguments
matches(CharSequence,CharSequence)Argument 1 is the source text to match; Argument 2 is the regular expression.

mid

Purpose

Extract a middle part by position and length.

Recommended Example

mid(id_card,7,8)

Supported FormHow To Fill The Arguments
mid(String,int,int)Argument 1 is the source text; Argument 2 is the length to keep or the starting position; Argument 3 is the length, end position, or offset.

normalizespace

Purpose

Collapse repeated whitespace and trim both ends.

Recommended Example

normalizespace(full_name)

Supported FormHow To Fill The Arguments
normalizespace(String)Argument 1 is the source text.

notlike

Purpose

Check whether the text does not match a LIKE pattern.

Recommended Example

notlike(name,'demo')

Supported FormHow To Fill The Arguments
notlike(ValueObject,ValueObject)Argument 1 is the source text to match; Argument 2 is the LIKE pattern, for example 'A%' or '__01'.

ordinalindexof

Purpose

Find where the target content appears.

Recommended Example

ordinalindexof(name,'demo',1)

Supported FormHow To Fill The Arguments
ordinalindexof(CharSequence,CharSequence,int)Argument 1 is the source text; Argument 2 is the target fragment to search for; Argument 3 is which occurrence should be located.
ordinalindexof(CharSequence,CharSequence,int,boolean)Argument 1 is the source text; Argument 2 is the target fragment to search for; Argument 3 is which occurrence should be located; Argument 4 is an extra switch that controls the search mode.

overlay

Purpose

Replace a section of text with new content.

Recommended Example

overlay(masked_mobile,'****',4,8)

Supported FormHow To Fill The Arguments
overlay(String,String,int,int)Argument 1 is the source text; Argument 2 is the new content used for overlay; Argument 3 is the position at which the overlay starts; Argument 4 is the position at which the overlay ends.

prependifmissing

Purpose

Add a prefix or suffix only when it is missing.

Recommended Example

prependifmissing(name,'demo','demo')

Supported FormHow To Fill The Arguments
prependifmissing(String,CharSequence,CharSequence)Argument 1 is the source text; Argument 2 is the prefix to add when it is missing; Argument 3 is an extra prefix that should also count as already present.
prependifmissing(String,CharSequence,boolean,CharSequence)Argument 1 is the source text; Argument 2 is the prefix to add when it is missing; Argument 3 is whether the check should ignore case; Argument 4 is an extra prefix that should also count as already present.

prependifmissingignorecase

Purpose

Add a prefix or suffix only when it is missing.

Recommended Example

prependifmissingignorecase(name,'demo','demo')

Supported FormHow To Fill The Arguments
prependifmissingignorecase(String,CharSequence,CharSequence)Argument 1 is the source text; Argument 2 is the prefix to add when it is missing; Argument 3 is an extra prefix that should also count as already present.

remove

Purpose

Replace or remove text according to the given rule.

Recommended Example

remove(code,'-')

Supported FormHow To Fill The Arguments
remove(String,String)Argument 1 is the source text; Argument 2 is the character, fragment, or pattern to remove.
remove(String,char)Argument 1 is the source text; Argument 2 is the character, fragment, or pattern to remove.

removeall

Purpose

Replace or remove text according to the given rule.

Recommended Example

removeall(code,'[0-9]')

Supported FormHow To Fill The Arguments
removeall(String,String)Argument 1 is the source text; Argument 2 is the character, fragment, or pattern to remove.

removeend

Purpose

Replace or remove text according to the given rule.

Recommended Example

removeend(name,'demo')

Supported FormHow To Fill The Arguments
removeend(String,String)Argument 1 is the source text; Argument 2 is the character, fragment, or pattern to remove.

removeendignorecase

Purpose

Replace or remove text according to the given rule.

Recommended Example

removeendignorecase(name,'demo')

Supported FormHow To Fill The Arguments
removeendignorecase(String,String)Argument 1 is the source text; Argument 2 is the character, fragment, or pattern to remove.

removefirst

Purpose

Replace or remove text according to the given rule.

Recommended Example

removefirst(name,'demo')

Supported FormHow To Fill The Arguments
removefirst(String,String)Argument 1 is the source text; Argument 2 is the character, fragment, or pattern to remove.

removeignorecase

Purpose

Replace or remove text according to the given rule.

Recommended Example

removeignorecase(name,'demo')

Supported FormHow To Fill The Arguments
removeignorecase(String,String)Argument 1 is the source text; Argument 2 is the character, fragment, or pattern to remove.

removepattern

Purpose

Replace or remove text according to the given rule.

Recommended Example

removepattern(name,'demo')

Supported FormHow To Fill The Arguments
removepattern(String,String)Argument 1 is the source text; Argument 2 is the character, fragment, or pattern to remove.

removestart

Purpose

Replace or remove text according to the given rule.

Recommended Example

removestart(name,'demo')

Supported FormHow To Fill The Arguments
removestart(String,String)Argument 1 is the source text; Argument 2 is the character, fragment, or pattern to remove.
removestart(String,char)Argument 1 is the source text; Argument 2 is the character, fragment, or pattern to remove.

removestartignorecase

Purpose

Replace or remove text according to the given rule.

Recommended Example

removestartignorecase(name,'demo')

Supported FormHow To Fill The Arguments
removestartignorecase(String,String)Argument 1 is the source text; Argument 2 is the character, fragment, or pattern to remove.

repeat

Purpose

Repeat text or characters a number of times.

Recommended Example

repeat('*',6)

Supported FormHow To Fill The Arguments
repeat(String,int)Argument 1 is the text or character to repeat; Argument 2 is the repeat count.
repeat(char,int)Argument 1 is the text or character to repeat; Argument 2 is the repeat count.
repeat(String,String,int)Argument 1 is the text to repeat; Argument 2 is the separator used between repeats; Argument 3 is the repeat count.

replace

Purpose

Replace or remove text according to the given rule.

Recommended Example

replace(city,'Hangzhou','Shanghai')

Supported FormHow To Fill The Arguments
replace(String,String,String)Argument 1 is the source text; Argument 2 is the existing content to find; Argument 3 is the replacement content.
replace(String,String,String,int)Argument 1 is the source text; Argument 2 is the existing content to find; Argument 3 is the replacement content; Argument 4 is the maximum number of replacements.
replace(String,String,String,int,boolean)Argument 1 is the source text; Argument 2 is the existing content to find; Argument 3 is the replacement content; Argument 4 is the maximum number of replacements; Argument 5 is an extra switch that controls replacement behavior.

replaceall

Purpose

Replace or remove text according to the given rule.

Recommended Example

replaceall(name,'demo','demo')

Supported FormHow To Fill The Arguments
replaceall(String,String,String)Argument 1 is the source text; Argument 2 is the existing content to find; Argument 3 is the replacement content.

replacechars

Purpose

Replace or remove text according to the given rule.

Recommended Example

replacechars(name,'demo','demo')

Supported FormHow To Fill The Arguments
replacechars(String,String,String)Argument 1 is the source text; Argument 2 is the existing content to find; Argument 3 is the replacement content.
replacechars(String,char,char)Argument 1 is the source text; Argument 2 is the existing content to find; Argument 3 is the replacement content.

replaceeach

Purpose

Replace or remove text according to the given rule.

Recommended Example

replaceeach(name,'demo','demo')

Supported FormHow To Fill The Arguments
replaceeach(String,String,String)Argument 1 is the source text; Argument 2 is the existing content to find; Argument 3 is the replacement content.
replaceeach(String,String,String,boolean,int)Argument 1 is the source text; Argument 2 is the existing content to find; Argument 3 is the replacement content; Argument 4 is the maximum number of replacements; Argument 5 is an extra switch that controls replacement behavior.

replaceeachrepeatedly

Purpose

Replace or remove text according to the given rule.

Recommended Example

replaceeachrepeatedly(name,'demo','demo')

Supported FormHow To Fill The Arguments
replaceeachrepeatedly(String,String,String)Argument 1 is the source text; Argument 2 is the existing content to find; Argument 3 is the replacement content.

replacefirst

Purpose

Replace or remove text according to the given rule.

Recommended Example

replacefirst(name,'demo','demo')

Supported FormHow To Fill The Arguments
replacefirst(String,String,String)Argument 1 is the source text; Argument 2 is the existing content to find; Argument 3 is the replacement content.

replaceignorecase

Purpose

Replace or remove text according to the given rule.

Recommended Example

replaceignorecase(name,'demo','demo')

Supported FormHow To Fill The Arguments
replaceignorecase(String,String,String)Argument 1 is the source text; Argument 2 is the existing content to find; Argument 3 is the replacement content.
replaceignorecase(String,String,String,int)Argument 1 is the source text; Argument 2 is the existing content to find; Argument 3 is the replacement content; Argument 4 is the maximum number of replacements.

replaceonce

Purpose

Replace or remove text according to the given rule.

Recommended Example

replaceonce(name,'demo','demo')

Supported FormHow To Fill The Arguments
replaceonce(String,String,String)Argument 1 is the source text; Argument 2 is the existing content to find; Argument 3 is the replacement content.

replaceonceignorecase

Purpose

Replace or remove text according to the given rule.

Recommended Example

replaceonceignorecase(name,'demo','demo')

Supported FormHow To Fill The Arguments
replaceonceignorecase(String,String,String)Argument 1 is the source text; Argument 2 is the existing content to find; Argument 3 is the replacement content.

replacepattern

Purpose

Replace or remove text according to the given rule.

Recommended Example

replacepattern(phone,'[^0-9]','')

Supported FormHow To Fill The Arguments
replacepattern(String,String,String)Argument 1 is the source text; Argument 2 is the existing content to find; Argument 3 is the replacement content.

reverse

Purpose

Reverse the text.

Recommended Example

reverse(code)

Supported FormHow To Fill The Arguments
reverse(String)Argument 1 is the source text.

reversedelimited

Purpose

Split by a delimiter and reverse the fragment order.

Recommended Example

reversedelimited(name,'a')

Supported FormHow To Fill The Arguments
reversedelimited(String,char)Argument 1 is the source text; Argument 2 is the separator.

Purpose

Keep the rightmost part of the text.

Recommended Example

right(order_no,4)

Supported FormHow To Fill The Arguments
right(String,int)Argument 1 is the source text; Argument 2 is the length to keep or the starting position.

rightpad

Purpose

Apply the rightpad text operation.

Recommended Example

rightpad(name,1)

Supported FormHow To Fill The Arguments
rightpad(String,int)Argument 1 is the source text; Argument 2 is the target length.
rightpad(String,int,String)Argument 1 is the source text; Argument 2 is the target length; Argument 3 is the character or text used for padding.
rightpad(String,int,char)Argument 1 is the source text; Argument 2 is the target length; Argument 3 is the character or text used for padding.

rotate

Purpose

Rotate text by an offset.

Recommended Example

rotate(code,2)

Supported FormHow To Fill The Arguments
rotate(String,int)Argument 1 is the source text; Argument 2 is the offset; positive and negative values rotate in different directions.

split

Purpose

Split text according to the given rule.

Recommended Example

split(tags,',')

Supported FormHow To Fill The Arguments
split(String)Argument 1 is the source text.
split(String,String)Argument 1 is the source text; Argument 2 is the separator or split rule.
split(String,char)Argument 1 is the source text; Argument 2 is the separator or split rule.
split(String,String,int)Argument 1 is the source text; Argument 2 is the separator or split rule; Argument 3 is the maximum number of parts to split into.

splitbycharactertype

Purpose

Split text according to the given rule.

Recommended Example

splitbycharactertype(name)

Supported FormHow To Fill The Arguments
splitbycharactertype(String)Argument 1 is the source text.
splitbycharactertype(String,boolean)Argument 1 is the source text; Argument 2 is the separator or split rule.

splitbycharactertypecamelcase

Purpose

Split text according to the given rule.

Recommended Example

splitbycharactertypecamelcase(name)

Supported FormHow To Fill The Arguments
splitbycharactertypecamelcase(String)Argument 1 is the source text.

splitbywholeseparator

Purpose

Split text according to the given rule.

Recommended Example

splitbywholeseparator(name,'demo')

Supported FormHow To Fill The Arguments
splitbywholeseparator(String,String)Argument 1 is the source text; Argument 2 is the separator or split rule.
splitbywholeseparator(String,String,int)Argument 1 is the source text; Argument 2 is the separator or split rule; Argument 3 is the maximum number of parts to split into.

splitbywholeseparatorpreservealltokens

Purpose

Split text according to the given rule.

Recommended Example

splitbywholeseparatorpreservealltokens(name,'demo')

Supported FormHow To Fill The Arguments
splitbywholeseparatorpreservealltokens(String,String)Argument 1 is the source text; Argument 2 is the separator or split rule.
splitbywholeseparatorpreservealltokens(String,String,int)Argument 1 is the source text; Argument 2 is the separator or split rule; Argument 3 is the maximum number of parts to split into.

splitpreservealltokens

Purpose

Split text according to the given rule.

Recommended Example

splitpreservealltokens(csv_line,',')

Supported FormHow To Fill The Arguments
splitpreservealltokens(String)Argument 1 is the source text.
splitpreservealltokens(String,String)Argument 1 is the source text; Argument 2 is the separator or split rule.
splitpreservealltokens(String,char)Argument 1 is the source text; Argument 2 is the separator or split rule.
splitpreservealltokens(String,String,int)Argument 1 is the source text; Argument 2 is the separator or split rule; Argument 3 is the maximum number of parts to split into.

startswith

Purpose

Check whether the text meets the requested match rule.

Recommended Example

startswith(order_no,'HA')

Supported FormHow To Fill The Arguments
startswith(CharSequence,CharSequence)Argument 1 is the text to check; Argument 2 is the prefix, suffix, or candidate fragment to match.
startswith(CharSequence,CharSequence,boolean)Argument 1 is the text to check; Argument 2 is the prefix, suffix, or candidate fragment to match; Argument 3 is whether the match should ignore case.

startswithany

Purpose

Check whether the text meets the requested match rule.

Recommended Example

startswithany(name,'demo')

Supported FormHow To Fill The Arguments
startswithany(CharSequence,CharSequence)Argument 1 is the text to check; Argument 2 is the prefix, suffix, or candidate fragment to match.

startswithignorecase

Purpose

Check whether the text meets the requested match rule.

Recommended Example

startswithignorecase(name,'demo')

Supported FormHow To Fill The Arguments
startswithignorecase(CharSequence,CharSequence)Argument 1 is the text to check; Argument 2 is the prefix, suffix, or candidate fragment to match.

strip

Purpose

Clean leading or trailing whitespace or characters.

Recommended Example

strip(name)

Supported FormHow To Fill The Arguments
strip(String)Argument 1 is the source text.
strip(String,String)Argument 1 is the source text; Argument 2 is the set of characters to strip.

stripaccents

Purpose

Clean leading or trailing whitespace or characters.

Recommended Example

stripaccents(name)

Supported FormHow To Fill The Arguments
stripaccents(String)Argument 1 is the source text.

stripall

Purpose

Clean leading or trailing whitespace or characters.

Recommended Example

stripall(name)

Supported FormHow To Fill The Arguments
stripall(String)Argument 1 is a list of text values processed in order.

stripend

Purpose

Clean leading or trailing whitespace or characters.

Recommended Example

stripend(name,'demo')

Supported FormHow To Fill The Arguments
stripend(String,String)Argument 1 is the source text; Argument 2 is the set of characters to strip.

stripstart

Purpose

Clean leading or trailing whitespace or characters.

Recommended Example

stripstart(name,'demo')

Supported FormHow To Fill The Arguments
stripstart(String,String)Argument 1 is the source text; Argument 2 is the set of characters to strip.

striptoempty

Purpose

Clean leading or trailing whitespace or characters.

Recommended Example

striptoempty(name)

Supported FormHow To Fill The Arguments
striptoempty(String)Argument 1 is the source text.

striptonull

Purpose

Clean leading or trailing whitespace or characters.

Recommended Example

striptonull(name)

Supported FormHow To Fill The Arguments
striptonull(String)Argument 1 is the source text.

substring

Purpose

Extract part of the text by boundary or position.

Recommended Example

substring(email,0,5)

Supported FormHow To Fill The Arguments
substring(String,int)Argument 1 is the source text; Argument 2 is the marker used as a boundary or starting point.
substring(String,int,int)Argument 1 is the source text; Argument 2 is the marker used as a boundary or starting point; Argument 3 is the boundary, end position, or length control value.

substringafter

Purpose

Extract part of the text by boundary or position.

Recommended Example

substringafter(email,'@')

Supported FormHow To Fill The Arguments
substringafter(String,String)Argument 1 is the source text; Argument 2 is the marker used as a boundary or starting point.
substringafter(String,int)Argument 1 is the source text; Argument 2 is the marker used as a boundary or starting point.

substringafterlast

Purpose

Extract part of the text by boundary or position.

Recommended Example

substringafterlast(name,'demo')

Supported FormHow To Fill The Arguments
substringafterlast(String,String)Argument 1 is the source text; Argument 2 is the marker used as a boundary or starting point.
substringafterlast(String,int)Argument 1 is the source text; Argument 2 is the marker used as a boundary or starting point.

substringbefore

Purpose

Extract part of the text by boundary or position.

Recommended Example

substringbefore(email,'@')

Supported FormHow To Fill The Arguments
substringbefore(String,String)Argument 1 is the source text; Argument 2 is the marker used as a boundary or starting point.
substringbefore(String,int)Argument 1 is the source text; Argument 2 is the marker used as a boundary or starting point.

substringbeforelast

Purpose

Extract part of the text by boundary or position.

Recommended Example

substringbeforelast(name,'demo')

Supported FormHow To Fill The Arguments
substringbeforelast(String,String)Argument 1 is the source text; Argument 2 is the marker used as a boundary or starting point.

substringbetween

Purpose

Extract part of the text by boundary or position.

Recommended Example

substringbetween(url,'[',']')

Supported FormHow To Fill The Arguments
substringbetween(String,String)Argument 1 is the source text; Argument 2 is the shared boundary marker used on both sides.
substringbetween(String,String,String)Argument 1 is the source text; Argument 2 is the marker used as a boundary or starting point; Argument 3 is the boundary, end position, or length control value.

substringsbetween

Purpose

Extract part of the text by boundary or position.

Recommended Example

substringsbetween(name,'demo','demo')

Supported FormHow To Fill The Arguments
substringsbetween(String,String,String)Argument 1 is the source text; Argument 2 is the marker used as a boundary or starting point; Argument 3 is the boundary, end position, or length control value.

swapcase

Purpose

Swap uppercase and lowercase letters.

Recommended Example

swapcase(code)

Supported FormHow To Fill The Arguments
swapcase(String)Argument 1 is the source text.

tocodepoints

Purpose

Apply the tocodepoints text operation.

Recommended Example

tocodepoints(name)

Supported FormHow To Fill The Arguments
tocodepoints(CharSequence)Argument 1 is the source text.

toencodedstring

Purpose

Apply the toencodedstring text operation.

Recommended Example

toencodedstring(content_bytes,'UTF-8')

Supported FormHow To Fill The Arguments
toencodedstring(byte,Charset)Argument 1 is the byte content; Argument 2 is the charset name, for example 'UTF-8'.

torootlowercase

Purpose

Apply the torootlowercase text operation.

Recommended Example

torootlowercase(name)

Supported FormHow To Fill The Arguments
torootlowercase(String)Argument 1 is the source text.

torootuppercase

Purpose

Apply the torootuppercase text operation.

Recommended Example

torootuppercase(name)

Supported FormHow To Fill The Arguments
torootuppercase(String)Argument 1 is the source text.

tostring

Purpose

Convert the input value to text.

Recommended Example

tostring(amount)

Supported FormHow To Fill The Arguments
tostring(byte,String)Argument 1 is the input value to convert.

tostringorempty

Purpose

Apply the tostringorempty text operation.

Recommended Example

tostringorempty(name)

Supported FormHow To Fill The Arguments
tostringorempty(Object)Argument 1 is the input value to convert.

trim

Purpose

Trim leading and trailing whitespace.

Recommended Example

trim(name)

Supported FormHow To Fill The Arguments
trim(String)Argument 1 is the source text.

trimtoempty

Purpose

Trim whitespace and return an empty string for null.

Recommended Example

trimtoempty(name)

Supported FormHow To Fill The Arguments
trimtoempty(String)Argument 1 is the source text.

trimtonull

Purpose

Trim whitespace and return null when the result is empty.

Recommended Example

trimtonull(name)

Supported FormHow To Fill The Arguments
trimtonull(String)Argument 1 is the source text.

truncate

Purpose

Cut text to a maximum length.

Recommended Example

truncate(remark,50)

Supported FormHow To Fill The Arguments
truncate(String,int)Argument 1 is the source text; Argument 2 is the length to keep or the starting position.
truncate(String,int,int)Argument 1 is the source text; Argument 2 is the length to keep or the starting position; Argument 3 is the length, end position, or offset.

uncapitalize

Purpose

Convert the first letter to lowercase.

Recommended Example

uncapitalize(name)

Supported FormHow To Fill The Arguments
uncapitalize(String)Argument 1 is the source text.

unwrap

Purpose

Apply the unwrap text operation.

Recommended Example

unwrap(name,'demo')

Supported FormHow To Fill The Arguments
unwrap(String,String)Argument 1 is the source text; Argument 2 is the wrapping character or outer prefix and suffix.
unwrap(String,char)Argument 1 is the source text; Argument 2 is the wrapping character or outer prefix and suffix.

uppercase

Purpose

Convert text to uppercase.

Recommended Example

uppercase(code)

Supported FormHow To Fill The Arguments
uppercase(String)Argument 1 is the source text.
uppercase(String,Locale)Argument 1 is the source text.

valueof

Purpose

Convert the input value into text.

Recommended Example

valueof(amount)

Supported FormHow To Fill The Arguments
valueof(char)Argument 1 is the input value to convert.

wrap

Purpose

Wrap the text with outer characters or prefixes and suffixes.

Recommended Example

wrap(code,'"')

Supported FormHow To Fill The Arguments
wrap(String,String)Argument 1 is the source text; Argument 2 is the wrapping character or outer prefix and suffix.
wrap(String,char)Argument 1 is the source text; Argument 2 is the wrapping character or outer prefix and suffix.

wrapifmissing

Purpose

Only wrap the text when the wrapper is missing.

Recommended Example

wrapifmissing(code,'"')

Supported FormHow To Fill The Arguments
wrapifmissing(String,String)Argument 1 is the source text; Argument 2 is the wrapping character or outer prefix and suffix.
wrapifmissing(String,char)Argument 1 is the source text; Argument 2 is the wrapping character or outer prefix and suffix.
Math Functions (49)

math_abs

Purpose

Return the absolute value.

Recommended Example

math_abs(amount)

Supported FormHow To Fill The Arguments
math_abs(double)Argument 1 is the numeric input.

math_acos

Purpose

Apply the acos math operation.

Recommended Example

math_acos(amount)

Supported FormHow To Fill The Arguments
math_acos(double)Argument 1 is the numeric input.

math_addexact

Purpose

Apply the addexact math operation.

Recommended Example

math_addexact(amount,amount)

Supported FormHow To Fill The Arguments
math_addexact(int,int)Argument 1 is the first numeric input; Argument 2 is the second numeric input.
math_addexact(long,long)Argument 1 is the first numeric input; Argument 2 is the second numeric input.

math_asin

Purpose

Apply the asin math operation.

Recommended Example

math_asin(amount)

Supported FormHow To Fill The Arguments
math_asin(double)Argument 1 is the numeric input.

math_atan

Purpose

Apply the atan math operation.

Recommended Example

math_atan(amount)

Supported FormHow To Fill The Arguments
math_atan(double)Argument 1 is the numeric input.

math_atan2

Purpose

Apply the atan2 math operation.

Recommended Example

math_atan2(amount,amount)

Supported FormHow To Fill The Arguments
math_atan2(double,double)Argument 1 is the first coordinate component; Argument 2 is the second coordinate component.

math_cbrt

Purpose

Apply the cbrt math operation.

Recommended Example

math_cbrt(amount)

Supported FormHow To Fill The Arguments
math_cbrt(double)Argument 1 is the numeric input.

math_ceil

Purpose

Round the value up.

Recommended Example

math_ceil(amount)

Supported FormHow To Fill The Arguments
math_ceil(double)Argument 1 is the numeric input.

math_copysign

Purpose

Apply the copysign math operation.

Recommended Example

math_copysign(amount,amount)

Supported FormHow To Fill The Arguments
math_copysign(double,double)Argument 1 is the value whose magnitude should be kept; Argument 2 is the value that provides the sign.

math_cos

Purpose

Apply the cos math operation.

Recommended Example

math_cos(amount)

Supported FormHow To Fill The Arguments
math_cos(double)Argument 1 is the numeric input.

math_cosh

Purpose

Apply the cosh math operation.

Recommended Example

math_cosh(amount)

Supported FormHow To Fill The Arguments
math_cosh(double)Argument 1 is the numeric input.

math_decrementexact

Purpose

Apply the decrementexact math operation.

Recommended Example

math_decrementexact(amount)

Supported FormHow To Fill The Arguments
math_decrementexact(long)Argument 1 is the numeric input.

math_exp

Purpose

Apply the exp math operation.

Recommended Example

math_exp(amount)

Supported FormHow To Fill The Arguments
math_exp(double)Argument 1 is the numeric input.

math_expm1

Purpose

Apply the expm1 math operation.

Recommended Example

math_expm1(amount)

Supported FormHow To Fill The Arguments
math_expm1(double)Argument 1 is the numeric input.

math_floor

Purpose

Round the value down.

Recommended Example

math_floor(amount)

Supported FormHow To Fill The Arguments
math_floor(double)Argument 1 is the numeric input.

math_floordiv

Purpose

Apply the floordiv math operation.

Recommended Example

math_floordiv(amount,amount)

Supported FormHow To Fill The Arguments
math_floordiv(int,int)Argument 1 is the first numeric input; Argument 2 is the second numeric input.
math_floordiv(long,int)Argument 1 is the first numeric input; Argument 2 is the second numeric input.
math_floordiv(long,long)Argument 1 is the first numeric input; Argument 2 is the second numeric input.

math_floormod

Purpose

Apply the floormod math operation.

Recommended Example

math_floormod(amount,amount)

Supported FormHow To Fill The Arguments
math_floormod(long,int)Argument 1 is the first numeric input; Argument 2 is the second numeric input.
math_floormod(long,long)Argument 1 is the first numeric input; Argument 2 is the second numeric input.

math_fma

Purpose

Apply the fma math operation.

Recommended Example

math_fma(amount,amount,amount)

Supported FormHow To Fill The Arguments
math_fma(double,double,double)Argument 1 is the first multiplicand; Argument 2 is the second multiplicand; Argument 3 is the value added after multiplication.

math_getexponent

Purpose

Apply the getexponent math operation.

Recommended Example

math_getexponent(amount)

Supported FormHow To Fill The Arguments
math_getexponent(double)Argument 1 is the numeric input.

math_hypot

Purpose

Apply the hypot math operation.

Recommended Example

math_hypot(amount,amount)

Supported FormHow To Fill The Arguments
math_hypot(double,double)Argument 1 is the first numeric input; Argument 2 is the second numeric input.

math_ieeeremainder

Purpose

Apply the ieeeremainder math operation.

Recommended Example

math_ieeeremainder(amount,amount)

Supported FormHow To Fill The Arguments
math_ieeeremainder(double,double)Argument 1 is the first numeric input; Argument 2 is the second numeric input.

math_incrementexact

Purpose

Apply the incrementexact math operation.

Recommended Example

math_incrementexact(amount)

Supported FormHow To Fill The Arguments
math_incrementexact(long)Argument 1 is the numeric input.

math_log

Purpose

Apply the log math operation.

Recommended Example

math_log(amount)

Supported FormHow To Fill The Arguments
math_log(double)Argument 1 is the numeric input.

math_log10

Purpose

Apply the log10 math operation.

Recommended Example

math_log10(amount)

Supported FormHow To Fill The Arguments
math_log10(double)Argument 1 is the numeric input.

math_log1p

Purpose

Apply the log1p math operation.

Recommended Example

math_log1p(amount)

Supported FormHow To Fill The Arguments
math_log1p(double)Argument 1 is the numeric input.

math_max

Purpose

Return the larger of two values.

Recommended Example

math_max(amount,limit_value)

Supported FormHow To Fill The Arguments
math_max(int,int)Argument 1 is the first numeric input; Argument 2 is the second numeric input.

math_min

Purpose

Return the smaller of two values.

Recommended Example

math_min(amount,limit_value)

Supported FormHow To Fill The Arguments
math_min(long,long)Argument 1 is the first numeric input; Argument 2 is the second numeric input.

math_multiplyexact

Purpose

Apply the multiplyexact math operation.

Recommended Example

math_multiplyexact(amount,amount)

Supported FormHow To Fill The Arguments
math_multiplyexact(long,long)Argument 1 is the first numeric input; Argument 2 is the second numeric input.

math_multiplyfull

Purpose

Apply the multiplyfull math operation.

Recommended Example

math_multiplyfull(amount,amount)

Supported FormHow To Fill The Arguments
math_multiplyfull(int,int)Argument 1 is the first numeric input; Argument 2 is the second numeric input.

math_multiplyhigh

Purpose

Apply the multiplyhigh math operation.

Recommended Example

math_multiplyhigh(amount,amount)

Supported FormHow To Fill The Arguments
math_multiplyhigh(long,long)Argument 1 is the first numeric input; Argument 2 is the second numeric input.

math_negateexact

Purpose

Apply the negateexact math operation.

Recommended Example

math_negateexact(amount)

Supported FormHow To Fill The Arguments
math_negateexact(long)Argument 1 is the numeric input.

math_nextafter

Purpose

Apply the nextafter math operation.

Recommended Example

math_nextafter(amount,amount)

Supported FormHow To Fill The Arguments
math_nextafter(double,double)Argument 1 is the current value; Argument 2 is the target value that defines the direction.
math_nextafter(float,double)Argument 1 is the current value; Argument 2 is the target value that defines the direction.

math_nextdown

Purpose

Apply the nextdown math operation.

Recommended Example

math_nextdown(amount)

Supported FormHow To Fill The Arguments
math_nextdown(double)Argument 1 is the numeric input.

math_nextup

Purpose

Apply the nextup math operation.

Recommended Example

math_nextup(amount)

Supported FormHow To Fill The Arguments
math_nextup(double)Argument 1 is the numeric input.

math_pow

Purpose

Raise a value to a power.

Recommended Example

math_pow(amount,2)

Supported FormHow To Fill The Arguments
math_pow(double,double)Argument 1 is the base value; Argument 2 is the exponent.

math_rint

Purpose

Apply the rint math operation.

Recommended Example

math_rint(amount)

Supported FormHow To Fill The Arguments
math_rint(double)Argument 1 is the numeric input.

math_round

Purpose

Round the value with the default rounding rule.

Recommended Example

math_round(amount)

Supported FormHow To Fill The Arguments
math_round(float)Argument 1 is the numeric input.

math_scalb

Purpose

Apply the scalb math operation.

Recommended Example

math_scalb(amount,amount)

Supported FormHow To Fill The Arguments
math_scalb(double,int)Argument 1 is the source numeric value; Argument 2 is how many powers of 2 should be used for scaling.

math_signum

Purpose

Return whether the value is positive, negative, or zero.

Recommended Example

math_signum(amount)

Supported FormHow To Fill The Arguments
math_signum(double)Argument 1 is the numeric input.

math_sin

Purpose

Apply the sin math operation.

Recommended Example

math_sin(amount)

Supported FormHow To Fill The Arguments
math_sin(double)Argument 1 is the numeric input.

math_sinh

Purpose

Apply the sinh math operation.

Recommended Example

math_sinh(amount)

Supported FormHow To Fill The Arguments
math_sinh(double)Argument 1 is the numeric input.

math_sqrt

Purpose

Calculate the square root.

Recommended Example

math_sqrt(amount)

Supported FormHow To Fill The Arguments
math_sqrt(double)Argument 1 is the numeric input.

math_subtractexact

Purpose

Apply the subtractexact math operation.

Recommended Example

math_subtractexact(amount,amount)

Supported FormHow To Fill The Arguments
math_subtractexact(long,long)Argument 1 is the first numeric input; Argument 2 is the second numeric input.

math_tan

Purpose

Apply the tan math operation.

Recommended Example

math_tan(amount)

Supported FormHow To Fill The Arguments
math_tan(double)Argument 1 is the numeric input.

math_tanh

Purpose

Apply the tanh math operation.

Recommended Example

math_tanh(amount)

Supported FormHow To Fill The Arguments
math_tanh(double)Argument 1 is the numeric input.

math_todegrees

Purpose

Apply the todegrees math operation.

Recommended Example

math_todegrees(amount)

Supported FormHow To Fill The Arguments
math_todegrees(double)Argument 1 is the numeric input.

math_tointexact

Purpose

Apply the tointexact math operation.

Recommended Example

math_tointexact(amount)

Supported FormHow To Fill The Arguments
math_tointexact(long)Argument 1 is the numeric input.

math_toradians

Purpose

Apply the toradians math operation.

Recommended Example

math_toradians(amount)

Supported FormHow To Fill The Arguments
math_toradians(double)Argument 1 is the numeric input.

math_ulp

Purpose

Apply the ulp math operation.

Recommended Example

math_ulp(amount)

Supported FormHow To Fill The Arguments
math_ulp(double)Argument 1 is the numeric input.
math_ulp(float)Argument 1 is the numeric input.
Date Functions (32)

dateutils_adddays

Purpose

Add a time amount to a date or time value.

Recommended Example

dateutils_adddays(created_at,7)

Supported FormHow To Fill The Arguments
dateutils_adddays(Date,int)Argument 1 is the source date or time; Argument 2 is the amount to add.

dateutils_addhours

Purpose

Add a time amount to a date or time value.

Recommended Example

dateutils_addhours(created_at,2)

Supported FormHow To Fill The Arguments
dateutils_addhours(Date,int)Argument 1 is the source date or time; Argument 2 is the amount to add.

dateutils_addmilliseconds

Purpose

Add a time amount to a date or time value.

Recommended Example

dateutils_addmilliseconds(created_at,1)

Supported FormHow To Fill The Arguments
dateutils_addmilliseconds(Date,int)Argument 1 is the source date or time; Argument 2 is the amount to add.

dateutils_addminutes

Purpose

Add a time amount to a date or time value.

Recommended Example

dateutils_addminutes(created_at,1)

Supported FormHow To Fill The Arguments
dateutils_addminutes(Date,int)Argument 1 is the source date or time; Argument 2 is the amount to add.

dateutils_addmonths

Purpose

Add a time amount to a date or time value.

Recommended Example

dateutils_addmonths(created_at,1)

Supported FormHow To Fill The Arguments
dateutils_addmonths(Date,int)Argument 1 is the source date or time; Argument 2 is the amount to add.

dateutils_addseconds

Purpose

Add a time amount to a date or time value.

Recommended Example

dateutils_addseconds(created_at,1)

Supported FormHow To Fill The Arguments
dateutils_addseconds(Date,int)Argument 1 is the source date or time; Argument 2 is the amount to add.

dateutils_addweeks

Purpose

Add a time amount to a date or time value.

Recommended Example

dateutils_addweeks(created_at,1)

Supported FormHow To Fill The Arguments
dateutils_addweeks(Date,int)Argument 1 is the source date or time; Argument 2 is the amount to add.

dateutils_addyears

Purpose

Add a time amount to a date or time value.

Recommended Example

dateutils_addyears(created_at,1)

Supported FormHow To Fill The Arguments
dateutils_addyears(Date,int)Argument 1 is the source date or time; Argument 2 is the amount to add.

dateutils_ceiling

Purpose

Apply the requested date or time operation.

Recommended Example

dateutils_ceiling(created_at,1)

Supported FormHow To Fill The Arguments
dateutils_ceiling(Date,int)Argument 1 is the source date or time; Argument 2 is the time granularity used for the operation.

dateutils_getfragmentindays

Purpose

Read part of a date in a specific time fragment.

Recommended Example

dateutils_getfragmentindays(created_at,1)

Supported FormHow To Fill The Arguments
dateutils_getfragmentindays(Date,int)Argument 1 is the source date or time; Argument 2 is the higher-level time fragment.

dateutils_getfragmentinhours

Purpose

Read part of a date in a specific time fragment.

Recommended Example

dateutils_getfragmentinhours(created_at,1)

Supported FormHow To Fill The Arguments
dateutils_getfragmentinhours(Date,int)Argument 1 is the source date or time; Argument 2 is the higher-level time fragment.

dateutils_getfragmentinmilliseconds

Purpose

Read part of a date in a specific time fragment.

Recommended Example

dateutils_getfragmentinmilliseconds(created_at,1)

Supported FormHow To Fill The Arguments
dateutils_getfragmentinmilliseconds(Date,int)Argument 1 is the source date or time; Argument 2 is the higher-level time fragment.

dateutils_getfragmentinminutes

Purpose

Read part of a date in a specific time fragment.

Recommended Example

dateutils_getfragmentinminutes(created_at,1)

Supported FormHow To Fill The Arguments
dateutils_getfragmentinminutes(Date,int)Argument 1 is the source date or time; Argument 2 is the higher-level time fragment.

dateutils_getfragmentinseconds

Purpose

Read part of a date in a specific time fragment.

Recommended Example

dateutils_getfragmentinseconds(created_at,1)

Supported FormHow To Fill The Arguments
dateutils_getfragmentinseconds(Date,int)Argument 1 is the source date or time; Argument 2 is the higher-level time fragment.

dateutils_issameday

Purpose

Compare two date or time values.

Recommended Example

dateutils_issameday(created_at,updated_at)

Supported FormHow To Fill The Arguments
dateutils_issameday(Date,Date)Argument 1 is the first date or time; Argument 2 is the second date or time.

dateutils_issameinstant

Purpose

Compare two date or time values.

Recommended Example

dateutils_issameinstant(created_at,updated_at)

Supported FormHow To Fill The Arguments
dateutils_issameinstant(Date,Date)Argument 1 is the first date or time; Argument 2 is the second date or time.

dateutils_iterator

Purpose

Apply the requested date or time operation.

Recommended Example

dateutils_iterator(created_at,1)

Supported FormHow To Fill The Arguments
dateutils_iterator(Date,int)Argument 1 is the source date or date-range object; Argument 2 is the range or precision setting.
dateutils_iterator(Object,int)Argument 1 is the source date or date-range object; Argument 2 is the range or precision setting.

dateutils_parsedate

Purpose

Parse text into a date or time value.

Recommended Example

dateutils_parsedate(created_at_text,'yyyy-MM-dd HH:mm:ss')

Supported FormHow To Fill The Arguments
dateutils_parsedate(String,String)Argument 1 is the date text to parse; Argument 2 is the date pattern, for example 'yyyy-MM-dd HH:mm:ss'.
dateutils_parsedate(String,Locale,String)Argument 1 is the date text to parse; Argument 2 is the locale, for example 'zh_CN'; Argument 3 is the date pattern, for example 'yyyy-MM-dd HH:mm:ss'.

dateutils_parsedatestrictly

Purpose

Parse text into a date or time value.

Recommended Example

dateutils_parsedatestrictly(created_at_text,'yyyy-MM-dd HH:mm:ss')

Supported FormHow To Fill The Arguments
dateutils_parsedatestrictly(String,String)Argument 1 is the date text to parse; Argument 2 is the date pattern, for example 'yyyy-MM-dd HH:mm:ss'.
dateutils_parsedatestrictly(String,Locale,String)Argument 1 is the date text to parse; Argument 2 is the locale, for example 'zh_CN'; Argument 3 is the date pattern, for example 'yyyy-MM-dd HH:mm:ss'.

dateutils_parsedatewithleniency

Purpose

Parse text into a date or time value.

Recommended Example

dateutils_parsedatewithleniency(created_at_text,'zh_CN','yyyy-MM-dd HH:mm:ss',true)

Supported FormHow To Fill The Arguments
dateutils_parsedatewithleniency(String,Locale,String,boolean)Argument 1 is the date text to parse; Argument 2 is the locale, for example 'zh_CN'; Argument 3 is the date pattern, for example 'yyyy-MM-dd HH:mm:ss'; Argument 4 is whether lenient parsing is allowed.

dateutils_round

Purpose

Apply the requested date or time operation.

Recommended Example

dateutils_round(created_at,1)

Supported FormHow To Fill The Arguments
dateutils_round(Date,int)Argument 1 is the source date or time; Argument 2 is the time granularity used for the operation.

dateutils_setdays

Purpose

Set a specific field inside a date or time value.

Recommended Example

dateutils_setdays(created_at,1)

Supported FormHow To Fill The Arguments
dateutils_setdays(Date,int)Argument 1 is the source date or time; Argument 2 is the new value to set.

dateutils_sethours

Purpose

Set a specific field inside a date or time value.

Recommended Example

dateutils_sethours(created_at,1)

Supported FormHow To Fill The Arguments
dateutils_sethours(Date,int)Argument 1 is the source date or time; Argument 2 is the new value to set.

dateutils_setmilliseconds

Purpose

Set a specific field inside a date or time value.

Recommended Example

dateutils_setmilliseconds(created_at,1)

Supported FormHow To Fill The Arguments
dateutils_setmilliseconds(Date,int)Argument 1 is the source date or time; Argument 2 is the new value to set.

dateutils_setminutes

Purpose

Set a specific field inside a date or time value.

Recommended Example

dateutils_setminutes(created_at,1)

Supported FormHow To Fill The Arguments
dateutils_setminutes(Date,int)Argument 1 is the source date or time; Argument 2 is the new value to set.

dateutils_setmonths

Purpose

Set a specific field inside a date or time value.

Recommended Example

dateutils_setmonths(created_at,1)

Supported FormHow To Fill The Arguments
dateutils_setmonths(Date,int)Argument 1 is the source date or time; Argument 2 is the new value to set.

dateutils_setseconds

Purpose

Set a specific field inside a date or time value.

Recommended Example

dateutils_setseconds(created_at,1)

Supported FormHow To Fill The Arguments
dateutils_setseconds(Date,int)Argument 1 is the source date or time; Argument 2 is the new value to set.

dateutils_setyears

Purpose

Set a specific field inside a date or time value.

Recommended Example

dateutils_setyears(created_at,1)

Supported FormHow To Fill The Arguments
dateutils_setyears(Date,int)Argument 1 is the source date or time; Argument 2 is the new value to set.

dateutils_truncate

Purpose

Apply the requested date or time operation.

Recommended Example

dateutils_truncate(created_at,5)

Supported FormHow To Fill The Arguments
dateutils_truncate(Date,int)Argument 1 is the source date or time; Argument 2 is the time granularity used for the operation.

dateutils_truncatedcompareto

Purpose

Apply the requested date or time operation.

Recommended Example

dateutils_truncatedcompareto(created_at,updated_at,5)

Supported FormHow To Fill The Arguments
dateutils_truncatedcompareto(Date,Date,int)Argument 1 is the first date or time; Argument 2 is the second date or time; Argument 3 is the time granularity used for comparison.

dateutils_truncatedequals

Purpose

Apply the requested date or time operation.

Recommended Example

dateutils_truncatedequals(created_at,updated_at,5)

Supported FormHow To Fill The Arguments
dateutils_truncatedequals(Date,Date,int)Argument 1 is the first date or time; Argument 2 is the second date or time; Argument 3 is the time granularity used for comparison.

now

Purpose

Return the current date and time.

Recommended Example

now()

Supported FormHow To Fill The Arguments
now().
JSON Functions (3)

json_getstring

Purpose

Read a string value from JSON by key.

Recommended Example

json_getstring(ext_json,'name')

Supported FormHow To Fill The Arguments
json_getstring(String json,String key)Argument 1 is the JSON text; Argument 2 is the key name to read.

json_isvalid

Purpose

Check whether the input is valid JSON.

Recommended Example

json_isvalid(ext_json)

Supported FormHow To Fill The Arguments
json_isvalid(String)Argument 1 is the JSON text to validate.

json_object

Purpose

Build a JSON object from key-value pairs.

Recommended Example

json_object('name',name,'amount',amount)

Supported FormHow To Fill The Arguments
json_object(Object... args)Argument 1 is a list of arguments in key, value, key, value order.