DSL built-in functions - Miller

<div> Quick links:   <a class="quicklink" href="../reference-main-flag-list/index.html">Flags</a>   <a class="quicklink" href="../reference-verbs/index.html">Verbs</a>   <a class="quicklink" href="../reference-dsl-builtin-functions/index.html">Functions</a>   <a class="quicklink" href="../glossary/index.html">Glossary</a>   <a class="quicklink" href="../release-docs/index.html">Release docs</a> </div> # DSL built-in functions

These are functions in the Miller programming language that you can call when you use mlr put and mlr filter. For example, when you type

<pre class="pre-highlight-in-pair"> mlr --icsv --opprint --from example.csv put ' $color = toupper($color); $shape = gsub($shape, "[aeiou]", "*"); ' </pre> <pre class="pre-non-highlight-in-pair"> color shape flag k index quantity rate YELLOW tr**ngl* true 1 11 43.6498 9.8870 RED sq**r* true 2 15 79.2778 0.0130 RED c*rcl* true 3 16 13.8103 2.9010 RED sq**r* false 4 48 77.5542 7.4670 PURPLE tr**ngl* false 5 51 81.2290 8.5910 RED sq**r* false 6 64 77.1991 9.5310 PURPLE tr**ngl* false 7 65 80.1405 5.8240 YELLOW c*rcl* true 8 73 63.9785 4.2370 YELLOW c*rcl* true 9 87 63.5058 8.3350 PURPLE sq**r* false 10 91 72.3735 8.2430 </pre>

the toupper and gsub bits are functions.

Overview

At the command line, you can use mlr -f and mlr -F for information much like what's on this page.

Each function takes a specific number of arguments, as shown below, except for functions marked as variadic, such as min and max. (The latter compute the min and max of any number of arguments.) There is no notion of optional or default-on-absent arguments. All argument-passing is positional rather than by name; arguments are passed by value, not by reference.

At the command line, you can get a list of all functions using mlr -f, with details using mlr -F. (Or, mlr help usage-functions-by-class to get details in the order shown on this page.) You can get details for a given function using mlr help function namegoeshere, e.g., mlr help function gsub.

Operators are listed here along with functions. In this case, the argument count refers to the number of items involved in the infix operator. For example, we say x+y, so the details for the + operator indicate that it has two arguments. Unary operators such as ! and ~ show argument-count of 1; the ternary ? : operator shows an argument count of 3.

Functions by class

Arithmetic functions: bitcount, madd, mexp, mmul, msub, pow, %, &, *, **, +, -, .*, .+, .-, ./, /, //, <<, >>, >>>, ^, |, ~.
Boolean functions: !, !=, !=~, &&, <, <=, <=>, ==, =~, >, >=, ?:, ??, ???, ^^, ||.
Collections functions: append, arrayify, concat, depth, flatten, get_keys, get_values, haskey, hasvalue, json_parse, json_stringify, leafcount, length, mapdiff, mapexcept, mapselect, mapsum, unflatten.
Conversion functions: boolean, float, fmtifnum, fmtnum, hexfmt, int, joink, joinkv, joinv, splita, splitax, splitkv, splitkvx, splitnv, splitnvx, string.
Hashing functions: md5, sha1, sha256, sha512.
Higher-order-functions functions: any, apply, every, fold, reduce, select, sort.
Math functions: abs, acos, acosh, asin, asinh, atan, atan2, atanh, cbrt, ceil, cos, cosh, erf, erfc, exp, expm1, floor, invqnorm, log, log10, log1p, logifit, max, min, qnorm, round, roundm, sgn, sin, sinh, sqrt, tan, tanh, urand, urand32, urandelement, urandint, urandrange.
Stats functions: antimode, count, distinct_count, kurtosis, maxlen, mean, meaneb, median, minlen, mode, null_count, percentile, percentiles, skewness, sort_collection, stddev, sum, sum2, sum3, sum4, variance.
String functions: capitalize, clean_whitespace, collapse_whitespace, contains, format, gssub, gsub, index, latin1_to_utf8, leftpad, lstrip, regextract, regextract_or_else, rightpad, rstrip, ssub, strip, strlen, strmatch, strmatchx, sub, substr, substr0, substr1, tolower, toupper, truncate, unformat, unformatx, utf8_to_latin1, ..
System functions: exec, hostname, next, os, stat, system, version.
Time functions: dhms2fsec, dhms2sec, fsec2dhms, fsec2hms, gmt2localtime, gmt2nsec, gmt2sec, hms2fsec, hms2sec, localtime2gmt, localtime2nsec, localtime2sec, nsec2gmt, nsec2gmtdate, nsec2localdate, nsec2localtime, sec2dhms, sec2gmt, sec2gmtdate, sec2hms, sec2localdate, sec2localtime, strfntime, strfntime_local, strftime, strftime_local, strpntime, strpntime_local, strptime, strptime_local, sysntime, systime, systimeint, upntime, uptime.
Typing functions: asserting_absent, asserting_array, asserting_bool, asserting_boolean, asserting_empty, asserting_empty_map, asserting_error, asserting_float, asserting_int, asserting_map, asserting_nonempty_map, asserting_not_array, asserting_not_empty, asserting_not_map, asserting_not_null, asserting_null, asserting_numeric, asserting_present, asserting_string, is_absent, is_array, is_bool, is_boolean, is_empty, is_empty_map, is_error, is_float, is_int, is_map, is_nan, is_nonempty_map, is_not_array, is_not_empty, is_not_map, is_not_null, is_null, is_numeric, is_present, is_string, typeof.

Arithmetic functions

bitcount

<pre class="pre-non-highlight-non-pair"> bitcount (class=arithmetic #args=1) Count of 1-bits. </pre>

madd

<pre class="pre-non-highlight-non-pair"> madd (class=arithmetic #args=3) a + b mod m (integers) </pre>

mexp

<pre class="pre-non-highlight-non-pair"> mexp (class=arithmetic #args=3) a ** b mod m (integers) </pre>

mmul

<pre class="pre-non-highlight-non-pair"> mmul (class=arithmetic #args=3) a * b mod m (integers) </pre>

msub

<pre class="pre-non-highlight-non-pair"> msub (class=arithmetic #args=3) a - b mod m (integers) </pre>

pow

<pre class="pre-non-highlight-non-pair"> pow (class=arithmetic #args=2) Exponentiation. Same as **, but as a function. </pre>

%

<pre class="pre-non-highlight-non-pair"> % (class=arithmetic #args=2) Remainder; never negative-valued (pythonic). </pre>

&

<pre class="pre-non-highlight-non-pair"> & (class=arithmetic #args=2) Bitwise AND. </pre>

*

<pre class="pre-non-highlight-non-pair"> * (class=arithmetic #args=2) Multiplication, with integer*integer overflow to float. </pre>

**

<pre class="pre-non-highlight-non-pair"> ** (class=arithmetic #args=2) Exponentiation. Same as pow, but as an infix operator. </pre>

+

<pre class="pre-non-highlight-non-pair"> + (class=arithmetic #args=1,2) Addition as binary operator; unary plus operator. </pre>

-

<pre class="pre-non-highlight-non-pair"> - (class=arithmetic #args=1,2) Subtraction as binary operator; unary negation operator. </pre>

.*

<pre class="pre-non-highlight-non-pair"> .* (class=arithmetic #args=2) Multiplication, with integer-to-integer overflow. </pre>

.+

<pre class="pre-non-highlight-non-pair"> .+ (class=arithmetic #args=2) Addition, with integer-to-integer overflow. </pre>

.-

<pre class="pre-non-highlight-non-pair"> .- (class=arithmetic #args=2) Subtraction, with integer-to-integer overflow. </pre>

./

<pre class="pre-non-highlight-non-pair"> ./ (class=arithmetic #args=2) Integer division, rounding toward zero. </pre>

/

<pre class="pre-non-highlight-non-pair"> / (class=arithmetic #args=2) Division. Integer / integer is integer when exact, else floating-point: e.g. 6/3 is 2 but 6/4 is 1.5. </pre>

//

<pre class="pre-non-highlight-non-pair"> // (class=arithmetic #args=2) Pythonic integer division, rounding toward negative. </pre>

<<

>>

<pre class="pre-non-highlight-non-pair"> >> (class=arithmetic #args=2) Bitwise signed right-shift. </pre>

>>>

<pre class="pre-non-highlight-non-pair"> >>> (class=arithmetic #args=2) Bitwise unsigned right-shift. </pre>

^

<pre class="pre-non-highlight-non-pair"> ^ (class=arithmetic #args=2) Bitwise XOR. </pre>

|

<pre class="pre-non-highlight-non-pair"> | (class=arithmetic #args=2) Bitwise OR. </pre>

~

<pre class="pre-non-highlight-non-pair"> ~ (class=arithmetic #args=1) Bitwise NOT. Beware '$y=~$x' since =~ is the regex-match operator: try '$y = ~$x'. </pre>

Boolean functions

!

<pre class="pre-non-highlight-non-pair"> ! (class=boolean #args=1) Logical negation. </pre>

!=

<pre class="pre-non-highlight-non-pair"> != (class=boolean #args=2) String/numeric inequality. Mixing number and string results in string compare. </pre>

!=~

<pre class="pre-non-highlight-non-pair"> !=~ (class=boolean #args=2) String (left-hand side) does not match regex (right-hand side), e.g. '$name !=~ "^a.*b$"'. </pre>

&&

<pre class="pre-non-highlight-non-pair"> && (class=boolean #args=2) Logical AND. </pre>

<

<=

<=>

<pre class="pre-non-highlight-non-pair"> <=> (class=boolean #args=2) Comparator, nominally for sorting. Given a <=> b, returns <0, 0, >0 as a < b, a == b, or a > b, respectively. </pre>

==

<pre class="pre-non-highlight-non-pair"> == (class=boolean #args=2) String/numeric equality. Mixing number and string results in string compare. </pre>

=~

<pre class="pre-non-highlight-non-pair"> =~ (class=boolean #args=2) String (left-hand side) matches regex (right-hand side), e.g. '$name =~ "^a.*b$"'. Capture groups \1 through \9 are matched from (...) in the right-hand side, and can be used within subsequent DSL statements. See also "Regular expressions" at https://miller.readthedocs.io. Examples: With if-statement: if ($url =~ "http.*com") { ... } Without if-statement: given $line = "index ab09 file", and $line =~ "([a-z][a-z])([0-9][0-9])", then $label = "[\1:\2]", $label is "[ab:09]" </pre>

>

<pre class="pre-non-highlight-non-pair"> > (class=boolean #args=2) String/numeric greater-than. Mixing number and string results in string compare. </pre>

>=

<pre class="pre-non-highlight-non-pair"> >= (class=boolean #args=2) String/numeric greater-than-or-equals. Mixing number and string results in string compare. </pre>

?:

<pre class="pre-non-highlight-non-pair"> ?: (class=boolean #args=3) Standard ternary operator. </pre>

??

<pre class="pre-non-highlight-non-pair"> ?? (class=boolean #args=2) Absent-coalesce operator. $a ?? 1 evaluates to 1 if $a isn't defined in the current record. </pre>

???

<pre class="pre-non-highlight-non-pair"> ??? (class=boolean #args=2) Absent/empty-coalesce operator. $a ??? 1 evaluates to 1 if $a isn't defined in the current record, or has empty value. </pre>

^^

<pre class="pre-non-highlight-non-pair"> ^^ (class=boolean #args=2) Logical XOR. </pre>

||

<pre class="pre-non-highlight-non-pair"> || (class=boolean #args=2) Logical OR. </pre>

Collections functions

append

<pre class="pre-non-highlight-non-pair"> append (class=collections #args=2) Appends second argument to end of first argument, which must be an array. </pre>

arrayify

<pre class="pre-non-highlight-non-pair"> arrayify (class=collections #args=1) Walks through a nested map/array, converting any map with consecutive keys "1", "2", ... into an array. Useful to wrap the output of unflatten. </pre>

concat

<pre class="pre-non-highlight-non-pair"> concat (class=collections #args=variadic) Returns the array concatenation of the arguments. Non-array arguments are treated as single-element arrays. Examples: concat(1,2,3) is [1,2,3] concat([1,2],3) is [1,2,3] concat([1,2],[3]) is [1,2,3] </pre>

depth

<pre class="pre-non-highlight-non-pair"> depth (class=collections #args=1) Prints maximum depth of map/array. Scalars have depth 0. </pre>

flatten

<pre class="pre-non-highlight-non-pair"> flatten (class=collections #args=2,3) Flattens multi-level maps to single-level ones. Useful for nested JSON-like structures for non-JSON file formats like CSV. With two arguments, the first argument is a map (maybe $*) and the second argument is the flatten separator. With three arguments, the first argument is prefix, the second is the flatten separator, and the third argument is a map; flatten($*, ".") is the same as flatten("", ".", $*). See "Flatten/unflatten: converting between JSON and tabular formats" at https://miller.readthedocs.io for more information. Examples: flatten({"a":[1,2],"b":3}, ".") is {"a.1": 1, "a.2": 2, "b": 3}. flatten("a", ".", {"b": { "c": 4 }}) is {"a.b.c" : 4}. flatten("", ".", {"a": { "b": 3 }}) is {"a.b" : 3}. </pre>

get_keys

<pre class="pre-non-highlight-non-pair"> get_keys (class=collections #args=1) Returns array of keys of map or array </pre>

get_values

<pre class="pre-non-highlight-non-pair"> get_values (class=collections #args=1) Returns array of values of map or array -- in the latter case, returns a copy of the array </pre>

haskey

<pre class="pre-non-highlight-non-pair"> haskey (class=collections #args=2) True/false if map has/hasn't key, e.g. 'haskey($*, "a")' or 'haskey(mymap, mykey)', or true/false if array index is in bounds / out of bounds. Error if 1st argument is not a map or array. Note -n..-1 alias to 1..n in Miller arrays. </pre>

hasvalue

<pre class="pre-non-highlight-non-pair"> hasvalue (class=collections #args=2) True/false if map/array has/hasn't value, e.g. 'hasvalue($*, "a")' or 'hasvalue(myarray, myvalue)', returns true if the value is present in the collection. Error if 1st argument is not a map or array. </pre>

json_parse

<pre class="pre-non-highlight-non-pair"> json_parse (class=collections #args=1) Converts value from JSON-formatted string. </pre>

json_stringify

<pre class="pre-non-highlight-non-pair"> json_stringify (class=collections #args=1,2) Converts value to JSON-formatted string. Default output is single-line. With optional second boolean argument set to true, produces multiline output. </pre>

leafcount

<pre class="pre-non-highlight-non-pair"> leafcount (class=collections #args=1) Counts total number of terminal values in map/array. For single-level map/array, same as length. </pre>

length

<pre class="pre-non-highlight-non-pair"> length (class=collections #args=1) Counts number of top-level entries in array/map. Scalars have length 1. </pre>

mapdiff

<pre class="pre-non-highlight-non-pair"> mapdiff (class=collections #args=variadic) With 0 args, returns empty map. With 1 arg, returns copy of arg. With 2 or more, returns copy of arg 1 with all keys from any of remaining argument maps removed. </pre>

mapexcept

<pre class="pre-non-highlight-non-pair"> mapexcept (class=collections #args=variadic) Returns a map with keys from remaining arguments, if any, unset. Remaining arguments can be strings or arrays of string. E.g. 'mapexcept({1:2,3:4,5:6}, 1, 5, 7)' is '{3:4}' and 'mapexcept({1:2,3:4,5:6}, [1, 5, 7])' is '{3:4}'. </pre>

mapselect

<pre class="pre-non-highlight-non-pair"> mapselect (class=collections #args=variadic) Returns a map with only keys from remaining arguments set. Remaining arguments can be strings or arrays of string. E.g. 'mapselect({1:2,3:4,5:6}, 1, 5, 7)' is '{1:2,5:6}' and 'mapselect({1:2,3:4,5:6}, [1, 5, 7])' is '{1:2,5:6}'. </pre>

mapsum

<pre class="pre-non-highlight-non-pair"> mapsum (class=collections #args=variadic) With 0 args, returns empty map. With >= 1 arg, returns a map with key-value pairs from all arguments. Rightmost collisions win, e.g. 'mapsum({1:2,3:4},{1:5})' is '{1:5,3:4}'. </pre>

unflatten

<pre class="pre-non-highlight-non-pair"> unflatten (class=collections #args=2) Reverses flatten. Useful for nested JSON-like structures for non-JSON file formats like CSV. The first argument is a map, and the second argument is the flatten separator. See also arrayify. See "Flatten/unflatten: converting between JSON and tabular formats" at https://miller.readthedocs.io for more information. Example: unflatten({"a.b.c" : 4}, ".") is {"a": "b": { "c": 4 }}. </pre>

Conversion functions

boolean

<pre class="pre-non-highlight-non-pair"> boolean (class=conversion #args=1) Convert int/float/bool/string to boolean. </pre>

float

<pre class="pre-non-highlight-non-pair"> float (class=conversion #args=1) Convert int/float/bool/string to float. </pre>

fmtifnum

<pre class="pre-non-highlight-non-pair"> fmtifnum (class=conversion #args=2) Identical to fmtnum, except returns the first argument as-is if the output would be an error. Examples: fmtifnum(3.4, "%.6f") gives 3.400000" fmtifnum("abc", "%.6f") gives abc" $* = fmtifnum($*, "%.6f") formats numeric fields in the current record, leaving non-numeric ones alone </pre>

fmtnum

<pre class="pre-non-highlight-non-pair"> fmtnum (class=conversion #args=2) Convert int/float/bool to string using printf-style format string (https://pkg.go.dev/fmt), e.g. '$s = fmtnum($n, "%08d")' or '$t = fmtnum($n, "%.6e")'. Miller-specific extension: "%_d" and "%_f" for comma-separated thousands. This function recurses on array and map values. Examples: $y = fmtnum($x, "%.6f") $o = fmtnum($n, "%d") $o = fmtnum($n, "%12d") $y = fmtnum($x, "%.6_f") $o = fmtnum($n, "%_d") $o = fmtnum($n, "%12_d") </pre>

hexfmt

<pre class="pre-non-highlight-non-pair"> hexfmt (class=conversion #args=1) Convert int to hex string, e.g. 255 to "0xff". </pre>

int

<pre class="pre-non-highlight-non-pair"> int (class=conversion #args=1,2) Convert int/float/bool/string to int. If the second argument is omitted and the first argument is a string, base is inferred from the first argument's prefix. If the second argument is provided and the first argument is a string, the second argument is used as the base. If the second argument is provided and the first argument is not a string, the second argument is ignored. Examples: int("345") gives decimal 345 (base-10/decimal input is inferred) int("0xff") gives decimal 255 (base-16/hexadecimal input is inferred) int("0377") gives decimal 255 (base-8/octal input is inferred) int("0b11010011") gives decimal 211 which is hexadecimal 0xd3 (base-2/binary input is inferred) int("0377", 10) gives decimal 377 int(345, 16) gives decimal 345 int(string(345), 16) gives decimal 837 </pre>

joink

<pre class="pre-non-highlight-non-pair"> joink (class=conversion #args=2) Makes string from map/array keys. First argument is map/array; second is separator string. Examples: joink({"a":3,"b":4,"c":5}, ",") = "a,b,c". joink([1,2,3], ",") = "1,2,3". </pre>

joinkv

<pre class="pre-non-highlight-non-pair"> joinkv (class=conversion #args=3) Makes string from map/array key-value pairs. First argument is map/array; second is pair-separator string; third is field-separator string. Mnemonic: the "=" comes before the "," in the output and in the arguments to joinkv. Examples: joinkv([3,4,5], "=", ",") = "1=3,2=4,3=5" joinkv({"a":3,"b":4,"c":5}, ":", ";") = "a:3;b:4;c:5" </pre>

joinv

<pre class="pre-non-highlight-non-pair"> joinv (class=conversion #args=2) Makes string from map/array values. First argument is map/array; second is separator string. Examples: joinv([3,4,5], ",") = "3,4,5" joinv({"a":3,"b":4,"c":5}, ",") = "3,4,5" </pre>

splita

<pre class="pre-non-highlight-non-pair"> splita (class=conversion #args=2) Splits string into array with type inference. First argument is string to split; second is the separator to split on. Example: splita("3,4,5", ",") = [3,4,5] </pre>

splitax

<pre class="pre-non-highlight-non-pair"> splitax (class=conversion #args=2) Splits string into array without type inference. First argument is string to split; second is the separator to split on. Example: splitax("3,4,5", ",") = ["3","4","5"] </pre>

splitkv

<pre class="pre-non-highlight-non-pair"> splitkv (class=conversion #args=3) Splits string by separators into map with type inference. First argument is string to split; second argument is pair separator; third argument is field separator. Example: splitkv("a=3,b=4,c=5", "=", ",") = {"a":3,"b":4,"c":5} </pre>

splitkvx

<pre class="pre-non-highlight-non-pair"> splitkvx (class=conversion #args=3) Splits string by separators into map without type inference (keys and values are strings). First argument is string to split; second argument is pair separator; third argument is field separator. Example: splitkvx("a=3,b=4,c=5", "=", ",") = {"a":"3","b":"4","c":"5"} </pre>

splitnv

<pre class="pre-non-highlight-non-pair"> splitnv (class=conversion #args=2) Splits string by separator into integer-indexed map with type inference. First argument is string to split; second argument is separator to split on. Example: splitnv("a,b,c", ",") = {"1":"a","2":"b","3":"c"} </pre>

splitnvx

<pre class="pre-non-highlight-non-pair"> splitnvx (class=conversion #args=2) Splits string by separator into integer-indexed map without type inference (values are strings). First argument is string to split; second argument is separator to split on. Example: splitnvx("3,4,5", ",") = {"1":"3","2":"4","3":"5"} </pre>

string

<pre class="pre-non-highlight-non-pair"> string (class=conversion #args=1) Convert int/float/bool/string/array/map to string. </pre>

Hashing functions

md5

<pre class="pre-non-highlight-non-pair"> md5 (class=hashing #args=1) MD5 hash. </pre>

sha1

<pre class="pre-non-highlight-non-pair"> sha1 (class=hashing #args=1) SHA1 hash. </pre>

sha256

<pre class="pre-non-highlight-non-pair"> sha256 (class=hashing #args=1) SHA256 hash. </pre>

sha512

<pre class="pre-non-highlight-non-pair"> sha512 (class=hashing #args=1) SHA512 hash. </pre>

Higher-order-functions functions

any

<pre class="pre-non-highlight-non-pair"> any (class=higher-order-functions #args=2) Given a map or array as first argument and a function as second argument, yields a boolean true if the argument function returns true for any array/map element, false otherwise. For arrays, the function should take one argument, for array element; for maps, it should take two, for map-element key and value. In either case it should return a boolean. Examples: Array example: any([10,20,30], func(e) {return $index == e}) Map example: any({"a": "foo", "b": "bar"}, func(k,v) {return $[k] == v}) </pre>

apply

<pre class="pre-non-highlight-non-pair"> apply (class=higher-order-functions #args=2) Given a map or array as first argument and a function as second argument, applies the function to each element of the array/map. For arrays, the function should take one argument, for array element; it should return a new element. For maps, it should take two arguments, for map-element key and value; it should return a new key-value pair (i.e. a single-entry map). Examples: Array example: apply([1,2,3,4,5], func(e) {return e ** 3}) returns [1, 8, 27, 64, 125]. Map example: apply({"a":1, "b":3, "c":5}, func(k,v) {return {toupper(k): v ** 2}}) returns {"A": 1, "B":9, "C": 25}", </pre>

every

<pre class="pre-non-highlight-non-pair"> every (class=higher-order-functions #args=2) Given a map or array as first argument and a function as second argument, yields a boolean true if the argument function returns true for every array/map element, false otherwise. For arrays, the function should take one argument, for array element; for maps, it should take two, for map-element key and value. In either case it should return a boolean. Examples: Array example: every(["a", "b", "c"], func(e) {return $[e] >= 0}) Map example: every({"a": "foo", "b": "bar"}, func(k,v) {return $[k] == v}) </pre>

fold

<pre class="pre-non-highlight-non-pair"> fold (class=higher-order-functions #args=3) Given a map or array as first argument and a function as second argument, accumulates entries into a final output -- for example, sum or product. For arrays, the function should take two arguments, for accumulated value and array element. For maps, it should take four arguments, for accumulated key and value, and map-element key and value; it should return the updated accumulator as a new key-value pair (i.e. a single-entry map). The start value for the accumulator is taken from the third argument. Examples: Array example: fold([1,2,3,4,5], func(acc,e) {return acc + e**3}, 10000) returns 10225. Map example: fold({"a":1, "b":3, "c": 5}, func(acck,accv,ek,ev) {return {"sum": accv+ev**2}}, {"sum":10000}) returns 10035. </pre>

reduce

<pre class="pre-non-highlight-non-pair"> reduce (class=higher-order-functions #args=2) Given a map or array as first argument and a function as second argument, accumulates entries into a final output -- for example, sum or product. For arrays, the function should take two arguments, for accumulated value and array element, and return the accumulated element. For maps, it should take four arguments, for accumulated key and value, and map-element key and value; it should return the updated accumulator as a new key-value pair (i.e. a single-entry map). The start value for the accumulator is the first element for arrays, or the first element's key-value pair for maps. Examples: Array example: reduce([1,2,3,4,5], func(acc,e) {return acc + e**3}) returns 225. Map example: reduce({"a":1, "b":3, "c": 5}, func(acck,accv,ek,ev) {return {"sum_of_squares": accv + ev**2}}) returns {"sum_of_squares": 35}. </pre>

select

<pre class="pre-non-highlight-non-pair"> select (class=higher-order-functions #args=2) Given a map or array as first argument and a function as second argument, includes each input element in the output if the function returns true. For arrays, the function should take one argument, for array element; for maps, it should take two, for map-element key and value. In either case it should return a boolean. Examples: Array example: select([1,2,3,4,5], func(e) {return e >= 3}) returns [3, 4, 5]. Map example: select({"a":1, "b":3, "c":5}, func(k,v) {return v >= 3}) returns {"b":3, "c": 5}. </pre>

sort

<pre class="pre-non-highlight-non-pair"> sort (class=higher-order-functions #args=1-2) Given a map or array as first argument and string flags or function as optional second argument, returns a sorted copy of the input. With one argument, sorts array elements with numbers first numerically and then strings lexically, and map elements likewise by map keys. If the second argument is a string, it can contain any of "f" for lexical ("n" is for the above default), "c" for case-folded lexical, or "t" for natural sort order. An additional "r" in that string is for reverse. An additional "v" in that string means sort maps by value, rather than by key. If the second argument is a function, then for arrays it should take two arguments a and b, returning < 0, 0, or > 0 as a < b, a == b, or a > b respectively; for maps the function should take four arguments ak, av, bk, and bv, again returning < 0, 0, or > 0, using a and b's keys and values. Examples: Default sorting: sort([3,"A",1,"B",22]) returns [1, 3, 20, "A", "B"]. Note that this is numbers before strings. Default sorting: sort(["E","a","c","B","d"]) returns ["B", "E", "a", "c", "d"]. Note that this is uppercase before lowercase. Case-folded ascending: sort(["E","a","c","B","d"], "c") returns ["a", "B", "c", "d", "E"]. Case-folded descending: sort(["E","a","c","B","d"], "cr") returns ["E", "d", "c", "B", "a"]. Natural sorting: sort(["a1","a10","a100","a2","a20","a200"], "t") returns ["a1", "a2", "a10", "a20", "a100", "a200"]. Array with function: sort([5,2,3,1,4], func(a,b) {return b <=> a}) returns [5,4,3,2,1]. Map with function: sort({"c":2,"a":3,"b":1}, func(ak,av,bk,bv) {return bv <=> av}) returns {"a":3,"c":2,"b":1}. Map without function: sort({"c":2,"a":3,"b":1}) returns {"a":3,"b":1,"c":2}. Map without function: sort({"c":2,"a":3,"b":1}, "v") returns {"b":1,"c":2,"a":3}. Map without function: sort({"c":2,"a":3,"b":1}, "vnr") returns {"a":3,"c":2,"b":1}. </pre>

Math functions

abs

<pre class="pre-non-highlight-non-pair"> abs (class=math #args=1) Absolute value. </pre>

acos

<pre class="pre-non-highlight-non-pair"> acos (class=math #args=1) Inverse trigonometric cosine. </pre>

acosh

<pre class="pre-non-highlight-non-pair"> acosh (class=math #args=1) Inverse hyperbolic cosine. </pre>

asin

<pre class="pre-non-highlight-non-pair"> asin (class=math #args=1) Inverse trigonometric sine. </pre>

asinh

<pre class="pre-non-highlight-non-pair"> asinh (class=math #args=1) Inverse hyperbolic sine. </pre>

atan

<pre class="pre-non-highlight-non-pair"> atan (class=math #args=1) One-argument arctangent. </pre>

atan2

<pre class="pre-non-highlight-non-pair"> atan2 (class=math #args=2) Two-argument arctangent. </pre>

atanh

<pre class="pre-non-highlight-non-pair"> atanh (class=math #args=1) Inverse hyperbolic tangent. </pre>

cbrt

<pre class="pre-non-highlight-non-pair"> cbrt (class=math #args=1) Cube root. </pre>

ceil

<pre class="pre-non-highlight-non-pair"> ceil (class=math #args=1) Ceiling: nearest integer at or above. </pre>

cos

<pre class="pre-non-highlight-non-pair"> cos (class=math #args=1) Trigonometric cosine. </pre>

cosh

<pre class="pre-non-highlight-non-pair"> cosh (class=math #args=1) Hyperbolic cosine. </pre>

erf

<pre class="pre-non-highlight-non-pair"> erf (class=math #args=1) Error function. </pre>

erfc

<pre class="pre-non-highlight-non-pair"> erfc (class=math #args=1) Complementary error function. </pre>

exp

<pre class="pre-non-highlight-non-pair"> exp (class=math #args=1) Exponential function e**x. </pre>

expm1

<pre class="pre-non-highlight-non-pair"> expm1 (class=math #args=1) e**x - 1. </pre>

floor

<pre class="pre-non-highlight-non-pair"> floor (class=math #args=1) Floor: nearest integer at or below. </pre>

invqnorm

<pre class="pre-non-highlight-non-pair"> invqnorm (class=math #args=1) Inverse of normal cumulative distribution function. Note that invqorm(urand()) is normally distributed. </pre>

log

<pre class="pre-non-highlight-non-pair"> log (class=math #args=1) Natural (base-e) logarithm. </pre>

log10

<pre class="pre-non-highlight-non-pair"> log10 (class=math #args=1) Base-10 logarithm. </pre>

log1p

<pre class="pre-non-highlight-non-pair"> log1p (class=math #args=1) log(1-x). </pre>

logifit

<pre class="pre-non-highlight-non-pair"> logifit (class=math #args=3) Given m and b from logistic regression, compute fit: $yhat=logifit($x,$m,$b). </pre>

max

<pre class="pre-non-highlight-non-pair"> max (class=math #args=variadic) Max of n numbers; null loses. The min and max functions also recurse into arrays and maps, so they can be used to get min/max stats on array/map values. </pre>

min

<pre class="pre-non-highlight-non-pair"> min (class=math #args=variadic) Min of n numbers; null loses. The min and max functions also recurse into arrays and maps, so they can be used to get min/max stats on array/map values. </pre>

qnorm

<pre class="pre-non-highlight-non-pair"> qnorm (class=math #args=1) Normal cumulative distribution function. </pre>

round

<pre class="pre-non-highlight-non-pair"> round (class=math #args=1) Round to nearest integer. </pre>

roundm

<pre class="pre-non-highlight-non-pair"> roundm (class=math #args=2) Round to nearest multiple of m: roundm($x,$m) is the same as round($x/$m)*$m. </pre>

sgn

<pre class="pre-non-highlight-non-pair"> sgn (class=math #args=1) +1, 0, -1 for positive, zero, negative input respectively. </pre>

sin

<pre class="pre-non-highlight-non-pair"> sin (class=math #args=1) Trigonometric sine. </pre>

sinh

<pre class="pre-non-highlight-non-pair"> sinh (class=math #args=1) Hyperbolic sine. </pre>

sqrt

<pre class="pre-non-highlight-non-pair"> sqrt (class=math #args=1) Square root. </pre>

tan

<pre class="pre-non-highlight-non-pair"> tan (class=math #args=1) Trigonometric tangent. </pre>

tanh

<pre class="pre-non-highlight-non-pair"> tanh (class=math #args=1) Hyperbolic tangent. </pre>

urand

<pre class="pre-non-highlight-non-pair"> urand (class=math #args=0) Floating-point numbers uniformly distributed on the unit interval. Example: Int-valued example: '$n=floor(20+urand()*11)'. </pre>

urand32

<pre class="pre-non-highlight-non-pair"> urand32 (class=math #args=0) Integer uniformly distributed 0 and 2**32-1 inclusive. </pre>

urandelement

<pre class="pre-non-highlight-non-pair"> urandelement (class=math #args=1) Random sample from the first argument, which must be an non-empty array. </pre>

urandint

<pre class="pre-non-highlight-non-pair"> urandint (class=math #args=2) Integer uniformly distributed between inclusive integer endpoints. </pre>

urandrange

<pre class="pre-non-highlight-non-pair"> urandrange (class=math #args=2) Floating-point numbers uniformly distributed on the interval [a, b). </pre>

Stats functions

antimode

<pre class="pre-non-highlight-non-pair"> antimode (class=stats #args=1) Returns the least frequently occurring value in an array or map. Returns error for non-array/non-map types. Values are stringified for comparison, so for example string "1" and integer 1 are not distinct. In cases of ties, first-found wins. Examples: antimode([3,3,4,4,4]) is 3 antimode([3,3,4,4]) is 3 </pre>

count

<pre class="pre-non-highlight-non-pair"> count (class=stats #args=1) Returns the length of an array or map. Returns error for non-array/non-map types. Examples: count([7,8,9]) is 3 count({"a":7,"b":8,"c":9}) is 3 </pre>

distinct_count

<pre class="pre-non-highlight-non-pair"> distinct_count (class=stats #args=1) Returns the number of disinct values in an array or map. Returns error for non-array/non-map types. Values are stringified for comparison, so for example string "1" and integer 1 are not distinct. Examples: distinct_count([7,8,9,7]) is 3 distinct_count([1,"1"]) is 1 distinct_count([1,1.0]) is 2 </pre>

kurtosis

<pre class="pre-non-highlight-non-pair"> kurtosis (class=stats #args=1) Returns the sample kurtosis of values in an array or map. Returns empty string AKA void for array/map of length less than two; returns error for non-array/non-map types. Example: kurtosis([4,5,9,10,11]) is -1.6703688 </pre>

maxlen

<pre class="pre-non-highlight-non-pair"> maxlen (class=stats #args=1) Returns the maximum string length of values in an array or map. Returns empty string AKA void for array/map of length less than two; returns error for non-array/non-map types. Example: maxlen(["año", "alto"]) is 4 </pre>

mean

<pre class="pre-non-highlight-non-pair"> mean (class=stats #args=1) Returns the arithmetic mean of values in an array or map. Returns empty string AKA void for empty array/map; returns error for non-array/non-map types. Example: mean([4,5,7,10]) is 6.5 </pre>

meaneb

<pre class="pre-non-highlight-non-pair"> meaneb (class=stats #args=1) Returns the error bar for arithmetic mean of values in an array or map, assuming the values are independent and identically distributed. Returns empty string AKA void for array/map of length less than two; returns error for non-array/non-map types. Example: meaneb([4,5,7,10]) is 1.3228756 </pre>

median

<pre class="pre-non-highlight-non-pair"> median (class=stats #args=1,2) Returns the median of values in an array or map. Returns empty string AKA void for empty array/map; returns error for non-array/non-map types. Please see the percentiles function for information on optional flags, and on performance for large inputs. Examples: median([3,4,5,6,9,10]) is 6 median([3,4,5,6,9,10],{"interpolate_linearly":true}) is 5.5 median(["abc", "def", "ghi", "ghi"]) is "ghi" </pre>

minlen

<pre class="pre-non-highlight-non-pair"> minlen (class=stats #args=1) Returns the minimum string length of values in an array or map. Returns empty string AKA void for array/map of length less than two; returns error for non-array/non-map types. Example: minlen(["año", "alto"]) is 3 </pre>

mode

<pre class="pre-non-highlight-non-pair"> mode (class=stats #args=1) Returns the most frequently occurring value in an array or map. Returns error for non-array/non-map types. Values are stringified for comparison, so for example string "1" and integer 1 are not distinct. In cases of ties, first-found wins. Examples: mode([3,3,4,4,4]) is 4 mode([3,3,4,4]) is 3 </pre>

null_count

<pre class="pre-non-highlight-non-pair"> null_count (class=stats #args=1) Returns the number of values in an array or map which are empty-string (AKA void) or JSON null. Returns error for non-array/non-map types. Values are stringified for comparison, so for example string "1" and integer 1 are not distinct. Example: null_count(["a", "", "c"]) is 1 </pre>

percentile

<pre class="pre-non-highlight-non-pair"> percentile (class=stats #args=2,3) Returns the given percentile of values in an array or map. Returns empty string AKA void for empty array/map; returns error for non-array/non-map types. Please see the percentiles function for information on optional flags, and on performance for large inputs. Examples: percentile([3,4,5,6,9,10], 90) is 10 percentile([3,4,5,6,9,10], 90, {"interpolate_linearly":true}) is 9.5 percentile(["abc", "def", "ghi", "ghi"], 90) is "ghi" </pre>

percentiles

<pre class="pre-non-highlight-non-pair"> percentiles (class=stats #args=2,3) Returns the given percentiles of values in an array or map. Returns empty string AKA void for empty array/map; returns error for non-array/non-map types. See examples for information on the three option flags. Examples: Defaults are to not interpolate linearly, to produce a map keyed by percentile name, and to sort the input before computing percentiles: percentiles([3,4,5,6,9,10], [25,75]) is { "25": 4, "75": 9 } percentiles(["abc", "def", "ghi", "ghi"], [25,75]) is { "25": "def", "75": "ghi" } Use "output_array_not_map" (or shorthand "oa") to get the outputs as an array: percentiles([3,4,5,6,9,10], [25,75], {"output_array_not_map":true}) is [4, 9] Use "interpolate_linearly" (or shorthand "il") to do linear interpolation -- note this produces error values on string inputs: percentiles([3,4,5,6,9,10], [25,75], {"interpolate_linearly":true}) is { "25": 4.25, "75": 8.25 } The percentiles function always sorts its inputs before computing percentiles. If you know your input is already sorted -- see also the sort_collection function -- then computation will be faster on large input if you pass in "array_is_sorted" (shorthand: "ais"): x = [6,5,9,10,4,3] percentiles(x, [25,75], {"ais":true}) gives { "25": 5, "75": 4 } which is incorrect x = sort_collection(x) percentiles(x, [25,75], {"ais":true}) gives { "25": 4, "75": 9 } which is correct You can also leverage this feature to compute percentiles on a sort of your choosing. For example: Non-sorted input: x = splitax("the quick brown fox jumped loquaciously over the lazy dogs", " ") x is: ["the", "quick", "brown", "fox", "jumped", "loquaciously", "over", "the", "lazy", "dogs"] Percentiles are taken over the original positions of the words in the array -- "dogs" is last and hence appears as p99: percentiles(x, [50, 99], {"oa":true, "ais":true}) gives ["loquaciously", "dogs"] With sorting done inside percentiles, "the" is alphabetically last and is therefore the p99: percentiles(x, [50, 99], {"oa":true}) gives ["loquaciously", "the"] With default sorting done outside percentiles, the same: x = sort(x) # or x = sort_collection(x) x is: ["brown", "dogs", "fox", "jumped", "lazy", "loquaciously", "over", "quick", "the", "the"] percentiles(x, [50, 99], {"oa":true, "ais":true}) gives ["loquaciously", "the"] percentiles(x, [50, 99], {"oa":true}) gives ["loquaciously", "the"] Now sorting by word length, "loquaciously" is longest and hence is the p99: x = sort(x, func(a,b) { return strlen(a) <=> strlen(b) } ) x is: ["fox", "the", "the", "dogs", "lazy", "over", "brown", "quick", "jumped", "loquaciously"] percentiles(x, [50, 99], {"oa":true, "ais":true}) ["over", "loquaciously"] </pre>

skewness

<pre class="pre-non-highlight-non-pair"> skewness (class=stats #args=1) Returns the sample skewness of values in an array or map. Returns empty string AKA void for array/map of length less than two; returns error for non-array/non-map types. Example: skewness([4,5,9,10,11]) is -0.2097285 </pre>

sort_collection

<pre class="pre-non-highlight-non-pair"> sort_collection (class=stats #args=1) This is a helper function for the percentiles function; please see its online help for details. </pre>

stddev

<pre class="pre-non-highlight-non-pair"> stddev (class=stats #args=1) Returns the sample standard deviation of values in an array or map. Returns empty string AKA void for array/map of length less than two; returns error for non-array/non-map types. Example: stddev([4,5,9,10,11]) is 3.1144823 </pre>

sum

<pre class="pre-non-highlight-non-pair"> sum (class=stats #args=1) Returns the sum of values in an array or map. Returns error for non-array/non-map types. Example: sum([1,2,3,4,5]) is 15 </pre>

sum2

<pre class="pre-non-highlight-non-pair"> sum2 (class=stats #args=1) Returns the sum of squares of values in an array or map. Returns error for non-array/non-map types. Example: sum2([1,2,3,4,5]) is 55 </pre>

sum3

<pre class="pre-non-highlight-non-pair"> sum3 (class=stats #args=1) Returns the sum of cubes of values in an array or map. Returns error for non-array/non-map types. Example: sum3([1,2,3,4,5]) is 225 </pre>

sum4

<pre class="pre-non-highlight-non-pair"> sum4 (class=stats #args=1) Returns the sum of fourth powers of values in an array or map. Returns error for non-array/non-map types. Example: sum4([1,2,3,4,5]) is 979 </pre>

variance

<pre class="pre-non-highlight-non-pair"> variance (class=stats #args=1) Returns the sample variance of values in an array or map. Returns empty string AKA void for array/map of length less than two; returns error for non-array/non-map types. Example: variance([4,5,9,10,11]) is 9.7 </pre>

String functions

capitalize

<pre class="pre-non-highlight-non-pair"> capitalize (class=string #args=1) Convert string's first character to uppercase. </pre>

clean_whitespace

<pre class="pre-non-highlight-non-pair"> clean_whitespace (class=string #args=1) Same as collapse_whitespace and strip, followed by type inference. </pre>

collapse_whitespace

<pre class="pre-non-highlight-non-pair"> collapse_whitespace (class=string #args=1) Strip repeated whitespace from string. </pre>

contains

<pre class="pre-non-highlight-non-pair"> contains (class=string #args=2) Returns true if the first argument contains the second as a substring. This is like saying `index(arg1, arg2) >= 0`but with less keystroking. Examples: contains("abcde", "e") gives true contains("abcde", "x") gives false contains(12345, 34) gives true contains("forêt", "ê") gives true </pre>

format

<pre class="pre-non-highlight-non-pair"> format (class=string #args=variadic) Using first argument as format string, interpolate remaining arguments in place of each "{}" in the format string. Too-few arguments are treated as the empty string; too-many arguments are discarded. Examples: format("{}:{}:{}", 1,2) gives "1:2:". format("{}:{}:{}", 1,2,3) gives "1:2:3". format("{}:{}:{}", 1,2,3,4) gives "1:2:3". </pre>

gssub

<pre class="pre-non-highlight-non-pair"> gssub (class=string #args=3) Like gsub but does no regexing. No characters are special. Example: gssub("ab.d.fg", ".", "X") gives "abXdXfg" </pre>

gsub

<pre class="pre-non-highlight-non-pair"> gsub (class=string #args=3) '$name = gsub($name, "old", "new")': replace all, with support for regular expressions. Capture groups \1 through \9 in the new part are matched from (...) in the old part, and must be used within the same call to gsub -- they don't persist for subsequent DSL statements. See also =~ and regextract. See also "Regular expressions" at https://miller.readthedocs.io. Examples: gsub("ababab", "ab", "XY") gives "XYXYXY" gsub("abc.def", ".", "X") gives "XXXXXXX" gsub("abc.def", "\.", "X") gives "abcXdef" gsub("abcdefg", "[ce]", "X") gives "abXdXfg" gsub("prefix4529:suffix8567", "(....ix)([0-9]+)", "[\1 : \2]") gives "[prefix : 4529]:[suffix : 8567]" </pre>

index

<pre class="pre-non-highlight-non-pair"> index (class=string #args=2) Returns the index (1-based) of the second argument within the first. Returns -1 if the second argument isn't a substring of the first. Stringifies non-string inputs. Uses UTF-8 encoding to count characters, not bytes. Examples: index("abcde", "e") gives 5 index("abcde", "x") gives -1 index(12345, 34) gives 3 index("forêt", "t") gives 5 </pre>

latin1_to_utf8

<pre class="pre-non-highlight-non-pair"> latin1_to_utf8 (class=string #args=1) Tries to convert Latin-1-encoded string to UTF-8-encoded string. If argument is array or map, recurses into it. Examples: $y = latin1_to_utf8($x) $* = latin1_to_utf8($*) </pre>

leftpad

<pre class="pre-non-highlight-non-pair"> leftpad (class=string #args=3) Left-pads first argument to at most the specified length (second, integer argument) using specified pad value (third, string argument). If the first argument is not a string, it will be stringified first. Examples: leftpad("abcdefg", 10 , "*") gives "***abcdefg". leftpad("abcdefg", 10 , "XY") gives "XYabcdefg". leftpad("1234567", 10 , "0") gives "0001234567". </pre>

lstrip

<pre class="pre-non-highlight-non-pair"> lstrip (class=string #args=1) Strip leading whitespace from string. </pre>

regextract

<pre class="pre-non-highlight-non-pair"> regextract (class=string #args=2) Extracts a substring (the first, if there are multiple matches), matching a regular expression, from the input. Does not use capture groups; see also the =~ operator which does. Examples: regextract("index ab09 file", "[a-z][a-z][0-9][0-9]") gives "ab09" regextract("index a999 file", "[a-z][a-z][0-9][0-9]") gives (absent), which will result in an assignment not happening. </pre>

regextract_or_else

<pre class="pre-non-highlight-non-pair"> regextract_or_else (class=string #args=3) Like regextract but the third argument is the return value in case the input string (first argument) doesn't match the pattern (second argument). Examples: regextract_or_else("index ab09 file", "[a-z][a-z][0-9][0-9]", "nonesuch") gives "ab09" regextract_or_else("index a999 file", "[a-z][a-z][0-9][0-9]", "nonesuch") gives "nonesuch" </pre>

rightpad

<pre class="pre-non-highlight-non-pair"> rightpad (class=string #args=3) Right-pads first argument to at most the specified length (second, integer argument) using specified pad value (third, string argument). If the first argument is not a string, it will be stringified first. Examples: rightpad("abcdefg", 10 , "*") gives "abcdefg***". rightpad("abcdefg", 10 , "XY") gives "abcdefgXY". rightpad("1234567", 10 , "0") gives "1234567000". </pre>

rstrip

<pre class="pre-non-highlight-non-pair"> rstrip (class=string #args=1) Strip trailing whitespace from string. </pre>

ssub

<pre class="pre-non-highlight-non-pair"> ssub (class=string #args=3) Like sub but does no regexing. No characters are special. Example: ssub("abc.def", ".", "X") gives "abcXdef" </pre>

strip

<pre class="pre-non-highlight-non-pair"> strip (class=string #args=1) Strip leading and trailing whitespace from string. </pre>

strlen

<pre class="pre-non-highlight-non-pair"> strlen (class=string #args=1) String length. </pre>

strmatch

<pre class="pre-non-highlight-non-pair"> strmatch (class=string #args=2) Boolean yes/no for whether the stringable first argument matches the regular-expression second argument. No regex captures are provided; please see `strmatch`. Examples: strmatch("a", "abc") is false strmatch("abc", "a") is true strmatch("abc", "a[a-z]c") is true strmatch("abc", "(a).(c)") is true strmatch(12345, "34") is true </pre>

strmatchx

<pre class="pre-non-highlight-non-pair"> strmatchx (class=string #args=2) Extended information for whether the stringable first argument matches the regular-expression second argument. Regex captures are provided in the return-value map; \1, \2, etc. are not set, in contrast to the `=~` operator. As well, while the `=~` operator limits matches to \1 through \9, an arbitrary number are supported here. Examples: strmatchx("a", "abc") returns: { "matched": false } strmatchx("abc", "a") returns: { "matched": true, "full_capture": "a", "full_start": 1, "full_end": 1 } strmatchx("[zy:3458]", "([a-z]+):([0-9]+)") returns: { "matched": true, "full_capture": "zy:3458", "full_start": 2, "full_end": 8, "captures": ["zy", "3458"], "starts": [2, 5], "ends": [3, 8] } </pre>

sub

<pre class="pre-non-highlight-non-pair"> sub (class=string #args=3) '$name = sub($name, "old", "new")': replace once (first match, if there are multiple matches), with support for regular expressions. Capture groups \1 through \9 in the new part are matched from (...) in the old part, and must be used within the same call to sub -- they don't persist for subsequent DSL statements. See also =~ and regextract. See also "Regular expressions" at https://miller.readthedocs.io. Examples: sub("ababab", "ab", "XY") gives "XYabab" sub("abc.def", ".", "X") gives "Xbc.def" sub("abc.def", "\.", "X") gives "abcXdef" sub("abcdefg", "[ce]", "X") gives "abXdefg" sub("prefix4529:suffix8567", "suffix([0-9]+)", "name\1") gives "prefix4529:name8567" </pre>

substr

<pre class="pre-non-highlight-non-pair"> substr (class=string #args=3) substr is an alias for substr0. See also substr1. Miller is generally 1-up with all array and string indices, but, this is a backward-compatibility issue with Miller 5 and below. Arrays are new in Miller 6; the substr function is older. </pre>

substr0

<pre class="pre-non-highlight-non-pair"> substr0 (class=string #args=3) substr0(s,m,n) gives substring of s from 0-up position m to n inclusive. Negative indices -len .. -1 alias to 0 .. len-1. See also substr and substr1. </pre>

substr1

<pre class="pre-non-highlight-non-pair"> substr1 (class=string #args=3) substr1(s,m,n) gives substring of s from 1-up position m to n inclusive. Negative indices -len .. -1 alias to 1 .. len. See also substr and substr0. </pre>

tolower

<pre class="pre-non-highlight-non-pair"> tolower (class=string #args=1) Convert string to lowercase. </pre>

toupper

<pre class="pre-non-highlight-non-pair"> toupper (class=string #args=1) Convert string to uppercase. </pre>

truncate

<pre class="pre-non-highlight-non-pair"> truncate (class=string #args=2) Truncates string first argument to max length of int second argument. </pre>

unformat

<pre class="pre-non-highlight-non-pair"> unformat (class=string #args=2) Using first argument as format string, unpacks second argument into an array of matches, with type-inference. On non-match, returns error -- use is_error() to check. Examples: unformat("{}:{}:{}", "1:2:3") gives [1, 2, 3]. unformat("{}h{}m{}s", "3h47m22s") gives [3, 47, 22]. is_error(unformat("{}h{}m{}s", "3:47:22")) gives true. </pre>

unformatx

<pre class="pre-non-highlight-non-pair"> unformatx (class=string #args=2) Same as unformat, but without type-inference. Examples: unformatx("{}:{}:{}", "1:2:3") gives ["1", "2", "3"]. unformatx("{}h{}m{}s", "3h47m22s") gives ["3", "47", "22"]. is_error(unformatx("{}h{}m{}s", "3:47:22")) gives true. </pre>

utf8_to_latin1

<pre class="pre-non-highlight-non-pair"> utf8_to_latin1 (class=string #args=1) Tries to convert UTF-8-encoded string to Latin-1-encoded string. If argument is array or map, recurses into it. Examples: $y = utf8_to_latin1($x) $* = utf8_to_latin1($*) </pre>

.

<pre class="pre-non-highlight-non-pair"> . (class=string #args=2) String concatenation. Non-strings are coerced, so you can do '"ax".98' etc. </pre>

System functions

exec

<pre class="pre-non-highlight-non-pair"> exec (class=system #args=variadic) '$output = exec( "command", ["arg1", "arg2"], {"env": ["ENV_VAR=ENV_VALUE", "ENV_VAR2=ENV_VALUE2"], "dir": "/tmp/run_command_here", "stdin_string": "this is input fed to program", "combined_output": true )' Run a command via executable, path, args and environment, yielding its stdout minus final carriage return. Example: exec("echo", ["I don't do", "$SHELL things"], {"env": "SHELL=sh"}) outputs "I don't do $SHELL things" </pre>

hostname

<pre class="pre-non-highlight-non-pair"> hostname (class=system #args=0) Returns the hostname as a string. </pre>

<pre class="pre-non-highlight-non-pair"> next (class=system #args=0) In mlr script mode only: reads the next record from input. Returns true if a record was read (and sets $* to it), false at end of stream (and $* becomes false). </pre>

os

<pre class="pre-non-highlight-non-pair"> os (class=system #args=0) Returns the operating-system name as a string. </pre>

stat

<pre class="pre-non-highlight-non-pair"> stat (class=system #args=1) Returns a map containing information about the provided path: "name" with string value, "size" as decimal int value, "mode" as octal int value, "modtime" as int-valued epoch seconds, and "isdir" as boolean value. Examples: stat("./mlr") gives { "name": "mlr", "size": 38391584, "mode": 0755, "modtime": 1715207874, "isdir": false } stat("./mlr")["size"] gives 38391584 </pre>

system

<pre class="pre-non-highlight-non-pair"> system (class=system #args=1) Run command string, yielding its stdout minus final carriage return. </pre>

version

<pre class="pre-non-highlight-non-pair"> version (class=system #args=0) Returns the Miller version as a string. </pre>

Time functions

dhms2fsec

<pre class="pre-non-highlight-non-pair"> dhms2fsec (class=time #args=1) Recovers floating-point seconds as in dhms2fsec("5d18h53m20.250000s") = 500000.250000 </pre>

dhms2sec

<pre class="pre-non-highlight-non-pair"> dhms2sec (class=time #args=1) Recovers integer seconds as in dhms2sec("5d18h53m20s") = 500000 </pre>

fsec2dhms

<pre class="pre-non-highlight-non-pair"> fsec2dhms (class=time #args=1) Formats floating-point seconds as in fsec2dhms(500000.25) = "5d18h53m20.250000s" </pre>

fsec2hms

<pre class="pre-non-highlight-non-pair"> fsec2hms (class=time #args=1) Formats floating-point seconds as in fsec2hms(5000.25) = "01:23:20.250000" </pre>

gmt2localtime

<pre class="pre-non-highlight-non-pair"> gmt2localtime (class=time #args=1,2) Convert from a GMT-time string to a local-time string. Consulting $TZ unless second argument is supplied. Examples: gmt2localtime("1999-12-31T22:00:00Z") = "2000-01-01 00:00:00" with TZ="Asia/Istanbul" gmt2localtime("1999-12-31T22:00:00Z", "Asia/Istanbul") = "2000-01-01 00:00:00" </pre>

gmt2nsec

<pre class="pre-non-highlight-non-pair"> gmt2nsec (class=time #args=1) Parses GMT timestamp as integer nanoseconds since the epoch. Example: gmt2nsec("2001-02-03T04:05:06Z") = 981173106000000000 </pre>

gmt2sec

<pre class="pre-non-highlight-non-pair"> gmt2sec (class=time #args=1) Parses GMT timestamp as integer seconds since the epoch. Example: gmt2sec("2001-02-03T04:05:06Z") = 981173106 </pre>

hms2fsec

<pre class="pre-non-highlight-non-pair"> hms2fsec (class=time #args=1) Recovers floating-point seconds as in hms2fsec("01:23:20.250000") = 5000.250000 </pre>

hms2sec

<pre class="pre-non-highlight-non-pair"> hms2sec (class=time #args=1) Recovers integer seconds as in hms2sec("01:23:20") = 5000 </pre>

localtime2gmt

<pre class="pre-non-highlight-non-pair"> localtime2gmt (class=time #args=1,2) Convert from a local-time string to a GMT-time string. Consults $TZ unless second argument is supplied. Examples: localtime2gmt("2000-01-01 00:00:00") = "1999-12-31T22:00:00Z" with TZ="Asia/Istanbul" localtime2gmt("2000-01-01 00:00:00", "Asia/Istanbul") = "1999-12-31T22:00:00Z" </pre>

localtime2nsec

<pre class="pre-non-highlight-non-pair"> localtime2nsec (class=time #args=1,2) Parses local timestamp as integer nanoseconds since the epoch. Consults $TZ environment variable, unless second argument is supplied. Examples: localtime2nsec("2001-02-03 04:05:06") = 981165906000000000 with TZ="Asia/Istanbul" localtime2nsec("2001-02-03 04:05:06", "Asia/Istanbul") = 981165906000000000" </pre>

localtime2sec

<pre class="pre-non-highlight-non-pair"> localtime2sec (class=time #args=1,2) Parses local timestamp as integer seconds since the epoch. Consults $TZ environment variable, unless second argument is supplied. Examples: localtime2sec("2001-02-03 04:05:06") = 981165906 with TZ="Asia/Istanbul" localtime2sec("2001-02-03 04:05:06", "Asia/Istanbul") = 981165906" </pre>

nsec2gmt

<pre class="pre-non-highlight-non-pair"> nsec2gmt (class=time #args=1,2) Formats integer nanoseconds since epoch as GMT timestamp. Leaves non-numbers as-is. With second integer argument n, includes n decimal places for the seconds part. Examples: nsec2gmt(1234567890000000000) = "2009-02-13T23:31:30Z" nsec2gmt(1234567890123456789) = "2009-02-13T23:31:30Z" nsec2gmt(1234567890123456789, 6) = "2009-02-13T23:31:30.123456Z" </pre>

nsec2gmtdate

<pre class="pre-non-highlight-non-pair"> nsec2gmtdate (class=time #args=1) Formats integer nanoseconds since epoch as GMT timestamp with year-month-date. Leaves non-numbers as-is. Example: sec2gmtdate(1440768801700000000) = "2015-08-28". </pre>

nsec2localdate

<pre class="pre-non-highlight-non-pair"> nsec2localdate (class=time #args=1,2) Formats integer nanoseconds since epoch as local timestamp with year-month-date. Leaves non-numbers as-is. Consults $TZ environment variable unless second argument is supplied. Examples: nsec2localdate(1440768801700000000) = "2015-08-28" with TZ="Asia/Istanbul" nsec2localdate(1440768801700000000, "Asia/Istanbul") = "2015-08-28" </pre>

nsec2localtime

<pre class="pre-non-highlight-non-pair"> nsec2localtime (class=time #args=1,2,3) Formats integer nanoseconds since epoch as local timestamp. Consults $TZ environment variable unless third argument is supplied. Leaves non-numbers as-is. With second integer argument n, includes n decimal places for the seconds part Examples: nsec2localtime(1234567890000000000) = "2009-02-14 01:31:30" with TZ="Asia/Istanbul" nsec2localtime(1234567890123456789) = "2009-02-14 01:31:30" with TZ="Asia/Istanbul" nsec2localtime(1234567890123456789, 6) = "2009-02-14 01:31:30.123456" with TZ="Asia/Istanbul" nsec2localtime(1234567890123456789, 6, "Asia/Istanbul") = "2009-02-14 01:31:30.123456" </pre>

sec2dhms

<pre class="pre-non-highlight-non-pair"> sec2dhms (class=time #args=1) Formats integer seconds as in sec2dhms(500000) = "5d18h53m20s" </pre>

sec2gmt

<pre class="pre-non-highlight-non-pair"> sec2gmt (class=time #args=1,2) Formats seconds since epoch as GMT timestamp. Leaves non-numbers as-is. With second integer argument n, includes n decimal places for the seconds part. Examples: sec2gmt(1234567890) = "2009-02-13T23:31:30Z" sec2gmt(1234567890.123456) = "2009-02-13T23:31:30Z" sec2gmt(1234567890.123456, 6) = "2009-02-13T23:31:30.123456Z" </pre>

sec2gmtdate

<pre class="pre-non-highlight-non-pair"> sec2gmtdate (class=time #args=1) Formats seconds since epoch (integer part) as GMT timestamp with year-month-date. Leaves non-numbers as-is. Example: sec2gmtdate(1440768801.7) = "2015-08-28". </pre>

sec2hms

<pre class="pre-non-highlight-non-pair"> sec2hms (class=time #args=1) Formats integer seconds as in sec2hms(5000) = "01:23:20" </pre>

sec2localdate

<pre class="pre-non-highlight-non-pair"> sec2localdate (class=time #args=1,2) Formats seconds since epoch (integer part) as local timestamp with year-month-date. Leaves non-numbers as-is. Consults $TZ environment variable unless second argument is supplied. Examples: sec2localdate(1440768801.7) = "2015-08-28" with TZ="Asia/Istanbul" sec2localdate(1440768801.7, "Asia/Istanbul") = "2015-08-28" </pre>

sec2localtime

<pre class="pre-non-highlight-non-pair"> sec2localtime (class=time #args=1,2,3) Formats seconds since epoch (integer part) as local timestamp. Consults $TZ environment variable unless third argument is supplied. Leaves non-numbers as-is. With second integer argument n, includes n decimal places for the seconds part Examples: sec2localtime(1234567890) = "2009-02-14 01:31:30" with TZ="Asia/Istanbul" sec2localtime(1234567890.123456) = "2009-02-14 01:31:30" with TZ="Asia/Istanbul" sec2localtime(1234567890.123456, 6) = "2009-02-14 01:31:30.123456" with TZ="Asia/Istanbul" sec2localtime(1234567890.123456, 6, "Asia/Istanbul") = "2009-02-14 01:31:30.123456" </pre>

strfntime

<pre class="pre-non-highlight-non-pair"> strfntime (class=time #args=2) Formats integer nanoseconds since the epoch as timestamp. Format strings are as at https://pkg.go.dev/github.com/lestrrat-go/strftime, with the Miller-specific addition of "%1S" through "%9S" which format the seconds with 1 through 9 decimal places, respectively. ("%S" uses no decimal places.) See also https://miller.readthedocs.io/en/latest/reference-dsl-time/ for more information on the differences from the C library ("man strftime" on your system). See also strftime_local. Examples: strfntime(1440768801123456789,"%Y-%m-%dT%H:%M:%SZ") = "2015-08-28T13:33:21Z" strfntime(1440768801123456789,"%Y-%m-%dT%H:%M:%3SZ") = "2015-08-28T13:33:21.123Z" strfntime(1440768801123456789,"%Y-%m-%dT%H:%M:%6SZ") = "2015-08-28T13:33:21.123456Z" </pre>

strfntime_local

<pre class="pre-non-highlight-non-pair"> strfntime_local (class=time #args=2,3) Like strfntime but consults the $TZ environment variable to get local time zone. Examples: strfntime_local(1440768801123456789, "%Y-%m-%d %H:%M:%S %z") = "2015-08-28 16:33:21 +0300" with TZ="Asia/Istanbul" strfntime_local(1440768801123456789, "%Y-%m-%d %H:%M:%3S %z") = "2015-08-28 16:33:21.123 +0300" with TZ="Asia/Istanbul" strfntime_local(1440768801123456789, "%Y-%m-%d %H:%M:%3S %z", "Asia/Istanbul") = "2015-08-28 16:33:21.123 +0300" strfntime_local(1440768801123456789, "%Y-%m-%d %H:%M:%9S %z", "Asia/Istanbul") = "2015-08-28 16:33:21.123456789 +0300" </pre>

strftime

<pre class="pre-non-highlight-non-pair"> strftime (class=time #args=2) Formats seconds since the epoch as timestamp. Format strings are as at https://pkg.go.dev/github.com/lestrrat-go/strftime, with the Miller-specific addition of "%1S" through "%9S" which format the seconds with 1 through 9 decimal places, respectively. ("%S" uses no decimal places.) See also https://miller.readthedocs.io/en/latest/reference-dsl-time/ for more information on the differences from the C library ("man strftime" on your system). See also strftime_local. Examples: strftime(1440768801.7,"%Y-%m-%dT%H:%M:%SZ") = "2015-08-28T13:33:21Z" strftime(1440768801.7,"%Y-%m-%dT%H:%M:%3SZ") = "2015-08-28T13:33:21.700Z" </pre>

strftime_local

<pre class="pre-non-highlight-non-pair"> strftime_local (class=time #args=2,3) Like strftime but consults the $TZ environment variable to get local time zone. Examples: strftime_local(1440768801.7, "%Y-%m-%d %H:%M:%S %z") = "2015-08-28 16:33:21 +0300" with TZ="Asia/Istanbul" strftime_local(1440768801.7, "%Y-%m-%d %H:%M:%3S %z") = "2015-08-28 16:33:21.700 +0300" with TZ="Asia/Istanbul" strftime_local(1440768801.7, "%Y-%m-%d %H:%M:%3S %z", "Asia/Istanbul") = "2015-08-28 16:33:21.700 +0300" </pre>

strpntime

<pre class="pre-non-highlight-non-pair"> strpntime (class=time #args=2) strpntime: Parses timestamp as integer nanoseconds since the epoch. See also strpntime_local. Examples: strpntime("2015-08-28T13:33:21Z", "%Y-%m-%dT%H:%M:%SZ") = 1440768801000000000 strpntime("2015-08-28T13:33:21.345Z", "%Y-%m-%dT%H:%M:%SZ") = 1440768801345000000 strpntime("1970-01-01 00:00:00 -0400", "%Y-%m-%d %H:%M:%S %z") = 14400000000000 strpntime("1970-01-01 00:00:00 +0200", "%Y-%m-%d %H:%M:%S %z") = -7200000000000 </pre>

strpntime_local

<pre class="pre-non-highlight-non-pair"> strpntime_local (class=time #args=2,3) Like strpntime but consults the $TZ environment variable to get local time zone. Examples: strpntime_local("2015-08-28T13:33:21Z", "%Y-%m-%dT%H:%M:%SZ") = 1440758001000000000 with TZ="Asia/Istanbul" strpntime_local("2015-08-28T13:33:21.345Z","%Y-%m-%dT%H:%M:%SZ") = 1440758001345000000 with TZ="Asia/Istanbul" strpntime_local("2015-08-28 13:33:21", "%Y-%m-%d %H:%M:%S") = 1440758001000000000 with TZ="Asia/Istanbul" strpntime_local("2015-08-28 13:33:21", "%Y-%m-%d %H:%M:%S", "Asia/Istanbul") = 1440758001000000000 </pre>

strptime

<pre class="pre-non-highlight-non-pair"> strptime (class=time #args=2) strptime: Parses timestamp as floating-point seconds since the epoch. See also strptime_local. Examples: strptime("2015-08-28T13:33:21Z", "%Y-%m-%dT%H:%M:%SZ") = 1440768801.000000 strptime("2015-08-28T13:33:21.345Z", "%Y-%m-%dT%H:%M:%SZ") = 1440768801.345000 strptime("1970-01-01 00:00:00 -0400", "%Y-%m-%d %H:%M:%S %z") = 14400 strptime("1970-01-01 00:00:00 +0200", "%Y-%m-%d %H:%M:%S %z") = -7200 </pre>

strptime_local

<pre class="pre-non-highlight-non-pair"> strptime_local (class=time #args=2,3) Like strptime but consults the $TZ environment variable to get local time zone. Examples: strptime_local("2015-08-28T13:33:21Z", "%Y-%m-%dT%H:%M:%SZ") = 1440758001 with TZ="Asia/Istanbul" strptime_local("2015-08-28T13:33:21.345Z","%Y-%m-%dT%H:%M:%SZ") = 1440758001.345 with TZ="Asia/Istanbul" strptime_local("2015-08-28 13:33:21", "%Y-%m-%d %H:%M:%S") = 1440758001 with TZ="Asia/Istanbul" strptime_local("2015-08-28 13:33:21", "%Y-%m-%d %H:%M:%S", "Asia/Istanbul") = 1440758001 </pre>

sysntime

<pre class="pre-non-highlight-non-pair"> sysntime (class=time #args=0) Returns the system time in 64-bit nanoseconds since the epoch. </pre>

systime

<pre class="pre-non-highlight-non-pair"> systime (class=time #args=0) Returns the system time in floating-point seconds since the epoch. </pre>

systimeint

<pre class="pre-non-highlight-non-pair"> systimeint (class=time #args=0) Returns the system time in integer seconds since the epoch. </pre>

upntime

<pre class="pre-non-highlight-non-pair"> upntime (class=time #args=0) Returns the time in 64-bit nanoseconds since the current Miller program was started. </pre>

uptime

<pre class="pre-non-highlight-non-pair"> uptime (class=time #args=0) Returns the time in floating-point seconds since the current Miller program was started. </pre>

Typing functions

asserting_absent

<pre class="pre-non-highlight-non-pair"> asserting_absent (class=typing #args=1) Aborts with an error if is_absent on the argument returns false, else returns its argument. </pre>

asserting_array

<pre class="pre-non-highlight-non-pair"> asserting_array (class=typing #args=1) Aborts with an error if is_array on the argument returns false, else returns its argument. </pre>

asserting_bool

<pre class="pre-non-highlight-non-pair"> asserting_bool (class=typing #args=1) Aborts with an error if is_bool on the argument returns false, else returns its argument. </pre>

asserting_boolean

<pre class="pre-non-highlight-non-pair"> asserting_boolean (class=typing #args=1) Aborts with an error if is_boolean on the argument returns false, else returns its argument. </pre>

asserting_empty

<pre class="pre-non-highlight-non-pair"> asserting_empty (class=typing #args=1) Aborts with an error if is_empty on the argument returns false, else returns its argument. </pre>

asserting_empty_map

<pre class="pre-non-highlight-non-pair"> asserting_empty_map (class=typing #args=1) Aborts with an error if is_empty_map on the argument returns false, else returns its argument. </pre>

asserting_error

<pre class="pre-non-highlight-non-pair"> asserting_error (class=typing #args=1) Aborts with an error if is_error on the argument returns false, else returns its argument. </pre>

asserting_float

<pre class="pre-non-highlight-non-pair"> asserting_float (class=typing #args=1) Aborts with an error if is_float on the argument returns false, else returns its argument. </pre>

asserting_int

<pre class="pre-non-highlight-non-pair"> asserting_int (class=typing #args=1) Aborts with an error if is_int on the argument returns false, else returns its argument. </pre>

asserting_map

<pre class="pre-non-highlight-non-pair"> asserting_map (class=typing #args=1) Aborts with an error if is_map on the argument returns false, else returns its argument. </pre>

asserting_nonempty_map

<pre class="pre-non-highlight-non-pair"> asserting_nonempty_map (class=typing #args=1) Aborts with an error if is_nonempty_map on the argument returns false, else returns its argument. </pre>

asserting_not_array

<pre class="pre-non-highlight-non-pair"> asserting_not_array (class=typing #args=1) Aborts with an error if is_not_array on the argument returns false, else returns its argument. </pre>

asserting_not_empty

<pre class="pre-non-highlight-non-pair"> asserting_not_empty (class=typing #args=1) Aborts with an error if is_not_empty on the argument returns false, else returns its argument. </pre>

asserting_not_map

<pre class="pre-non-highlight-non-pair"> asserting_not_map (class=typing #args=1) Aborts with an error if is_not_map on the argument returns false, else returns its argument. </pre>

asserting_not_null

<pre class="pre-non-highlight-non-pair"> asserting_not_null (class=typing #args=1) Aborts with an error if is_not_null on the argument returns false, else returns its argument. </pre>

asserting_null

<pre class="pre-non-highlight-non-pair"> asserting_null (class=typing #args=1) Aborts with an error if is_null on the argument returns false, else returns its argument. </pre>

asserting_numeric

<pre class="pre-non-highlight-non-pair"> asserting_numeric (class=typing #args=1) Aborts with an error if is_numeric on the argument returns false, else returns its argument. </pre>

asserting_present

<pre class="pre-non-highlight-non-pair"> asserting_present (class=typing #args=1) Aborts with an error if is_present on the argument returns false, else returns its argument. </pre>

asserting_string

<pre class="pre-non-highlight-non-pair"> asserting_string (class=typing #args=1) Aborts with an error if is_string on the argument returns false, else returns its argument. </pre>

is_absent

<pre class="pre-non-highlight-non-pair"> is_absent (class=typing #args=1) False if field is present in input, true otherwise </pre>

is_array

<pre class="pre-non-highlight-non-pair"> is_array (class=typing #args=1) True if argument is an array. </pre>

is_bool

<pre class="pre-non-highlight-non-pair"> is_bool (class=typing #args=1) True if field is present with boolean value. Synonymous with is_boolean. </pre>

is_boolean

<pre class="pre-non-highlight-non-pair"> is_boolean (class=typing #args=1) True if field is present with boolean value. Synonymous with is_bool. </pre>

is_empty

<pre class="pre-non-highlight-non-pair"> is_empty (class=typing #args=1) True if field is present in input with empty string value, false otherwise. </pre>

is_empty_map

<pre class="pre-non-highlight-non-pair"> is_empty_map (class=typing #args=1) True if argument is a map which is empty. </pre>

is_error

<pre class="pre-non-highlight-non-pair"> is_error (class=typing #args=1) True if if argument is an error, such as taking string length of an integer. </pre>

is_float

<pre class="pre-non-highlight-non-pair"> is_float (class=typing #args=1) True if field is present with value inferred to be float </pre>

is_int

<pre class="pre-non-highlight-non-pair"> is_int (class=typing #args=1) True if field is present with value inferred to be int </pre>

is_map

<pre class="pre-non-highlight-non-pair"> is_map (class=typing #args=1) True if argument is a map. </pre>

is_nan

<pre class="pre-non-highlight-non-pair"> is_nan (class=typing #args=1) True if the argument is the NaN (not-a-number) floating-point value. Note that NaN has the property that NaN != NaN, so you need 'is_nan(x)' rather than 'x == NaN'. </pre>

is_nonempty_map

<pre class="pre-non-highlight-non-pair"> is_nonempty_map (class=typing #args=1) True if argument is a map which is non-empty. </pre>

is_not_array

<pre class="pre-non-highlight-non-pair"> is_not_array (class=typing #args=1) True if argument is not an array. </pre>

is_not_empty

<pre class="pre-non-highlight-non-pair"> is_not_empty (class=typing #args=1) True if field is present in input with non-empty value, false otherwise </pre>

is_not_map

<pre class="pre-non-highlight-non-pair"> is_not_map (class=typing #args=1) True if argument is not a map. </pre>

is_not_null

<pre class="pre-non-highlight-non-pair"> is_not_null (class=typing #args=1) False if argument is null (empty, absent, or JSON null), true otherwise. </pre>

is_null

<pre class="pre-non-highlight-non-pair"> is_null (class=typing #args=1) True if argument is null (empty, absent, or JSON null), false otherwise. </pre>

is_numeric

<pre class="pre-non-highlight-non-pair"> is_numeric (class=typing #args=1) True if field is present with value inferred to be int or float </pre>

is_present

<pre class="pre-non-highlight-non-pair"> is_present (class=typing #args=1) True if field is present in input, false otherwise. </pre>

is_string

<pre class="pre-non-highlight-non-pair"> is_string (class=typing #args=1) True if field is present with string (including empty-string) value </pre>

typeof

<pre class="pre-non-highlight-non-pair"> typeof (class=typing #args=1) Convert argument to type of argument (e.g. "str"). For debug. </pre>