Date Functions

date_day
Returns the day of the month of a specified date.

date_day_of_month
Returns the day of the month of a specified date. (Recommended instead of
date_day)

date_day_of_week
Returns the numeric day of the week of a specified date.

date_day_of_year
Returns the numeric day in the year of a specified date.

date_month
Returns the numeric month of the year in a specified date.n

date_month_end
Returns the last day of a specified month.

date_to_int
Returns the number of days from a specified date relative to January 1, 1900.

date_year
Returns the year of a specified date.

datetime_add
Returns the result of adding a specified number of days, hours, minutes, seconds,
and microseconds to the value of a date.

datetime_day
Returns the number of the day of the month in a specified date.

datetime_day_of_month
Returns the number of the day of the month in a specified date. (Recommended
instead of datetime_day)

datetime_day_of_week
Returns the day of the week of a specified date.

datetime_day_of_year
Returns the day of the year in a specified date.

datetime_difference
Returns a record representing the difference between two specified dates.

datetime_hour
Returns the hour of a specified date.

datetime_microsecond
Returns the microseconds of a specified date.

datetime_minute
Returns the minutes of a specified date.

datetime_month
Returns the numeric month of the year of a specified date.
datetime_second
Returns the seconds of a specified datetime.

datetime_year
Returns the year of a specified date.

-----------------------------------------------------------------------------------
---------
String functions

char_string
Returns a one-character native string that corresponds to the specified character
code.

decimal_lpad
Returns a decimal string of the specified length or longer, left-padded with a
specified character as needed.

decimal_lrepad
Returns a decimal string of the specified length or longer, left-padded with a
specified character as needed and trimmed of leading zeros.

decimal_strip
Returns a decimal from a string that has been trimmed of leading zeros and non-
numeric characters.

is_blank
Tests whether a string contains only blank characters.

is_bzero
Tests whether an object is composed of all binary zero bytes.

re_index
Returns the index of the first character of a substring of a target string that
matches a specified regular expression.

re_replace
Replaces all substrings in a target string that match a specified regular
expression.

string_char
Returns the character code of a specific character in a string.

string_compare
Returns a number representing the result of comparing two strings.

string_concat
Concatenates multiple string arguments and returns a NUL-delimited string.

string_downcase
Returns a string with any uppercase letters converted to lowercase.

string_filter
Compares the contents of two strings and returns a string containing characters
that appear in both of them.
string_length
Returns the number of characters in a string.

string_lpad
Returns a string of a specified length, left-padded with a given character.

string_lrepad
Returns a string of a specified length, trimmed of leading and trailing blanks and
left-padded with a given character.

string_lrtrim
Returns a string trimmed of leading and trailing blank characters.

string_ltrim
Returns a string trimmed of leading blank characters.

string_pad
Returns a right-padded string.

string_replace_first
Returns a string after replacing the first occurrence of one substring with
another.

string_substring
Returns a substring of a string.

re_replace_first
Replaces the first substring in a target string that matches a specified regular
expression.

string_trim
Returns a string trimmed of trailing blank characters.

string_upcase
Returns a string with any lowercase letters converted to uppercase.

-----------------------------------------------------------------------------------
--------------------

Inquiry and Error Functions

fail_if_error
-Another name for the null_if_error function.
-Produces a NULL value instead of an error if all input expressions fail. The
input expressions must all be of the same or compatible types.

force_error
Produces an error, and sends the specified error message and error code to the
component’s error-handling port.

is_defined
Tests whether an expression results in a non-NULL value.
is_error
Tests whether an error occurs while evaluating an expression.

is_failure
This is an outdated name for the is_null function.

is_null
Tests whether an expression results in a NULL value.

is_valid
Tests whether the result of an input expression is valid or — when called on a
record or union — calls all validation fields (if any) in the record or union.

length_of
Returns the length of a value.

first_defined
Returns the first defined (non-NULL) input value.

size_of
Returns the size of a specified value in bytes, including delimiter characters.

write_to_log
Writes text to the log port of a component.

write_to_log_file
Writes a message to a log file.

-----------------------------------------------------------------------------------
--------------------
Math Function

ceiling
Returns the smallest integer value greater than or equal to a specified value.

decimal_round
Returns a number rounded to a specified number of places to the right of the
decimal point.

decimal_round_down
Returns a number rounded down to a specified number of places to the right of the
decimal point.

decimal_round_up
Returns a number rounded up to a specified number of places to the right of the
decimal point.

decimal_truncate
Returns a number truncated to a specified number of places to the right of the
decimal point.

floor
Returns the largest integer value less than or equal to a specified value.
math_abs
Returns the absolute value of a specified number.

math_acos
Returns the arc cosine of an angle in radians.

math_asin
Returns the arc sine of an angle in radians.

math_atan
Returns the arc tangent of an angle in radians.

math_cos
Returns the cosine of an angle in radians.

math_cosh
Returns the hyperbolic cosine of an angle in radians.

math_exp
Returns ex, where e is the base of the natural logarithm (approximately 2.718) and
x is a specified exponent value.

math_finite
Tests whether a number is not Infinity and not NaN (not a number).

math_log
Returns the natural logarithm of a number (that is, with base e).

math_log10
Returns the common logarithm (base 10) of a number.

math_pow
Returns a number raised to a specified power.

math_sin
Returns the sine of an angle in radians.

math_sinh
Returns the hyperbolic sine of an angle in radians.

math_sqrt
Returns the square root of a number.

math_tan
Returns the tangent of an angle in radians.

math_tanh
Returns the hyperbolic tangent of an angle in radians.

-----------------------------------------------------------------------------------
--------------------
Lookup functions

lookup
Returns the first record from a lookup file that matches a specified expression.

lookup_count
Returns the number of records in a lookup file that matches a specified
expression.

lookup_local
Behaves like lookup, except that this function searches only one partition of a
lookup file.

lookup_count_local
Behaves the same as lookup_count, except that this function searches only one
partition in a lookup file.

lookup_match
Searches for records matching a specified expression in a lookup file.

lookup_next
Returns the next successive matching record or the next successive record in a
range, if any, that appears in the lookup file.

lookup_next_local
Behaves the same as lookup_next, except that this function searches only one
partition in a lookup file.

-----------------------------------------------------------------------------------
-----------------

Miscellaneous functions

allocate_with_defaults (or allocate)

ddl_name_to_dml_name
Returns a valid DML field name from a database column name.

ddl_to_dml
Returns a string containing a DML type specifier from the column definition of a
database.

hash_value
Returns the hash code of a DML object. If the object is a record type, returns the
hash code of the record using the specified key.

next_in_sequence
Returns a sequence of integers on successive calls, starting with 1.

number_of_partitions
Returns the number of partitions.

printf
Returns a string of reformatted input values. Use this function only for returning
specialized C-like output — for example, when you need to convert values to octal
or scientific notation format.

random
Returns a random integer greater than or equal to 0 and less than the specified
upper range.

raw_data_concat
Returns a length-prefixed void object from multiple input objects. Use when
passing a sequence of bytes where the data types are not important or will be
translated later — for example, external message formats or file formats that are
difficult to describe with DML.

raw_data_substring
Returns a length-prefixed void object composed of a substring of an input object.

scanf_float
Returns the value of a string as a float parsed according to a specified format.

scanf_int
Returns the value of a string as an integer parsed according to a specified
format.

scanf_string
Returns the value of a string as a string parsed according to a specified format.

unpack_nibbles
Returns a length-prefixed void object by converting nibbles to bytes.