Name | Description |
---|---|
base64_decode_toarray | Decodes a Base64-encoded string into an array of bytes. |
base64_decode_tostring | Decodes a base64 string to a UTF-8 string. |
base64_encode_fromarray | Converts a sequence of bytes into a Base64-encoded string. |
base64_encode_tostring | Encodes a string as base64 string. |
coalesce | Evaluates a list of expressions and returns the first non-null (or non-empty for string) expression. |
countof_regex | Counts occurrences of a substring in a string. Regex matches don’t. |
countof | Counts occurrences of a substring in a string. |
extract_all | Get all matches for a regular expression from a text string. |
extract | Get a match for a regular expression from a text string. |
format_bytes | Formats a number of bytes as a string including bytes units |
format_url | Formats an input string into a valid URL by adding the necessary protocol if it’s escaping illegal URL characters. |
gettype | Returns the runtime type of its single argument. |
indexof | Function reports the zero-based index of the first occurrence of a specified string within input string. |
isascii | Checks whether all characters in an input string are ASCII characters. |
isempty | Returns true if the argument is an empty string or is null. |
isnotempty | Returns true if the argument isn’t an empty string or a null. |
isnotnull | Returns true if the argument isn’t null. |
isnull | Evaluates its sole argument and returns a bool value indicating if the argument evaluates to a null value. |
parse_bytes | Parses a string including byte size units and returns the number of bytes |
parse_csv | Splits a given string representing a single record of comma-separated values and returns a string array with these values. |
parse_json | Interprets a string as a JSON value and returns the value as dynamic. |
parse_url | Parses an absolute URL string and returns a dynamic object contains all parts of the URL. |
parse_urlquery | Parses a URL query string and returns a dynamic object contains the Query parameters. |
quote | Returns a string representing the input enclosed in double quotes, with internal quotes and escape sequences handled appropriately. |
replace_regex | Replaces all regex matches with another string. |
replace_string | Replaces all string matches with another string. |
replace | Replace all regex matches with another string. |
reverse | Function makes reverse of input string. |
split | Splits a given string according to a given delimiter and returns a string array with the contained substrings. |
strcat_delim | Concatenates between 2 and 64 arguments, with delimiter, provided as first argument. |
strcat | Concatenates between 1 and 64 arguments. |
strcmp | Compares two strings. |
strlen | Returns the length, in characters, of the input string. |
strrep | Repeats given string provided number of times (default = 1). |
substring | Extracts a substring from a source string. |
tolower | Converts a string to lower case. |
totitle | Converts a string to title case. |
toupper | Converts a string to upper case. |
translate | Substitutes characters in a string, one by one, based on their position in two input lists. |
trim_end_regex | Removes trailing match of the specified regular expression. |
trim_end | Removes trailing match of the specified cutset. |
trim_regex | Removes all leading and trailing matches of the specified regular expression. |
trim_space | Removes all leading and trailing whitespace from a string. |
trim_start_regex | Removes leading match of the specified regular expression. |
trim_start | Removes leading match of the specified cutset. |
trim | Removes all leading and trailing matches of the specified cutset. |
unicode_codepoints_from_string | Converts a UTF-8 string into an array of Unicode code points. |
unicode_codepoints_to_string | Converts an array of Unicode code points into a UTF-8 encoded string. |
url_decode | The function converts encoded URL into a regular URL representation. |
url_encode | The function converts characters of the input URL into a format that can be transmitted over the Internet. |
base64_encode_tostring
Encodes a string as base64 string.Arguments
Name | Type | Required or Optional | Description |
---|---|---|---|
String | string | Required | Input string or string field to be encoded as base64 string. |
Returns
Returns the string encoded as base64 string.- To decode base64 strings to UTF-8 strings, see base64_decode_tostring
Examples
base64_decode_tostring
Decodes a base64 string to a UTF-8 string.Arguments
Name | Type | Required or Optional | Description |
---|---|---|---|
String | string | Required | Input string or string field to be decoded from base64 to UTF8-8 string. |
Returns
Returns UTF-8 string decoded from base64 string.- To encode strings to base64 string, see base64_encode_tostring
Examples
countof
Counts occurrences of a substring in a string.Arguments
Name | Type | Description | Required? |
---|---|---|---|
search | string | The plain string to match inside source. | ✓ |
text source | string | The source where to count the occurences. | ✓ |
Returns
The number of times that the search string is matched.Examples
countof_regex
Counts occurrences of a substring in a string. regex matches don’t.Arguments
- text source: A string.
- regex search: regular expression to match inside your text source.
Returns
The number of times that the search string can be matched in the dataset. Regex matches don’t.Examples
coalesce
Evaluates a list of expressions and returns the first non-null (or non-empty for string) expression.Arguments
name | type | description | Required or Optional |
---|---|---|---|
arguments | scalar | The expression or field to be evaluated. | Required |
Returns
The value of the first argument whose value isn’t null (or not-empty for string expressions).Examples
extract
Retrieve the first substring matching a regular expression from a source string.Arguments
name | type | description |
---|---|---|
regex | expression | A regular expression. |
captureGroup | int | A positive int constant indicating the capture group to extract. 0 stands for the entire match, 1 for the value matched by the first ’(‘parenthesis’)’ in the regular expression, 2 or more for subsequent parentheses. |
source | string | A string to search |
Returns
If regex finds a match in source: the substring matched against the indicated capture group captureGroup, optionally converted to typeLiteral. If there’s no match, or the type conversion fails:-1
or string error
Examples
extract_all
Retrieve all substrings matching a regular expression from a source string. Optionally, retrieve only a subset of the matching groups.Arguments
name | type | description | Required or Optional |
---|---|---|---|
regex | expression | A regular expression containing between one and 16 capture groups. Examples of a valid regex: @”(\d+)”. Examples of an invalid regex: @“\d+“ | Required |
captureGroups | array | A dynamic array constant that indicates the capture group to extract. Valid values are from 1 to the number of capturing groups in the regular expression. | Required |
source | string | A string to search | Required |
Returns
- If regex finds a match in source: Returns dynamic array including all matches against the indicated capture groups captureGroups, or all of capturing groups in the regex.
- If number of captureGroups is 1: The returned array has a single dimension of matched values.
- If number of captureGroups is more than 1: The returned array is a two-dimensional collection of multi-value matches per captureGroups selection, or all capture groups present in the regex if captureGroups is omitted.
- If there’s no match:
-1
Examples
format_bytes
Formats a number as a string representing data size in bytes.Arguments
name | type | description | Required or Optional |
---|---|---|---|
value | number | a number to be formatted as data size in bytes | Required |
precision | number | Number of digits the value will be rounded to. (default value is zero) | Optional |
units | string | Units of the target data size the string formatting will use (base 2 suffixes: Bytes , KiB , KB , MiB , MB , GiB , GB , TiB , TB , PiB , EiB , ZiB , YiB ; base 10 suffixes: kB MB GB TB PB EB ZB YB ). If the parameter is empty the units will be auto-selected based on input value. | Optional |
base | number | Either 2 or 10 to specify whether the prefix is calculated using 1000s or 1024s for each type. (default value is 2) | Optional |
Returns
- A formatted string for humans
Examples
format_url
Formats an input string into a valid URL. This function will return a string that’s a properly formatted URL.Arguments
name | type | description | Required or Optional |
---|---|---|---|
url | dynamic | string input you want to format into a URL | Required |
Returns
- A string that represents a properly formatted URL.
Examples
- These are all the supported keys when using the
format_url
function: scheme, host, port, fragment, user, password, query.
indexof
Reports the zero-based index of the first occurrence of a specified string within the input string.Arguments
name | type | description | usage |
---|---|---|---|
source | string | Input string | Required |
lookup | string | String to look up | Required |
start_index | text | Search start position. | Optional |
length | characters | Number of character positions to examine. A value of -1 means unlimited length. | Optional |
occurrence | number | The number of the occurrence. Default 1. | Optional |
Returns
- Zero-based index position of lookup.
- Returns -1 if the string isn’t found in the input.
Examples
isempty
Returnstrue
if the argument is an empty string or is null.
Returns
Indicates whether the argument is an empty string or isnull.Examples
isnotempty
Returnstrue
if the argument isn’t an empty string, and it’sn’t null.
Examples
isnotnull
Returnstrue
if the argument isn’t null.
Examples
isnull
Evaluates its sole argument and returns a bool value indicating if the argument evaluates to a null value.Returns
True or false, depending on whether or not the value is null.Examples
parse_bytes
Parses a string including byte size units and returns the number of bytesArguments
name | type | description | Required or Optional |
---|---|---|---|
bytes_string | string | A string formated defining the number of bytes | Required |
base | number | (optional) Either 2 or 10 to specify whether the prefix is calculated using 1000s or 1024s for each type. (default value is 2) | Required |
Returns
- The number of bytes or zero if unable to parse
Examples
parse_json
Interprets a string as a JSON value and returns the value as dynamic.Arguments
Name | Type | Required or Optional | Description |
---|---|---|---|
Json Expr | string | Required | Expression that will be used, also represents a JSON-formatted value |
Returns
An object of type json that’s determined by the value of json:- If json is of type string, and is a properly formatted JSON string, then the string is parsed, and the value produced is returned.
- If json is of type string, but it’sn’t a properly formatted JSON string, then the returned value is an object of type dynamic that holds the original string value.
Examples
parse_url
Parses an absolute URLstring
and returns an object contains URL parts.
Arguments
Name | Type | Required or Optional | Description |
---|---|---|---|
URL | string | Required | A string represents a URL or the query part of the URL. |
Returns
An object of type dynamic that included the URL components: Scheme, Host, Port, Path, Username, Password, Query Parameters, Fragment.Examples
- Result
parse_urlquery
Returns adynamic
object contains the Query parameters.
Arguments
Name | Type | Required or Optional | Description |
---|---|---|---|
Query | string | Required | A string represents a url query. |
Returns
An object of type dynamic that includes the query parameters.Examples
- Result
replace
Replace all regex matches with another string.Arguments
- regex: The regular expression to search source. It can contain capture groups in ’(‘parentheses’)’.
- rewrite: The replacement regex for any match made by matchingRegex. Use 1 for the first capture group, $2 and so on for subsequent capture groups.
- source: A string.
Returns
- source after replacing all matches of regex with evaluations of rewrite. Matches don’t overlap.
Examples
replace_regex
Replaces all regex matches with another string.Arguments
- regex: The regular expression to search text.
- rewrite: The replacement regex for any match made by matchingRegex.
- text: A string.
Returns
source after replacing all matches of regex with evaluations of rewrite. Matches don’t overlap.Examples
- Result
Backreferences
Backreferences match the same text as previously matched by a capturing group. With Backreferences, you can identify a repeated character or substring within a string.- Backreferences in APL is implemented using the
$
sign.
Examples
replace_string
Replaces all string matches with another string.Arguments
Name | Type | Required or Optional | Description |
---|---|---|---|
lookup | string | Required | A string which Axiom matches in text and replaces with rewrite . |
rewrite | string | Required | A string with which Axiom replaces parts of text that match lookup . |
text | string | Required | A string where Axiom replaces parts matching lookup with rewrite . |
Returns
text
after replacing all matches of lookup
with evaluations of rewrite
. Matches don’t overlap.
Examples
- Result
reverse
Function reverses the order of the input Field.Arguments
name | type | description | Required or Optional |
---|---|---|---|
Field | string | Field input value | Required |
Returns
The reverse order of a field value.Examples
- Result
split
Splits a given string according to a given delimiter and returns a string array with the contained substrings. Optionally, a specific substring can be returned if exists.Arguments
- source: The source string that will be split according to the given delimiter.
- delimiter: The delimiter (Field) that will be used in order to split the source string.
Returns
- A string array that contains the substrings of the given source string that are delimited by the given delimiter.
Examples
- Result
strcat
Concatenates between 1 and 64 arguments. If the arguments aren’t of string type, they’ll be forcibly converted to string.Arguments
Name | Type | Required or Optional | Description |
---|---|---|---|
Expr | string | Required | Expressions to be concatenated. |
Returns
Arguments, concatenated to a single string.Examples
- Result
strcat_delim
Concatenates between 2 and 64 arguments, with delimiter, provided as first argument.- If arguments aren’t of string type, they’ll be forcibly converted to string.
Arguments
Name | Type | Required or Optional | Description |
---|---|---|---|
delimiter | string | Required | string expression, which will be used as separator. |
argument1 .. | string | Required | Expressions to be concatenated. |
Returns
Arguments, concatenated to a single string with delimiter.Examples
- Result
strcmp
Compares two strings. The function starts comparing the first character of each string. If they are equal to each other, it continues with the following pairs until the characters differ or until the end of shorter string is reached.Arguments
Name | Type | Required or Optional | Description |
---|---|---|---|
string1 | string | Required | first input string for comparison. |
string2 | string | Required | second input string for comparison. |
Returns
Returns an integral value indicating the relationship between the strings:- When the result is 0: The contents of both strings are equal.
- When the result is -1: the first character that doesn’t match has a lower value in string1 than in string2.
- When the result is 1: the first character that doesn’t match has a higher value in string1 than in string2.
Examples
- Result
strlen
Returns the length, in characters, of the input string.Arguments
Name | Type | Required or Optional | Description |
---|---|---|---|
source | string | Required | The source string that will be measured for string length. |
Returns
Returns the length, in characters, of the input string.Examples
- Result
strrep
Repeats given string provided amount of times.- In case if first or third argument isn’t of a string type, it will be forcibly converted to string.
Arguments
Name | Type | Required or Optional | Description |
---|---|---|---|
value | Expr | Required | Inpute Expression |
multiplier | integer | Required | positive integer value (from 1 to 1024) |
delimiter | string | Optional | An optional string expression (default: empty string) |
Returns
- Value repeated for a specified number of times, concatenated with delimiter.
- In case if multiplier is more than maximal allowed value (1024), input string will be repeated 1024 times.
Examples
- Result
substring
Extracts a substring from a source string.Arguments
- source: The source string that the substring will be taken from.
- startingIndex: The zero-based starting character position of the requested substring.
- length: A parameter that can be used to specify the requested number of characters in the substring.
Returns
A substring from the given string. The substring starts at startingIndex (zero-based) character position and continues to the end of the string or length characters if specified.Examples
toupper
Converts a string to upper case.tolower
Converts a string to lower case.totitle
Converts a string to title case.trim
Removes all leading and trailing matches of the specified cutset.Arguments
- source: A string.
- cutset: A string containing the characters to be removed.
Returns
source after trimming matches of the cutset found in the beginning and/or the end of source.Examples
- Result
trim_regex
Removes all leading and trailing matches of the specified regular expression.Arguments
- regex: String or regular expression to be trimmed from the beginning and/or the end of source.
- source: A string.
Returns
source after trimming matches of regex found in the beginning and/or the end of source.Examples
- Result
trim_end
Removes trailing match of the specified cutset.Arguments
- source: A string.
- cutset: A string containing the characters to be removed.`
Returns
source after trimming matches of the cutset found in the end of source.Examples
- Result
trim_end_regex
Removes trailing match of the specified regular expression.Arguments
- regex: String or regular expression to be trimmed from the end of source.
- source: A string.
Returns
source after trimming matches of regex found in the end of source.Examples
- Result
trim_start
Removes leading match of the specified cutset.Arguments
- source: A string.
Returns
- source after trimming match of the specified cutset found in the beginning of source.
Examples
- Result
trim_start_regex
Removes leading match of the specified regular expression.Arguments
- regex: String or regular expression to be trimmed from the beginning of source.
- source: A string.
Returns
source after trimming match of regex found in the beginning of source.Examples
- Result
url_decode
The function converts encoded URL into a to regular URL representation.Arguments
encoded url:
encoded URL (string).
Returns
URL (string) in a regular representation.Examples
- Result
url_encode
The function converts characters of the input URL into a format that can be transmitted over the Internet.Arguments
- url: input URL (string).
Returns
URL (string) converted into a format that can be transmitted over the Internet.Examples
- Result
gettype
Returns the runtime type of its single argument.Arguments
- Expressions
Returns
A string representing the runtime type of its single argument.Examples
Expression | Returns |
---|---|
gettype(“lima”) | string |
gettype(2222) | int |
gettype(5==5) | bool |
gettype(now()) | datetime |
gettype(parse_json(‘67’)) | int |
gettype(parse_json(’ “polish” ‘)) | string |
gettype(parse_json(’ {“axiom”:1234} ‘)) | dictionary |
gettype(parse_json(’ [6, 7, 8] ‘)) | array |
gettype(456.98) | real |
gettype(parse_json(”)) | null |
parse_csv
Splits a given string representing a single record of comma-separated values and returns a string array with these values.Arguments
- csv_text: A string representing a single record of comma-separated values.