If the result of a target query fails (due to incorrect types, failed parsing, etc) the argument is returned instead.

fallback <query expression> A value to yield, or query to execute, if the target query fails.

root.doc.id = this.thing.id.string().catch(uuid_v4())

The fallback argument can be a mapping, allowing you to capture the error string and yield structured data back.

root.url = this.url.parse_url().catch(err -> {"error":err,"input":this.url})
# In:  {"url":"invalid %&# url"}
# Out: {"url":{"error":"field `this.url`: parse \"invalid %&\": invalid URL escape \"%&\"","input":"invalid %&# url"}}

When the input document is not structured attempting to reference structured fields with this will result in an error. Therefore, a convenient way to delete non-structured data is with a catch.

root = this.catch(deleted())
# In:  {"doc":{"foo":"bar"}}
# Out: {"doc":{"foo":"bar"}}
# In:  not structured data
# Out: <Message deleted>

Modifies a target query such that certain functions are executed from the perspective of another message in the batch. This allows you to mutate events based on the contents of other messages. Functions that support this behavior are content , json and meta .

index <integer> The message index to use as a perspective.

For example, the following map extracts the contents of the JSON field foo specifically from message index 1 of a batch, effectively overriding the field foo for all messages of a batch to that of message 1:

root = this
root.foo = json("foo").from(1)

Modifies a target query such that certain functions are executed from the perspective of each message in the batch, and returns the set of results as an array. Functions that support this behavior are content , json and meta .

root = this
root.foo_summed = json("foo").from_all().sum()

If the result of the target query fails or resolves to null , returns the argument instead. This is an explicit method alternative to the coalesce pipe operator | .

fallback <query expression> A value to yield, or query to execute, if the target query fails or resolves to null .

root.doc.id = this.thing.id.or(uuid_v4())

Takes a string value and returns a copy with all Unicode letters that begin words mapped to their Unicode title case.

root.title = this.title.capitalize()
# In:  {"title":"the foo bar"}
# Out: {"title":"The Foo Bar"}

root.match = this.secret.compare_argon2("$argon2id$v=19$m=4096,t=3,p=1$c2FsdHktbWNzYWx0ZmFjZQ$RMUMwgtS32/mbszd+ke4o4Ej1jFpYiUqY6MHWa69X7Y")
# In:  {"secret":"there-are-many-blobs-in-the-sea"}
# Out: {"match":true}

root.match = this.secret.compare_argon2("$argon2id$v=19$m=4096,t=3,p=1$c2FsdHktbWNzYWx0ZmFjZQ$RMUMwgtS32/mbszd+ke4o4Ej1jFpYiUqY6MHWa69X7Y")
# In:  {"secret":"will-i-ever-find-love"}
# Out: {"match":false}

root.match = this.secret.compare_bcrypt("$2y$10$Dtnt5NNzVtMCOZONT705tOcS8It6krJX8bEjnDJnwxiFKsz1C.3Ay")
# In:  {"secret":"there-are-many-blobs-in-the-sea"}
# Out: {"match":true}

root.match = this.secret.compare_bcrypt("$2y$10$Dtnt5NNzVtMCOZONT705tOcS8It6krJX8bEjnDJnwxiFKsz1C.3Ay")
# In:  {"secret":"will-i-ever-find-love"}
# Out: {"match":false}

Escapes a string so that special characters like < to become < . It escapes only five such characters: < , > , & , ' and " so that it can be safely placed within an HTML entity.

root.escaped = this.value.escape_html()
# In:  {"value":"foo & bar"}
# Out: {"escaped":"foo & bar"}

Joins an array of path elements into a single file path. The separator depends on the operating system of the machine.

root.path = this.path_elements.filepath_join()
# In:  {"path_elements":["/foo/","bar.txt"]}
# Out: {"path":"/foo/bar.txt"}

Splits a file path immediately following the final Separator, separating it into a directory and file name component returned as a two element array of strings. If there is no Separator in the path, the first element will be empty and the second will contain the path. The separator depends on the operating system of the machine.

root.path_sep = this.path.filepath_split()
# In:  {"path":"/foo/bar.txt"}
# Out: {"path_sep":["/foo/","bar.txt"]}
# In:  {"path":"baz.txt"}
# Out: {"path_sep":["","baz.txt"]}

root.foo = "%s(%v): %v".format(this.name, this.age, this.fingers)
# In:  {"name":"lance","age":37,"fingers":13}
# Out: {"foo":"lance(37): 13"}

Returns the starting index of the argument substring in a string target, or -1 if the target doesn’t contain the argument.

value <string> A string to search for.

root.index = this.thing.index_of("bar")
# In:  {"thing":"foobar"}
# Out: {"index":3}

Quotes a target string using escape sequences ( \t , \n , \xFF , \u0100 ) for control characters and non-printable characters.

root.quoted = this.thing.quote()
# In:  {"thing":"foo\nbar"}
# Out: {"quoted":"\"foo\\nbar\""}

Replaces all occurrences of the first argument in a target string with the second argument.

old <string> A string to match against. new <string> A string to replace with.

root.new_value = this.value.replace_all("foo","dog")
# In:  {"value":"The foo ate my homework"}
# Out: {"new_value":"The dog ate my homework"}

For each pair of strings in an argument array, replaces all occurrences of the first item of the pair with the second. This is a more compact way of chaining a series of replace_all methods.

values <array> An array of values, each even value will be replaced with the following odd value.

root.new_value = this.value.replace_all_many([
  "<b>", "&lt;b&gt;",
  "</b>", "&lt;/b&gt;",
  "<i>", "&lt;i&gt;",
  "</i>", "&lt;/i&gt;",
# In:  {"value":"<i>Hello</i> <b>World</b>"}
# Out: {"new_value":"&lt;i&gt;Hello&lt;/i&gt; &lt;b&gt;World&lt;/b&gt;"}

Extract a slice from a string by specifying two indices, a low and high bound, which selects a half-open range that includes the first character, but excludes the last one. If the second index is omitted then it defaults to the length of the input sequence.

low <integer> The low bound, which is the first element of the selection, or if negative selects from the end.

high <(optional) integer> An optional high bound.

root.beginning = this.value.slice(0, 2)
root.end = this.value.slice(4)
# In:  {"value":"foo bar"}
# Out: {"beginning":"fo","end":"bar"}

A negative low index can be used, indicating an offset from the end of the sequence. If the low index is greater than the length of the sequence then an empty result is returned.

root.last_chunk = this.value.slice(-4)
root.the_rest = this.value.slice(0, -4)
# In:  {"value":"foo bar"}
# Out: {"last_chunk":" bar","the_rest":"foo"}

lang <(optional) string, default "en" >

Creates a slug from an English string

root.slug = this.value.slug()
# In:  {"value":"Gopher & Benthos"}
# Out: {"slug":"gopher-and-benthos"}

Creates a slug from a French string

root.slug = this.value.slug("fr")
# In:  {"value":"Gaufre & Poisson d'Eau Profonde"}
# Out: {"slug":"gaufre-et-poisson-deau-profonde"}

Split a string value into an array of strings by splitting it on a string separator.

delimiter <string> The delimiter to split with.

root.new_value = this.value.split(",")
# In:  {"value":"foo,bar,baz"}
# Out: {"new_value":["foo","bar","baz"]}

root.stripped = this.value.strip_html()
# In:  {"value":"<p>the plain <strong>old text</strong></p>"}
# Out: {"stripped":"the plain old text"}

It’s also possible to provide an explicit list of element types to preserve in the output.

root.stripped = this.value.strip_html(["article"])
# In:  {"value":"<article><p>the plain <strong>old text</strong></p></article>"}
# Out: {"stripped":"<article>the plain old text</article>"}

Remove all leading and trailing characters from a string that are contained within an argument cutset. If no arguments are provided then whitespace is removed.

cutset <(optional) string> An optional string of characters to trim from the target value.

root.title = this.title.trim("!?")
root.description = this.description.trim()
# In:  {"description":"  something happened and its amazing! ","title":"!!!watch out!?"}
# Out: {"description":"something happened and its amazing!","title":"watch out"}

Remove the provided leading prefix substring from a string. If the string does not have the prefix substring, it is returned unchanged.

Introduced in version 4.12.0.

prefix <string> The leading prefix substring to trim from the string.

root.name = this.name.trim_prefix("foobar_")
root.description = this.description.trim_prefix("foobar_")
# In:  {"description":"unchanged","name":"foobar_blobton"}
# Out: {"description":"unchanged","name":"blobton"}

Remove the provided trailing suffix substring from a string. If the string does not have the suffix substring, it is returned unchanged.

Introduced in version 4.12.0.

suffix <string> The trailing suffix substring to trim from the string.

root.name = this.name.trim_suffix("_foobar")
root.description = this.description.trim_suffix("_foobar")
# In:  {"description":"unchanged","name":"blobton_foobar"}
# Out: {"description":"unchanged","name":"blobton"}

Unescapes a string so that entities like < become < . It unescapes a larger range of entities than escape_html escapes. For example, á unescapes to á , as does á and &xE1; .

root.unescaped = this.value.unescape_html()
# In:  {"value":"foo & bar"}
# Out: {"unescaped":"foo & bar"}

root.sentences = this.value.unicode_segments("sentence")
# In:  {"value":"This is sentence 1.0. And this is sentence two."}
# Out: {"sentences":["This is sentence 1.0.","And this is sentence two."]}

Tokenizes a string based on Unicode word segmentation rules, including punctuation and spaces.

root.words = this.value.unicode_segments("word")
# In:  {"value":"Hello, world!"}
# Out: {"words":["Hello",","," ","world","!"]}

Unquotes a target string, expanding any escape sequences ( \t , \n , \xFF , \u0100 ) for control characters and non-printable characters.

root.unquoted = this.thing.unquote()
# In:  {"thing":"\"foo\\nbar\""}
# Out: {"unquoted":"foo\nbar"}

Returns an array containing all successive matches of a regular expression in a string.

pattern <string> The pattern to match against.

root.matches = this.value.re_find_all("a.")
# In:  {"value":"paranormal"}
# Out: {"matches":["ar","an","al"]}

Returns an array of objects containing all matches of the regular expression and the matches of its subexpressions. The key of each match value is the name of the group when specified, otherwise it is the index of the matching group, starting with the expression as a whole at 0.

pattern <string> The pattern to match against.

root.matches = this.value.re_find_all_object("a(?P<foo>x*)b")
# In:  {"value":"-axxb-ab-"}
# Out: {"matches":[{"0":"axxb","foo":"xx"},{"0":"ab","foo":""}]}

root.matches = this.value.re_find_all_object("(?m)(?P<key>\\w+):\\s+(?P<value>\\w+)$")
# In:  {"value":"option1: value1\noption2: value2\noption3: value3"}
# Out: {"matches":[{"0":"option1: value1","key":"option1","value":"value1"},{"0":"option2: value2","key":"option2","value":"value2"},{"0":"option3: value3","key":"option3","value":"value3"}]}

Returns an array of arrays containing all successive matches of the regular expression in a string and the matches, if any, of its subexpressions.

pattern <string> The pattern to match against.

root.matches = this.value.re_find_all_submatch("a(x*)b")
# In:  {"value":"-axxb-ab-"}
# Out: {"matches":[["axxb","xx"],["ab",""]]}

Returns an object containing the first match of the regular expression and the matches of its subexpressions. The key of each match value is the name of the group when specified, otherwise it is the index of the matching group, starting with the expression as a whole at 0.

pattern <string> The pattern to match against.

root.matches = this.value.re_find_object("a(?P<foo>x*)b")
# In:  {"value":"-axxb-ab-"}
# Out: {"matches":{"0":"axxb","foo":"xx"}}

root.matches = this.value.re_find_object("(?P<key>\\w+):\\s+(?P<value>\\w+)")
# In:  {"value":"option1: value1"}
# Out: {"matches":{"0":"option1: value1","key":"option1","value":"value1"}}

Checks whether a regular expression matches against any part of a string and returns a boolean.

pattern <string> The pattern to match against.

root.matches = this.value.re_match("[0-9]")
# In:  {"value":"there are 10 puppies"}
# Out: {"matches":true}
# In:  {"value":"there are ten puppies"}
# Out: {"matches":false}

Replaces all occurrences of the argument regular expression in a string with a value. Inside the value $ signs are interpreted as submatch expansions, e.g. $1 represents the text of the first submatch.

pattern <string> The pattern to match against. value <string> The value to replace with.

root.new_value = this.value.re_replace_all("ADD ([0-9]+)","+($1)")
# In:  {"value":"foo ADD 70"}
# Out: {"new_value":"foo +(70)"}

Returns the absolute value of an int64 or float64 number. As a special case, when an integer is provided that is the minimum value it is converted to the maximum value.

root.outs = this.ins.map_each(ele -> ele.abs())
# In:  {"ins":[9,-18,1.23,-4.56]}
# Out: {"outs":[9,18,1.23,4.56]}

Returns the result of a bitwise AND operation between the input number and the specified value.

The bitwise AND operation compares each bit of two integers:

Returns the result of a bitwise OR operation between the input number and the specified value.

The bitwise OR operation compares each bit of two integers:

Returns the result of bitwise XOR between the input number and a specified value. Bitwise XOR is a binary operation that compares two bits and returns 1 if they are different and 0 if they are the same. This operation is commonly used in cryptography and error detection.

value <integer> The integer value to XOR with the current number.

root.new_value = this.value.bitwise_xor(6)
# In:  {"value":12}
# Out: {"new_value":10}
# In:  {"value":0}
# Out: {"new_value":6}
# In:  {"value":-2}
# Out: {"new_value":-8}

Returns the least integer value greater than or equal to a number. If the resulting value fits within a 64-bit integer then that is returned, otherwise a new floating point number is returned.

root.new_value = this.value.ceil()
# In:  {"value":5.3}
# Out: {"new_value":6}
# In:  {"value":-5.9}
# Out: {"new_value":-5}

Converts a numerical type into a 32-bit floating point number, this is for advanced use cases where a specific data type is needed for a given component (such as the ClickHouse SQL driver).

root.out = this.in.float32()
# In:  {"in":"6.674282313423543523453425345e-11"}
# Out: {"out":6.674283e-11}

Converts a numerical type into a 64-bit floating point number, this is for advanced use cases where a specific data type is needed for a given component (such as the ClickHouse SQL driver).

root.out = this.in.float64()
# In:  {"in":"6.674282313423543523453425345e-11"}
# Out: {"out":6.674282313423544e-11}

Returns the greatest integer value less than or equal to the target number. If the resulting value fits within a 64-bit integer then that is returned, otherwise a new floating point number is returned.

root.new_value = this.value.floor()
# In:  {"value":5.7}
# Out: {"new_value":5}

Converts a numerical type into a 16-bit signed integer, this is for advanced use cases where a specific data type is needed for a given component (such as the ClickHouse SQL driver).

root.a = this.a.int16()
root.b = this.b.round().int16()
root.c = this.c.int16()
root.d = this.d.int16().catch(0)
# In:  {"a":12,"b":12.34,"c":"12","d":-12}
# Out: {"a":12,"b":12,"c":12,"d":-12}

Converts a numerical type into a 32-bit signed integer, this is for advanced use cases where a specific data type is needed for a given component (such as the ClickHouse SQL driver).

root.a = this.a.int32()
root.b = this.b.round().int32()
root.c = this.c.int32()
root.d = this.d.int32().catch(0)
# In:  {"a":12,"b":12.34,"c":"12","d":-12}
# Out: {"a":12,"b":12,"c":12,"d":-12}

Converts a numerical type into a 64-bit signed integer, this is for advanced use cases where a specific data type is needed for a given component (such as the ClickHouse SQL driver).

root.a = this.a.int64()
root.b = this.b.round().int64()
root.c = this.c.int64()
root.d = this.d.int64().catch(0)
# In:  {"a":12,"b":12.34,"c":"12","d":-12}
# Out: {"a":12,"b":12,"c":12,"d":-12}

Converts a numerical type into a 8-bit signed integer, this is for advanced use cases where a specific data type is needed for a given component (such as the ClickHouse SQL driver).

root.a = this.a.int8()
root.b = this.b.round().int8()
root.c = this.c.int8()
root.d = this.d.int8().catch(0)
# In:  {"a":12,"b":12.34,"c":"12","d":-12}
# Out: {"a":12,"b":12,"c":12,"d":-12}

Returns the largest numerical value found within an array. All values must be numerical and the array must not be empty, otherwise an error is returned.

root.biggest = this.values.max()
# In:  {"values":[0,3,2.5,7,5]}
# Out: {"biggest":7}

Returns the smallest numerical value found within an array. All values must be numerical and the array must not be empty, otherwise an error is returned.

root.smallest = this.values.min()
# In:  {"values":[0,3,-2.5,7,5]}
# Out: {"smallest":-2.5}

Rounds numbers to the nearest integer, rounding half away from zero. If the resulting value fits within a 64-bit integer then that is returned, otherwise a new floating point number is returned.

root.new_value = this.value.round()
# In:  {"value":5.3}
# Out: {"new_value":5}
# In:  {"value":5.9}
# Out: {"new_value":6}

Converts a numerical type into a 16-bit unsigned integer, this is for advanced use cases where a specific data type is needed for a given component (such as the ClickHouse SQL driver).

root.a = this.a.uint16()
root.b = this.b.round().uint16()
root.c = this.c.uint16()
root.d = this.d.uint16().catch(0)
# In:  {"a":12,"b":12.34,"c":"12","d":-12}
# Out: {"a":12,"b":12,"c":12,"d":0}

Converts a numerical type into a 32-bit unsigned integer, this is for advanced use cases where a specific data type is needed for a given component (such as the ClickHouse SQL driver).

root.a = this.a.uint32()
root.b = this.b.round().uint32()
root.c = this.c.uint32()
root.d = this.d.uint32().catch(0)
# In:  {"a":12,"b":12.34,"c":"12","d":-12}
# Out: {"a":12,"b":12,"c":12,"d":0}

Converts a numerical type into a 64-bit unsigned integer, this is for advanced use cases where a specific data type is needed for a given component (such as the ClickHouse SQL driver).

root.a = this.a.uint64()
root.b = this.b.round().uint64()
root.c = this.c.uint64()
root.d = this.d.uint64().catch(0)
# In:  {"a":12,"b":12.34,"c":"12","d":-12}
# Out: {"a":12,"b":12,"c":12,"d":0}

Converts a numerical type into a 8-bit unsigned integer, this is for advanced use cases where a specific data type is needed for a given component (such as the ClickHouse SQL driver).

root.a = this.a.uint8()
root.b = this.b.round().uint8()
root.c = this.c.uint8()
root.d = this.d.uint8().catch(0)
# In:  {"a":12,"b":12.34,"c":"12","d":-12}
# Out: {"a":12,"b":12,"c":12,"d":0}

Attempts to parse a string as a duration and returns an integer of nanoseconds. A duration string is a possibly signed sequence of decimal numbers, each with an optional fraction and a unit suffix, such as "300ms", "-1.5h" or "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".

root.delay_for_ns = this.delay_for.parse_duration()
# In:  {"delay_for":"50us"}
# Out: {"delay_for_ns":50000}

Attempts to parse a string using ISO-8601 rules as a duration and returns an integer of nanoseconds. A duration string is represented by the format "P[n]Y[n]M[n]DT[n]H[n]M[n]S" or "P[n]W". In these representations, the "[n]" is replaced by the value for each of the date and time elements that follow the "[n]". For example, "P3Y6M4DT12H30M5S" represents a duration of "three years, six months, four days, twelve hours, thirty minutes, and five seconds". The last field of the format allows fractions with one decimal place, so "P3.5S" will return 3500000000ns. Any additional decimals will be truncated.

Arbitrary ISO-8601 duration string to nanoseconds:

root.delay_for_ns = this.delay_for.parse_duration_iso8601()
# In:  {"delay_for":"P3Y6M4DT12H30M5S"}
# Out: {"delay_for_ns":110839937000000000}

Two hours ISO-8601 duration string to seconds:

root.delay_for_s = this.delay_for.parse_duration_iso8601() / 1000000000
# In:  {"delay_for":"PT2H"}
# Out: {"delay_for_s":7200}

Two and a half seconds ISO-8601 duration string to seconds:

root.delay_for_s = this.delay_for.parse_duration_iso8601() / 1000000000
# In:  {"delay_for":"PT2.5S"}
# Out: {"delay_for_s":2.5}

Parse parameter string as ISO 8601 period and add it to value with high precision for units larger than an hour.

duration <string> Duration in ISO 8601 format

Attempts to format a timestamp value as a string according to a specified format, or RFC 3339 by default. Timestamp values can either be a numerical unix time in seconds (with up to nanosecond precision via decimals), or a string in RFC 3339 format.

format <string, default "2006-01-02T15:04:05.999999999Z07:00" > The output format to use. tz <(optional) string> An optional timezone to use, otherwise the timezone of the input string is used, or in the case of unix timestamps the local timezone is used.

root.something_at = (this.created_at + 300).ts_format()

An optional string argument can be used in order to specify the output format of the timestamp. The format is defined by showing how the reference time, defined to be Mon Jan 2 15:04:05 -0700 MST 2006, would be displayed if it were the value.

root.something_at = (this.created_at + 300).ts_format("2006-Jan-02 15:04:05")

A second optional string argument can also be used in order to specify a timezone, otherwise the timezone of the input string is used, or in the case of unix timestamps the local timezone is used.

root.something_at = this.created_at.ts_format(format: "2006-Jan-02 15:04:05", tz: "UTC")
# In:  {"created_at":1597405526}
# Out: {"something_at":"2020-Aug-14 11:45:26"}
# In:  {"created_at":"2020-08-14T11:50:26.371Z"}
# Out: {"something_at":"2020-Aug-14 11:50:26"}

And ts_format supports up to nanosecond precision with floating point timestamp values.

root.something_at = this.created_at.ts_format("2006-Jan-02 15:04:05.999999", "UTC")
# In:  {"created_at":1597405526.123456}
# Out: {"something_at":"2020-Aug-14 11:45:26.123456"}
# In:  {"created_at":"2020-08-14T11:50:26.371Z"}
# Out: {"something_at":"2020-Aug-14 11:50:26.371"}

format <string> The format of the target string.

root.doc.timestamp = this.doc.timestamp.ts_parse("2006-Jan-02")
# In:  {"doc":{"timestamp":"2020-Aug-14"}}
# Out: {"doc":{"timestamp":"2020-08-14T00:00:00Z"}}

duration <integer> A duration measured in nanoseconds to round by.

Use the method parse_duration to convert a duration string into an integer argument.

root.created_at_hour = this.created_at.ts_round("1h".parse_duration())
# In:  {"created_at":"2020-08-14T05:54:23Z"}
# Out: {"created_at_hour":"2020-08-14T06:00:00Z"}

Attempts to format a timestamp value as a string according to a specified strftime-compatible format. Timestamp values can either be a numerical unix time in seconds (with up to nanosecond precision via decimals), or a string in RFC 3339 format.

format <string> The output format to use. tz <(optional) string> An optional timezone to use, otherwise the timezone of the input string is used.

format <string> The format of the target string.

t2 <timestamp> The second timestamp to be subtracted from the method target.

Use the .abs() method in order to calculate an absolute duration between two timestamps.

root.between = this.started_at.ts_sub("2020-08-14T05:54:23Z").abs()
# In:  {"started_at":"2020-08-13T05:54:23Z"}
# Out: {"between":86400000000000}

Parse parameter string as ISO 8601 period and subtract it from value with high precision for units larger than an hour.

duration <string> Duration in ISO 8601 format

tz <string> The timezone to change to. If set to "UTC" then the timezone will be UTC. If set to "Local" then the local timezone will be used. Otherwise, the argument is taken to be a location name corresponding to a file in the IANA Time Zone database, such as "America/New_York".

root.created_at_utc = this.created_at.ts_tz("UTC")
# In:  {"created_at":"2021-02-03T17:05:06+01:00"}
# Out: {"created_at_utc":"2021-02-03T16:05:06Z"}

root.created_at_unix = this.created_at.ts_unix()
# In:  {"created_at":"2009-11-10T23:00:00Z"}
# Out: {"created_at_unix":1257894000}

root.created_at_unix = this.created_at.ts_unix_micro()
# In:  {"created_at":"2009-11-10T23:00:00Z"}
# Out: {"created_at_unix":1257894000000000}

root.created_at_unix = this.created_at.ts_unix_milli()
# In:  {"created_at":"2009-11-10T23:00:00Z"}
# Out: {"created_at_unix":1257894000000}

root.created_at_unix = this.created_at.ts_unix_nano()
# In:  {"created_at":"2009-11-10T23:00:00Z"}
# Out: {"created_at_unix":1257894000000000000}

Return an array containing the target value. If the value is already an array it is unchanged.

root.my_array = this.name.array()
# In:  {"name":"foobar bazson"}
# Out: {"my_array":["foobar bazson"]}

Attempt to parse a value into a boolean. An optional argument can be provided, in which case if the value cannot be parsed the argument will be returned instead. If the value is a number then any non-zero value will resolve to true , if the value is a string then any of the following values are considered valid: 1, t, T, TRUE, true, True, 0, f, F, FALSE .

default <(optional) bool> An optional value to yield if the target cannot be parsed as a boolean.

root.foo = this.thing.bool()
root.bar = this.thing.bool(true)

Marshal a value into a byte array. If the value is already a byte array it is unchanged.

root.first_byte = this.name.bytes().index(0)
# In:  {"name":"foobar bazson"}
# Out: {"first_byte":102}

Ensures that the given string, array or object value is not empty, and if so returns it, otherwise an error is returned.

root.a = this.a.not_empty()
# In:  {"a":"foo"}
# Out: {"a":"foo"}
# In:  {"a":""}
# Out: Error("failed assignment (line 1): field `this.a`: string value is empty")
# In:  {"a":["foo","bar"]}
# Out: {"a":["foo","bar"]}
# In:  {"a":[]}
# Out: Error("failed assignment (line 1): field `this.a`: array value is empty")
# In:  {"a":{"b":"foo","c":"bar"}}
# Out: {"a":{"b":"foo","c":"bar"}}
# In:  {"a":{}}
# Out: Error("failed assignment (line 1): field `this.a`: object value is empty")

Ensures that the given value is not null , and if so returns it, otherwise an error is returned.

root.a = this.a.not_null()
# In:  {"a":"foobar","b":"barbaz"}
# Out: {"a":"foobar"}
# In:  {"b":"barbaz"}
# Out: Error("failed assignment (line 1): field `this.a`: value is null")

Attempt to parse a value into a number. An optional argument can be provided, in which case if the value cannot be parsed into a number the argument will be returned instead.

default <(optional) float> An optional value to yield if the target cannot be parsed as a number.

root.foo = this.thing.number() + 10
root.bar = this.thing.number(5) * 10

default <(optional) timestamp> An optional value to return if the target value cannot be parsed as a timestamp .

root.creation_time = this.ts.timestamp()
root.default_time = this.none.timestamp(1734443120.timestamp())

Returns the type of a value as a string, providing one of the following values: string , bytes , number , bool , timestamp , array , object or null .

root.bar_type = this.bar.type()
root.foo_type = this.foo.type()
# In:  {"bar":10,"foo":"is a string"}
# Out: {"bar_type":"number","foo_type":"string"}

Checks each element of an array against a query and returns true if all elements passed. An error occurs if the target is not an array, or if any element results in the provided query returning a non-boolean result. Returns false if the target array is empty.

test <query expression> A test query to apply to each element.

root.all_over_21 = this.patrons.all(patron -> patron.age >= 21)
# In:  {"patrons":[{"id":"1","age":18},{"id":"2","age":23}]}
# Out: {"all_over_21":false}
# In:  {"patrons":[{"id":"1","age":45},{"id":"2","age":23}]}
# Out: {"all_over_21":true}

Checks the elements of an array against a query and returns true if any element passes. An error occurs if the target is not an array, or if an element results in the provided query returning a non-boolean result. Returns false if the target array is empty.

test <query expression> A test query to apply to each element.

root.any_over_21 = this.patrons.any(patron -> patron.age >= 21)
# In:  {"patrons":[{"id":"1","age":18},{"id":"2","age":23}]}
# Out: {"any_over_21":true}
# In:  {"patrons":[{"id":"1","age":10},{"id":"2","age":12}]}
# Out: {"any_over_21":false}

with <unknown> A value to merge the target value with.

root = this.foo.assign(this.bar)
# In:  {"foo":{"first_name":"fooer","likes":"bars"},"bar":{"second_name":"barer","likes":"foos"}}
# Out: {"first_name":"fooer","likes":"foos","second_name":"barer"}

Collapse an array or object into an object of key/value pairs for each field, where the key is the full path of the structured field in dot path notation. Empty arrays an objects are ignored by default.

include_empty <bool, default false > Whether to include empty objects and arrays in the resulting object.

root.result = this.collapse()
# In:  {"foo":[{"bar":"1"},{"bar":{}},{"bar":"2"},{"bar":[]}]}
# Out: {"result":{"foo.0.bar":"1","foo.2.bar":"2"}}

An optional boolean parameter can be set to true in order to include empty objects and arrays.

root.result = this.collapse(include_empty: true)
# In:  {"foo":[{"bar":"1"},{"bar":{}},{"bar":"2"},{"bar":[]}]}
# Out: {"result":{"foo.0.bar":"1","foo.1.bar":{},"foo.2.bar":"2","foo.3.bar":[]}}

root.foo = this.foo.concat(this.bar, this.baz)
# In:  {"foo":["a","b"],"bar":["c"],"baz":["d","e","f"]}
# Out: {"foo":["a","b","c","d","e","f"]}

Checks whether an array contains an element matching the argument, or an object contains a value matching the argument, and returns a boolean result. Numerical comparisons are made irrespective of the representation type (float versus integer).

value <unknown> A value to test against elements of the target.

root.has_foo = this.thing.contains("foo")
# In:  {"thing":["this","foo","that"]}
# Out: {"has_foo":true}
# In:  {"thing":["this","bar","that"]}
# Out: {"has_foo":false}

other <unknown> The value to compare against.

Converts an array into a new array of objects, where each object has a field index containing the index of the element and a field value containing the original value of the element.

root.foo = this.foo.enumerated()
# In:  {"foo":["bar","baz"]}
# Out: {"foo":[{"index":0,"value":"bar"},{"index":1,"value":"baz"}]}

root = this.explode("value")
# In:  {"id":1,"value":{"foo":2,"bar":[3,4],"baz":{"bev":5}}}
# Out: {"bar":{"id":1,"value":[3,4]},"baz":{"id":1,"value":{"bev":5}},"foo":{"id":1,"value":2}}

Executes a mapping query argument for each element of an array or key/value pair of an object. If the query returns false the item is removed from the resulting array or object. The item will also be removed if the query returns any non-boolean value.

test <query expression> A query to apply to each element, if this query resolves to any value other than a boolean true the element will be removed from the result.

root.new_nums = this.nums.filter(num -> num > 10)
# In:  {"nums":[3,11,4,17]}
# Out: {"new_nums":[11,17]}

When filtering objects the mapping query argument is provided a context with a field key containing the value key, and a field value containing the value.

root.new_dict = this.dict.filter(item -> item.value.contains("foo"))
# In:  {"dict":{"first":"hello foo","second":"world","third":"this foo is great"}}
# Out: {"new_dict":{"first":"hello foo","third":"this foo is great"}}

Returns the index of the first occurrence of a value in an array. -1 is returned if there are no matches. Numerical comparisons are made irrespective of the representation type (float versus integer).

value <unknown> A value to find.

root.index = this.find("bar")
# In:  ["foo", "bar", "baz"]
# Out: {"index":1}

root.index = this.things.find(this.goal)
# In:  {"goal":"bar","things":["foo", "bar", "baz"]}
# Out: {"index":1}

Returns an array containing the indexes of all occurrences of a value in an array. An empty array is returned if there are no matches. Numerical comparisons are made irrespective of the representation type (float versus integer).

value <unknown> A value to find.

root.index = this.find_all("bar")
# In:  ["foo", "bar", "baz", "bar"]
# Out: {"index":[1,3]}

root.indexes = this.things.find_all(this.goal)
# In:  {"goal":"bar","things":["foo", "bar", "baz", "bar", "buz"]}
# Out: {"indexes":[1,3]}

Returns an array containing the indexes of all occurrences of an array where the provided query resolves to a boolean true . An empty array is returned if there are no matches. Numerical comparisons are made irrespective of the representation type (float versus integer).

query <query expression> A query to execute for each element.

root.index = this.find_all_by(v -> v != "bar")
# In:  ["foo", "bar", "baz"]
# Out: {"index":[0,2]}

Returns the index of the first occurrence of an array where the provided query resolves to a boolean true . -1 is returned if there are no matches.

query <query expression> A query to execute for each element.

root.index = this.find_by(v -> v != "bar")
# In:  ["foo", "bar", "baz"]
# Out: {"index":0}

Iterates an array and any element that is itself an array is removed and has its elements inserted directly in the resulting array.

root.result = this.flatten()
# In:  ["foo",["bar","baz"],"buz"]
# Out: {"result":["foo","bar","baz","buz"]}

Takes two arguments: an initial value, and a mapping query. For each element of an array the mapping context is an object with two fields tally and value , where tally contains the current accumulated value and value is the value of the current element. The mapping must return the result of adding the value to the tally.

The first argument is the value that tally will have on the first call.

initial <unknown> The initial value to start the fold with. For example, an empty object {} , a zero count 0 , or an empty string "" . query <query expression> A query to apply for each element. The query is provided an object with two fields; tally containing the current tally, and value containing the value of the current element. The query should result in a new tally to be passed to the next element query.

root.sum = this.foo.fold(0, item -> item.tally + item.value)
# In:  {"foo":[3,8,11]}
# Out: {"sum":22}

root.result = this.foo.fold("", item -> "%v%v".format(item.tally, item.value))
# In:  {"foo":["hello ", "world"]}
# Out: {"result":"hello world"}

You can use fold to merge an array of objects together:

root.smoothie = this.fruits.fold({}, item -> item.tally.merge(item.value))
# In:  {"fruits":[{"apple":5},{"banana":3},{"orange":8}]}
# Out: {"smoothie":{"apple":5,"banana":3,"orange":8}}

root.result = this.foo.get(this.target)
# In:  {"foo":{"bar":"from bar","baz":"from baz"},"target":"bar"}
# Out: {"result":"from bar"}
# In:  {"foo":{"bar":"from bar","baz":"from baz"},"target":"baz"}
# Out: {"result":"from baz"}

Extract an element from an array by an index. The index can be negative, and if so the element will be selected from the end counting backwards starting from -1. E.g. an index of -1 returns the last element, an index of -2 returns the element before the last, and so on.

index <integer> The index to obtain from an array.

root.last_name = this.names.index(-1)
# In:  {"names":["rachel","stevens"]}
# Out: {"last_name":"stevens"}

It is also possible to use this method on byte arrays, in which case the selected element will be returned as an integer.

root.last_byte = this.name.bytes().index(-1)
# In:  {"name":"foobar bazson"}
# Out: {"last_byte":110}

root.joined_words = this.words.join()
root.joined_numbers = this.numbers.map_each(this.string()).join(",")
# In:  {"words":["hello","world"],"numbers":[3,8,11]}
# Out: {"joined_numbers":"3,8,11","joined_words":"helloworld"}

expression <string> The JSONPath expression to execute.

root.all_names = this.json_path("$..name")
# In:  {"name":"alice","foo":{"name":"bob"}}
# Out: {"all_names":["alice","bob"]}
# In:  {"thing":["this","bar",{"name":"alice"}]}
# Out: {"all_names":["alice"]}

root.text_objects = this.json_path("$.body[?(@.type=='text')]")
# In:  {"body":[{"type":"image","id":"foo"},{"type":"text","id":"bar"}]}
# Out: {"text_objects":[{"id":"bar","type":"text"}]}

schema <string> The schema to check values against.

root = this.json_schema("""{
  "type":"object",
  "properties":{
    "foo":{
      "type":"string"
}""")
# In:  {"foo":"bar"}
# Out: {"foo":"bar"}
# In:  {"foo":5}
# Out: Error("failed assignment (line 1): field `this`: foo invalid type. expected: string, given: integer")

In order to load a schema from a file use the file function.

root = this.json_schema(file(env("BENTHOS_TEST_BLOBLANG_SCHEMA_FILE")))

Returns the key/value pairs of an object as an array, where each element is an object with a key field and a value field. The order of the resulting array will be random.

root.foo_key_values = this.foo.key_values().sort_by(pair -> pair.key)
# In:  {"foo":{"bar":1,"baz":2}}
# Out: {"foo_key_values":[{"key":"bar","value":1},{"key":"baz","value":2}]}

root.new_dict = this.dict.map_each(item -> item.value.uppercase())
# In:  {"dict":{"foo":"hello","bar":"world"}}
# Out: {"new_dict":{"bar":"WORLD","foo":"HELLO"}}

Apply a mapping to each key of an object, and replace the key with the result, which must be a string.

query <query expression> A query that will be used to map each key.

root.new_dict = this.dict.map_each_key(key -> key.uppercase())
# In:  {"dict":{"keya":"hello","keyb":"world"}}
# Out: {"new_dict":{"KEYA":"hello","KEYB":"world"}}

root = this.map_each_key(key -> if key.contains("kafka") { "_" + key })
# In:  {"amqp_key":"foo","kafka_key":"bar","kafka_topic":"baz"}
# Out: {"_kafka_key":"bar","_kafka_topic":"baz","amqp_key":"foo"}

with <unknown> A value to merge the target value with.

root = this.foo.merge(this.bar)
# In:  {"foo":{"first_name":"fooer","likes":"bars"},"bar":{"second_name":"barer","likes":"foos"}}
# Out: {"first_name":"fooer","likes":["bars","foos"],"second_name":"barer"}

changelog <unknown> The changelog to apply.

Extract a slice from an array by specifying two indices, a low and high bound, which selects a half-open range that includes the first element, but excludes the last one. If the second index is omitted then it defaults to the length of the input sequence.

low <integer> The low bound, which is the first element of the selection, or if negative selects from the end. high <(optional) integer> An optional high bound.

root.beginning = this.value.slice(0, 2)
root.end = this.value.slice(4)
# In:  {"value":["foo","bar","baz","buz","bev"]}
# Out: {"beginning":["foo","bar"],"end":["bev"]}

A negative low index can be used, indicating an offset from the end of the sequence. If the low index is greater than the length of the sequence then an empty result is returned.

root.last_chunk = this.value.slice(-2)
root.the_rest = this.value.slice(0, -2)
# In:  {"value":["foo","bar","baz","buz","bev"]}
# Out: {"last_chunk":["buz","bev"],"the_rest":["foo","bar","baz"]}

Attempts to sort the values of an array in increasing order. The type of all values must match in order for the ordering to succeed. Supports string and number values.

compare <(optional) query expression> An optional query that should explicitly compare elements left and right and provide a boolean result.

root.sorted = this.foo.sort()
# In:  {"foo":["bbb","ccc","aaa"]}
# Out: {"sorted":["aaa","bbb","ccc"]}

It’s also possible to specify a mapping argument, which is provided an object context with fields left and right , the mapping must return a boolean indicating whether the left value is less than right . This allows you to sort arrays containing non-string or non-number values.

root.sorted = this.foo.sort(item -> item.left.v < item.right.v)
# In:  {"foo":[{"id":"foo","v":"bbb"},{"id":"bar","v":"ccc"},{"id":"baz","v":"aaa"}]}
# Out: {"sorted":[{"id":"baz","v":"aaa"},{"id":"foo","v":"bbb"},{"id":"bar","v":"ccc"}]}

Attempts to sort the elements of an array, in increasing order, by a value emitted by an argument query applied to each element. The type of all values must match in order for the ordering to succeed. Supports string and number values.

query <query expression> A query to apply to each element that yields a value used for sorting.

root.sorted = this.foo.sort_by(ele -> ele.id)
# In:  {"foo":[{"id":"bbb","message":"bar"},{"id":"aaa","message":"foo"},{"id":"ccc","message":"baz"}]}
# Out: {"sorted":[{"id":"aaa","message":"foo"},{"id":"bbb","message":"bar"},{"id":"ccc","message":"baz"}]}

Squashes an array of objects into a single object, where key collisions result in the values being merged (following similar rules as the .merge() method)

root.locations = this.locations.map_each(loc -> {loc.state: [loc.name]}).squash()
# In:  {"locations":[{"name":"Seattle","state":"WA"},{"name":"New York","state":"NY"},{"name":"Bellevue","state":"WA"},{"name":"Olympia","state":"WA"}]}
# Out: {"locations":{"NY":["New York"],"WA":["Seattle","Bellevue","Olympia"]}}

Attempts to remove duplicate values from an array. The array may contain a combination of different value types, but numbers and strings are checked separately ( "5" is a different element to 5 ).

emit <(optional) query expression> An optional query that can be used in order to yield a value for each element to determine uniqueness.

root.uniques = this.foo.unique()
# In:  {"foo":["a","b","a","c"]}
# Out: {"uniques":["a","b","c"]}

Returns the values of an object as an array. The order of the resulting array will be random.

root.foo_vals = this.foo.values().sort()
# In:  {"foo":{"bar":1,"baz":2}}
# Out: {"foo_vals":[1,2]}

root = this.with("inner.a","inner.c","d")
# In:  {"inner":{"a":"first","b":"second","c":"third"},"d":"fourth","e":"fifth"}
# Out: {"d":"fourth","inner":{"a":"first","c":"third"}}

root = this.without("inner.a","inner.c","d")
# In:  {"inner":{"a":"first","b":"second","c":"third"},"d":"fourth","e":"fifth"}
# Out: {"e":"fifth","inner":{"b":"second"}}

root.foo = this.foo.zip(this.bar, this.baz)
# In:  {"foo":["a","b","c"],"bar":[1,2,3],"baz":[4,5,6]}
# Out: {"foo":[["a",1,4],["b",2,5],["c",3,6]]}

Executes an argument Bloblang mapping on the target. This method can be used in order to execute dynamic mappings. Imports and functions that interact with the environment, such as file and env , or that access message information directly, such as content or json , are not enabled for dynamic Bloblang mappings.

mapping <string> The mapping to execute.

root.body = this.body.bloblang(this.mapping)
# In:  {"body":{"foo":"hello world"},"mapping":"root.foo = this.foo.uppercase()"}
# Out: {"body":{"foo":"HELLO WORLD"}}
# In:  {"body":{"foo":"hello world 2"},"mapping":"root.foo = this.foo.capitalize()"}
# Out: {"body":{"foo":"Hello World 2"}}

Serializes a target value into a pretty-printed JSON byte array (with 4 space indentation by default).

indent <string, default " " > Indentation string. Each element in a JSON object or array will begin on a new, indented line followed by one or more copies of indent according to the indentation nesting. no_indent <bool, default false > Disable indentation. escape_html <bool, default true > Escape problematic HTML characters.

root = this.doc.format_json()
# In:  {"doc":{"foo":"bar"}}
# Out: {
#          "foo": "bar"
#      }

Pass a string to the indent parameter in order to customise the indentation.

root = this.format_json("  ")
# In:  {"doc":{"foo":"bar"}}
# Out: {
#        "doc": {
#          "foo": "bar"
#        }
#      }

Use the .string() method in order to coerce the result into a string.

root.doc = this.doc.format_json().string()
# In:  {"doc":{"foo":"bar"}}
# Out: {"doc":"{\n    \"foo\": \"bar\"\n}"}

Set the no_indent parameter to true to disable indentation. The result is equivalent to calling bytes() .

root = this.doc.format_json(no_indent: true)
# In:  {"doc":{"foo":"bar"}}
# Out: {"foo":"bar"}

Escapes problematic HTML characters.

root = this.doc.format_json()
# In:  {"doc":{"email":"foo&[email protected]","name":"foo>bar"}}
# Out: {
#          "email": "foo\[email protected]",
#          "name": "foo\u003ebar"
#      }

Set the escape_html parameter to false to disable escaping of problematic HTML characters.

root = this.doc.format_json(escape_html: false)
# In:  {"doc":{"email":"foo&[email protected]","name":"foo>bar"}}
# Out: {
#          "email": "foo&[email protected]",
#          "name": "foo>bar"
#      }

indent <string, default " " > Indentation string. Each element in an XML object or array will begin on a new, indented line followed by one or more copies of indent according to the indentation nesting. no_indent <bool, default false > Disable indentation.

Serializes a target value into a pretty-printed XML byte array (with 4 space indentation by default).

root = this.format_xml()
# In:  {"foo":{"bar":{"baz":"foo bar baz"}}}
# Out: <foo>
#          <bar>
#              <baz>foo bar baz</baz>
#          </bar>
#      </foo>

Pass a string to the indent parameter in order to customise the indentation.

root = this.format_xml("  ")
# In:  {"foo":{"bar":{"baz":"foo bar baz"}}}
# Out: <foo>
#        <bar>
#          <baz>foo bar baz</baz>
#        </bar>
#      </foo>

Use the .string() method in order to coerce the result into a string.

root.doc = this.format_xml("").string()
# In:  {"foo":{"bar":{"baz":"foo bar baz"}}}
# Out: {"doc":"<foo>\n<bar>\n<baz>foo bar baz</baz>\n</bar>\n</foo>"}

Set the no_indent parameter to true to disable indentation.

root = this.format_xml(no_indent: true)
# In:  {"foo":{"bar":{"baz":"foo bar baz"}}}
# Out: <foo><bar><baz>foo bar baz</baz></bar></foo>

Attempts to parse a string into an array of objects by following the CSV format described in RFC 4180.

parse_header_row <bool, default true > Whether to reference the first row as a header row. If set to true the output structure for messages will be an object where field keys are determined by the header row. Otherwise, the output will be an array of row arrays. delimiter <string, default "," > The delimiter to use for splitting values in each record. It must be a single character. lazy_quotes <bool, default false > If set to true , a quote may appear in an unquoted field and a non-doubled quote may appear in a quoted field.

Parses CSV data with a header row

root.orders = this.orders.parse_csv()
# In:  {"orders":"foo,bar\nfoo 1,bar 1\nfoo 2,bar 2"}
# Out: {"orders":[{"bar":"bar 1","foo":"foo 1"},{"bar":"bar 2","foo":"foo 2"}]}

Parses CSV data without a header row

root.orders = this.orders.parse_csv(false)
# In:  {"orders":"foo 1,bar 1\nfoo 2,bar 2"}
# Out: {"orders":[["foo 1","bar 1"],["foo 2","bar 2"]]}

Parses CSV data delimited by dots

root.orders = this.orders.parse_csv(delimiter:".")
# In:  {"orders":"foo.bar\nfoo 1.bar 1\nfoo 2.bar 2"}
# Out: {"orders":[{"bar":"bar 1","foo":"foo 1"},{"bar":"bar 2","foo":"foo 2"}]}

Parses CSV data containing a quote in an unquoted field

root.orders = this.orders.parse_csv(lazy_quotes:true)
# In:  {"orders":"foo,bar\nfoo 1,bar 1\nfoo\" \"2,bar\" \"2"}
# Out: {"orders":[{"bar":"bar 1","foo":"foo 1"},{"bar":"bar\" \"2","foo":"foo\" \"2"}]}

Attempts to parse a url-encoded query string (from an x-www-form-urlencoded request body) and returns a structured result.

root.values = this.body.parse_form_url_encoded()
# In:  {"body":"noise=meow&animal=cat&fur=orange&fur=fluffy"}
# Out: {"values":{"animal":"cat","fur":["orange","fluffy"],"noise":"meow"}}

root.doc = this.doc.parse_json(use_number: true)
# In:  {"doc":"{\"foo\":\"11380878173205700000000000000000000000000000000\"}"}
# Out: {"doc":{"foo":"11380878173205700000000000000000000000000000000"}}

byte_array_as_string <bool, default false > Deprecated: This parameter is no longer used.

root = content().parse_parquet()

root.foo_url = this.foo_url.parse_url()
# In:  {"foo_url":"https://docs.redpanda.com/redpanda-connect/guides/bloblang/about/"}
# Out: {"foo_url":{"fragment":"","host":"docs.redpanda.com","opaque":"","path":"/redpanda-connect/guides/bloblang/about/","raw_fragment":"","raw_path":"","raw_query":"","scheme":"https"}}

root.username = this.url.parse_url().user.name | "unknown"
# In:  {"url":"amqp://foo:[email protected]:5672/"}
# Out: {"username":"foo"}
# In:  {"url":"redis://localhost:6379"}
# Out: {"username":"unknown"}

If an element contains attributes they are parsed by prefixing a hyphen, - , to the attribute label.

If the element is a simple element and has attributes, the element value is given the key #text .

XML comments, directives, and process instructions are ignored.

When elements are repeated the resulting JSON value is an array.

If cast is true, try to cast values to numbers and booleans instead of returning strings.

root.doc = this.doc.parse_xml()
# In:  {"doc":"<root><title>This is a title</title><content>This is some content</content></root>"}
# Out: {"doc":{"root":{"content":"This is some content","title":"This is a title"}}}

root.doc = this.doc.parse_xml(cast: false)
# In:  {"doc":"<root><title>This is a title</title><number id=99>123</number><bool>True</bool></root>"}
# Out: {"doc":{"root":{"bool":"True","number":{"#text":"123","-id":"99"},"title":"This is a title"}}}

root.doc = this.doc.parse_xml(cast: true)
# In:  {"doc":"<root><title>This is a title</title><number id=99>123</number><bool>True</bool></root>"}
# Out: {"doc":{"root":{"bool":true,"number":{"#text":123,"-id":99},"title":"This is a title"}}}

let long_content = range(0, 1000).map_each(content()).join(" ")
root.a_len = $long_content.length()
root.b_len = $long_content.compress("gzip").length()
# In:  hello world this is some content
# Out: {"a_len":32999,"b_len":161}

root.compressed = content().compress("lz4").encode("base64")
# In:  hello world I love space
# Out: {"compressed":"BCJNGGRwuRgAAIBoZWxsbyB3b3JsZCBJIGxvdmUgc3BhY2UAAAAAGoETLg=="}

Decodes an encoded string target according to a chosen scheme and returns the result as a byte array. When mapping the result to a JSON field the value should be cast to a string using the method string , or encoded using the method encode , otherwise it will be base64 encoded by default.

scheme <string> The decoding scheme to use.

root.decoded = this.value.decode("hex").string()
# In:  {"value":"68656c6c6f20776f726c64"}
# Out: {"decoded":"hello world"}

root = this.encoded.decode("ascii85")
# In:  {"encoded":"FD,B0+DGm>FDl80Ci\"A>F`)8BEckl6F`M&(+Cno&@/"}
# Out: this is totally unstructured data

Decompresses a string or byte array value according to a specified algorithm. The result of decompression

algorithm <string> One of gzip , pgzip , zlib , bzip2 , flate , snappy , lz4 , zstd .

root = this.compressed.decode("base64").decompress("lz4")
# In:  {"compressed":"BCJNGGRwuRgAAIBoZWxsbyB3b3JsZCBJIGxvdmUgc3BhY2UAAAAAGoETLg=="}
# Out: hello world I love space

Use the .string() method in order to coerce the result into a string, this makes it possible to place the data within a JSON document without automatic base64 encoding.

root.result = this.compressed.decode("base64").decompress("lz4").string()
# In:  {"compressed":"BCJNGGRwuRgAAIBoZWxsbyB3b3JsZCBJIGxvdmUgc3BhY2UAAAAAGoETLg=="}
# Out: {"result":"hello world I love space"}

Decrypts an encrypted string or byte array target according to a chosen AES encryption method and returns the result as a byte array. The algorithms require a key and an initialization vector / nonce. Available schemes are: ctr , gcm , ofb , cbc .

scheme <string> The scheme to use for decryption, one of ctr , gcm , ofb , cbc . key <string> A key to decrypt with. iv <string> An initialization vector / nonce.

let key = "2b7e151628aed2a6abf7158809cf4f3c".decode("hex")
let vector = "f0f1f2f3f4f5f6f7f8f9fafbfcfdfeff".decode("hex")
root.decrypted = this.value.decode("hex").decrypt_aes("ctr", $key, $vector).string()
# In:  {"value":"84e9b31ff7400bdf80be7254"}
# Out: {"decrypted":"hello world!"}

scheme <string> The encoding scheme to use.

root.encoded = this.value.encode("hex")
# In:  {"value":"hello world"}
# Out: {"encoded":"68656c6c6f20776f726c64"}

Encrypts a string or byte array target according to a chosen AES encryption method and returns a string result. The algorithms require a key and an initialization vector / nonce. Available schemes are: ctr , gcm , ofb , cbc .

scheme <string> The scheme to use for encryption, one of ctr , gcm , ofb , cbc . key <string> A key to encrypt with. iv <string> An initialization vector / nonce.

let key = "2b7e151628aed2a6abf7158809cf4f3c".decode("hex")
let vector = "f0f1f2f3f4f5f6f7f8f9fafbfcfdfeff".decode("hex")
root.encrypted = this.value.encrypt_aes("ctr", $key, $vector).encode("hex")
# In:  {"value":"hello world!"}
# Out: {"encrypted":"84e9b31ff7400bdf80be7254"}

algorithm <string> The hasing algorithm to use. key <(optional) string> An optional key to use. polynomial <string, default "IEEE" > An optional polynomial key to use when selecting the crc32 algorithm, otherwise ignored. Options are IEEE (default), Castagnoli and Koopman

root.h1 = this.value.hash("sha1").encode("hex")
root.h2 = this.value.hash("hmac_sha1","static-key").encode("hex")
# In:  {"value":"hello world"}
# Out: {"h1":"2aae6c35c94fcfb415dbe95f408b9ce91ee846ed","h2":"d87e5f068fa08fe90bb95bc7c8344cb809179d76"}

The crc32 algorithm supports options for the polynomial.

root.h1 = this.value.hash(algorithm: "crc32", polynomial: "Castagnoli").encode("hex")
root.h2 = this.value.hash(algorithm: "crc32", polynomial: "Koopman").encode("hex")
# In:  {"value":"hello world"}
# Out: {"h1":"c99465aa","h2":"df373d3c"}

ns <(optional) string> An optional namespace name or UUID. Supported predefined namespaces include: dns , url , oid , and x500 , but you can use any valid RFC-9562 UUID.

If omitted, the nil UUID is used as the default namespace.

root.id = "example".uuid_v5()
root.id = "example".uuid_v5("x500")
root.id = "example".uuid_v5("77f836b7-9f61-46c0-851e-9b6ca3535e69")

You can insert this vector into SQL databases that support embeddings vectors. For example, pgvector .

Introduced in version 4.33.0.

Create a vector from an array literal.

root.embeddings = [1.2, 0.6, 0.9].vector()

Create a vector from an array.

root.embedding_vector = this.embedding_array.vector()

Parses a claims object from a JWT string encoded with ES256. This method does not validate JWT claims.

Introduced in version v4.20.0.

signing_secret <string> The ES256 secret that was used for signing the token.

root.claims = this.signed.parse_jwt_es256("""-----BEGIN PUBLIC KEY-----
MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEGtLqIBePHmIhQcf0JLgc+F/4W/oI
dp0Gta53G35VerNDgUUXmp78J2kfh4qLdh0XtmOMI587tCaqjvDAXfs//w==
-----END PUBLIC KEY-----""")
# In:  {"signed":"eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE1MTYyMzkwMjIsIm1vb2QiOiJEaXNkYWluZnVsIiwic3ViIjoiMTIzNDU2Nzg5MCJ9.GIRajP9JJbpTlqSCdNEz4qpQkRvzX4Q51YnTwVyxLDM9tKjR_a8ggHWn9CWj7KG0x8J56OWtmUxn112SRTZVhQ"}
# Out: {"claims":{"iat":1516239022,"mood":"Disdainful","sub":"1234567890"}}

Parses a claims object from a JWT string encoded with ES384. This method does not validate JWT claims.

Introduced in version v4.20.0.

signing_secret <string> The ES384 secret that was used for signing the token.

root.claims = this.signed.parse_jwt_es384("""-----BEGIN PUBLIC KEY-----
MHYwEAYHKoZIzj0CAQYFK4EEACIDYgAERoz74/B6SwmLhs8X7CWhnrWyRrB13AuU
8OYeqy0qHRu9JWNw8NIavqpTmu6XPT4xcFanYjq8FbeuM11eq06C52mNmS4LLwzA
2imlFEgn85bvJoC3bnkuq4mQjwt9VxdH
-----END PUBLIC KEY-----""")
# In:  {"signed":"eyJhbGciOiJFUzM4NCIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE1MTYyMzkwMjIsIm1vb2QiOiJEaXNkYWluZnVsIiwic3ViIjoiMTIzNDU2Nzg5MCJ9.H2HBSlrvQBaov2tdreGonbBexxtQB-xzaPL4-tNQZ6TVh7VH8VBcSwcWHYa1lBAHmdsKOFcB2Wk0SB7QWeGT3ptSgr-_EhDMaZ8bA5spgdpq5DsKfaKHrd7DbbQlmxNq"}
# Out: {"claims":{"iat":1516239022,"mood":"Disdainful","sub":"1234567890"}}

Parses a claims object from a JWT string encoded with ES512. This method does not validate JWT claims.

Introduced in version v4.20.0.

signing_secret <string> The ES512 secret that was used for signing the token.

root.claims = this.signed.parse_jwt_es512("""-----BEGIN PUBLIC KEY-----
MIGbMBAGByqGSM49AgEGBSuBBAAjA4GGAAQAkHLdts9P56fFkyhpYQ31M/Stwt3w
vpaxhlfudxnXgTO1IP4RQRgryRxZ19EUzhvWDcG3GQIckoNMY5PelsnCGnIBT2Xh
9NQkjWF5K6xS4upFsbGSAwQ+GIyyk5IPJ2LHgOyMSCVh5gRZXV3CZLzXujx/umC9
UeYyTt05zRRWuD+p5bY=
-----END PUBLIC KEY-----""")
# In:  {"signed":"eyJhbGciOiJFUzUxMiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE1MTYyMzkwMjIsIm1vb2QiOiJEaXNkYWluZnVsIiwic3ViIjoiMTIzNDU2Nzg5MCJ9.ACrpLuU7TKpAnncDCpN9m85nkL55MJ45NFOBl6-nEXmNT1eIxWjiP4pwWVbFH9et_BgN14119jbL_KqEJInPYc9nAXC6dDLq0aBU-dalvNl4-O5YWpP43-Y-TBGAsWnbMTrchILJ4-AEiICe73Ck5yWPleKg9c3LtkEFWfGs7BoPRguZ"}
# Out: {"claims":{"iat":1516239022,"mood":"Disdainful","sub":"1234567890"}}

Parses a claims object from a JWT string encoded with HS256. This method does not validate JWT claims.

Introduced in version v4.12.0.

signing_secret <string> The HS256 secret that was used for signing the token.

root.claims = this.signed.parse_jwt_hs256("""dont-tell-anyone""")
# In:  {"signed":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE1MTYyMzkwMjIsIm1vb2QiOiJEaXNkYWluZnVsIiwic3ViIjoiMTIzNDU2Nzg5MCJ9.YwXOM8v3gHVWcQRRRQc_zDlhmLnM62fwhFYGpiA0J1A"}
# Out: {"claims":{"iat":1516239022,"mood":"Disdainful","sub":"1234567890"}}

Parses a claims object from a JWT string encoded with HS384. This method does not validate JWT claims.

Introduced in version v4.12.0.

signing_secret <string> The HS384 secret that was used for signing the token.

root.claims = this.signed.parse_jwt_hs384("""dont-tell-anyone""")
# In:  {"signed":"eyJhbGciOiJIUzM4NCIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE1MTYyMzkwMjIsIm1vb2QiOiJEaXNkYWluZnVsIiwic3ViIjoiMTIzNDU2Nzg5MCJ9.2Y8rf_ijwN4t8hOGGViON_GrirLkCQVbCOuax6EoZ3nluX0tCGezcJxbctlIfsQ2"}
# Out: {"claims":{"iat":1516239022,"mood":"Disdainful","sub":"1234567890"}}

Parses a claims object from a JWT string encoded with HS512. This method does not validate JWT claims.

Introduced in version v4.12.0.

signing_secret <string> The HS512 secret that was used for signing the token.

root.claims = this.signed.parse_jwt_hs512("""dont-tell-anyone""")
# In:  {"signed":"eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE1MTYyMzkwMjIsIm1vb2QiOiJEaXNkYWluZnVsIiwic3ViIjoiMTIzNDU2Nzg5MCJ9.utRb0urG6LGGyranZJVo5Dk0Fns1QNcSUYPN0TObQ-YzsGGB8jrxHwM5NAJccjJZzKectEUqmmKCaETZvuX4Fg"}
# Out: {"claims":{"iat":1516239022,"mood":"Disdainful","sub":"1234567890"}}

Parses a claims object from a JWT string encoded with RS256. This method does not validate JWT claims.

Introduced in version v4.20.0.

signing_secret <string> The RS256 secret that was used for signing the token.

root.claims = this.signed.parse_jwt_rs256("""-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAs/ibN8r68pLMR6gRzg4S
8v8l6Q7yi8qURjkEbcNeM1rkokC7xh0I4JVTwxYSVv/JIW8qJdyspl5NIfuAVi32
WfKvSAs+NIs+DMsNPYw3yuQals4AX8hith1YDvYpr8SD44jxhz/DR9lYKZFGhXGB
+7NqQ7vpTWp3BceLYocazWJgusZt7CgecIq57ycM5hjM93BvlrUJ8nQ1a46wfL/8
Cy4P0et70hzZrsjjN41KFhKY0iUwlyU41yEiDHvHDDsTMBxAZosWjSREGfJL6Mfp
XOInTHs/Gg6DZMkbxjQu6L06EdJ+Q/NwglJdAXM7Zo9rNELqRig6DdvG5JesdMsO
+QIDAQAB
-----END PUBLIC KEY-----""")
# In:  {"signed":"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE1MTYyMzkwMjIsIm1vb2QiOiJEaXNkYWluZnVsIiwic3ViIjoiMTIzNDU2Nzg5MCJ9.b0lH3jEupZZ4zoaly4Y_GCvu94HH6UKdKY96zfGNsIkPZpQLHIkZ7jMWlLlNOAd8qXlsBGP_i8H2qCKI4zlWJBGyPZgxXDzNRPVrTDfFpn4t4nBcA1WK2-ntXP3ehQxsaHcQU8Z_nsogId7Pme5iJRnoHWEnWtbwz5DLSXL3ZZNnRdrHM9MdI7QSDz9mojKDCaMpGN9sG7Xl-tGdBp1XzXuUOzG8S03mtZ1IgVR1uiBL2N6oohHIAunk8DIAmNWI-zgycTgzUGU7mvPkKH43qO8Ua1-13tCUBKKa8VxcotZ67Mxm1QAvBGoDnTKwWMwghLzs6d6WViXQg6eWlJcpBA"}
# Out: {"claims":{"iat":1516239022,"mood":"Disdainful","sub":"1234567890"}}

Parses a claims object from a JWT string encoded with RS384. This method does not validate JWT claims.

Introduced in version v4.20.0.

signing_secret <string> The RS384 secret that was used for signing the token.

root.claims = this.signed.parse_jwt_rs384("""-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAs/ibN8r68pLMR6gRzg4S
8v8l6Q7yi8qURjkEbcNeM1rkokC7xh0I4JVTwxYSVv/JIW8qJdyspl5NIfuAVi32
WfKvSAs+NIs+DMsNPYw3yuQals4AX8hith1YDvYpr8SD44jxhz/DR9lYKZFGhXGB
+7NqQ7vpTWp3BceLYocazWJgusZt7CgecIq57ycM5hjM93BvlrUJ8nQ1a46wfL/8
Cy4P0et70hzZrsjjN41KFhKY0iUwlyU41yEiDHvHDDsTMBxAZosWjSREGfJL6Mfp
XOInTHs/Gg6DZMkbxjQu6L06EdJ+Q/NwglJdAXM7Zo9rNELqRig6DdvG5JesdMsO
+QIDAQAB
-----END PUBLIC KEY-----""")
# In:  {"signed":"eyJhbGciOiJSUzM4NCIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE1MTYyMzkwMjIsIm1vb2QiOiJEaXNkYWluZnVsIiwic3ViIjoiMTIzNDU2Nzg5MCJ9.orcXYBcjVE5DU7mvq4KKWFfNdXR4nEY_xupzWoETRpYmQZIozlZnM_nHxEk2dySvpXlAzVm7kgOPK2RFtGlOVaNRIa3x-pMMr-bhZTno4L8Hl4sYxOks3bWtjK7wql4uqUbqThSJB12psAXw2-S-I_FMngOPGIn4jDT9b802ottJSvTpXcy0-eKTjrV2PSkRRu-EYJh0CJZW55MNhqlt6kCGhAXfbhNazN3ASX-dmpd_JixyBKphrngr_zRA-FCn_Xf3QQDA-5INopb4Yp5QiJ7UxVqQEKI80X_JvJqz9WE1qiAw8pq5-xTen1t7zTP-HT1NbbD3kltcNa3G8acmNg"}
# Out: {"claims":{"iat":1516239022,"mood":"Disdainful","sub":"1234567890"}}

Parses a claims object from a JWT string encoded with RS512. This method does not validate JWT claims.

Introduced in version v4.20.0.

signing_secret <string> The RS512 secret that was used for signing the token.

root.claims = this.signed.parse_jwt_rs512("""-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAs/ibN8r68pLMR6gRzg4S
8v8l6Q7yi8qURjkEbcNeM1rkokC7xh0I4JVTwxYSVv/JIW8qJdyspl5NIfuAVi32
WfKvSAs+NIs+DMsNPYw3yuQals4AX8hith1YDvYpr8SD44jxhz/DR9lYKZFGhXGB
+7NqQ7vpTWp3BceLYocazWJgusZt7CgecIq57ycM5hjM93BvlrUJ8nQ1a46wfL/8
Cy4P0et70hzZrsjjN41KFhKY0iUwlyU41yEiDHvHDDsTMBxAZosWjSREGfJL6Mfp
XOInTHs/Gg6DZMkbxjQu6L06EdJ+Q/NwglJdAXM7Zo9rNELqRig6DdvG5JesdMsO
+QIDAQAB
-----END PUBLIC KEY-----""")
# In:  {"signed":"eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE1MTYyMzkwMjIsIm1vb2QiOiJEaXNkYWluZnVsIiwic3ViIjoiMTIzNDU2Nzg5MCJ9.rsMp_X5HMrUqKnZJIxo27aAoscovRA6SSQYR9rq7pifIj0YHXxMyNyOBDGnvVALHKTi25VUGHpfNUW0VVMmae0A4t_ObNU6hVZHguWvetKZZq4FZpW1lgWHCMqgPGwT5_uOqwYCH6r8tJuZT3pqXeL0CY4putb1AN2w6CVp620nh3l8d3XWb4jaifycd_4CEVCqHuWDmohfug4VhmoVKlIXZkYoAQowgHlozATDssBSWdYtv107Wd2AzEoiXPu6e3pflsuXULlyqQnS4ELEKPYThFLafh1NqvZDPddqozcPZ-iODBW-xf3A4DYDdivnMYLrh73AZOGHexxu8ay6nDA"}
# Out: {"claims":{"iat":1516239022,"mood":"Disdainful","sub":"1234567890"}}

Hash and sign an object representing JSON Web Token (JWT) claims using ES256.

Introduced in version v4.20.0.

signing_secret <string> The secret to use for signing the token.

root.signed = this.claims.sign_jwt_es256("""-----BEGIN EC PRIVATE KEY-----
... signature data ...
-----END EC PRIVATE KEY-----""")
# In:  {"claims":{"sub":"user123"}}
# Out: {"signed":"eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE1MTYyMzkwMjIsIm1vb2QiOiJEaXNkYWluZnVsIiwic3ViIjoiMTIzNDU2Nzg5MCJ9.-8LrOdkEiv_44ADWW08lpbq41ZmHCel58NMORPq1q4Dyw0zFhqDVLrRoSvCvuyyvgXAFb9IHfR-9MlJ_2ShA9A"}

Hash and sign an object representing JSON Web Token (JWT) claims using ES384.

Introduced in version v4.20.0.

signing_secret <string> The secret to use for signing the token.

root.signed = this.claims.sign_jwt_es384("""-----BEGIN EC PRIVATE KEY-----
... signature data ...
-----END EC PRIVATE KEY-----""")
# In:  {"claims":{"sub":"user123"}}
# Out: {"signed":"eyJhbGciOiJFUzM4NCIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyMTIzIn0.8FmTKH08dl7dyxrNu0rmvhegiIBCy-O9cddGco2e9lpZtgv5mS5qHgPkgBC5eRw1d7SRJsHwHZeehzdqT5Ba7aZJIhz9ds0sn37YQ60L7jT0j2gxCzccrt4kECHnUnLw"}

Hash and sign an object representing JSON Web Token (JWT) claims using ES512.

Introduced in version v4.20.0.

signing_secret <string> The secret to use for signing the token.

root.signed = this.claims.sign_jwt_es512("""-----BEGIN EC PRIVATE KEY-----
... signature data ...
-----END EC PRIVATE KEY-----""")
# In:  {"claims":{"sub":"user123"}}
# Out: {"signed":"eyJhbGciOiJFUzUxMiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyMTIzIn0.AQbEWymoRZxDJEJtKSFFG2k2VbDCTYSuBwAZyMqexCspr3If8aERTVGif8HXG3S7TzMBCCzxkcKr3eIU441l3DlpAMNfQbkcOlBqMvNBn-CX481WyKf3K5rFHQ-6wRonz05aIsWAxCDvAozI_9J0OWllxdQ2MBAuTPbPJ38OqXsYkCQs"}

Hash and sign an object representing JSON Web Token (JWT) claims using HS256.

Introduced in version v4.12.0.

signing_secret <string> The secret to use for signing the token.

root.signed = this.claims.sign_jwt_hs256("""dont-tell-anyone""")
# In:  {"claims":{"sub":"user123"}}
# Out: {"signed":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyMTIzIn0.hUl-nngPMY_3h9vveWJUPsCcO5PeL6k9hWLnMYeFbFQ"}

Hash and sign an object representing JSON Web Token (JWT) claims using HS384.

Introduced in version v4.12.0.

signing_secret <string> The secret to use for signing the token.

root.signed = this.claims.sign_jwt_hs384("""dont-tell-anyone""")
# In:  {"claims":{"sub":"user123"}}
# Out: {"signed":"eyJhbGciOiJIUzM4NCIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyMTIzIn0.zGYLr83aToon1efUNq-hw7XgT20lPvZb8sYei8x6S6mpHwb433SJdXJXx0Oio8AZ"}

Hash and sign an object representing JSON Web Token (JWT) claims using HS512.

Introduced in version v4.12.0.

signing_secret <string> The secret to use for signing the token.

root.signed = this.claims.sign_jwt_hs512("""dont-tell-anyone""")
# In:  {"claims":{"sub":"user123"}}
# Out: {"signed":"eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyMTIzIn0.zBNR9o_6EDwXXKkpKLNJhG26j8Dc-mV-YahBwmEdCrmiWt5les8I9rgmNlWIowpq6Yxs4kLNAdFhqoRz3NXT3w"}

Hash and sign an object representing JSON Web Token (JWT) claims using RS256.

Introduced in version v4.18.0.

signing_secret <string> The secret to use for signing the token.

root.signed = this.claims.sign_jwt_rs256("""-----BEGIN RSA PRIVATE KEY-----
... signature data ...
-----END RSA PRIVATE KEY-----""")
# In:  {"claims":{"sub":"user123"}}
# Out: {"signed":"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE1MTYyMzkwMjIsIm1vb2QiOiJEaXNkYWluZnVsIiwic3ViIjoiMTIzNDU2Nzg5MCJ9.b0lH3jEupZZ4zoaly4Y_GCvu94HH6UKdKY96zfGNsIkPZpQLHIkZ7jMWlLlNOAd8qXlsBGP_i8H2qCKI4zlWJBGyPZgxXDzNRPVrTDfFpn4t4nBcA1WK2-ntXP3ehQxsaHcQU8Z_nsogId7Pme5iJRnoHWEnWtbwz5DLSXL3ZZNnRdrHM9MdI7QSDz9mojKDCaMpGN9sG7Xl-tGdBp1XzXuUOzG8S03mtZ1IgVR1uiBL2N6oohHIAunk8DIAmNWI-zgycTgzUGU7mvPkKH43qO8Ua1-13tCUBKKa8VxcotZ67Mxm1QAvBGoDnTKwWMwghLzs6d6WViXQg6eWlJcpBA"}

Hash and sign an object representing JSON Web Token (JWT) claims using RS384.

Introduced in version v4.18.0.

signing_secret <string> The secret to use for signing the token.

root.signed = this.claims.sign_jwt_rs384("""-----BEGIN RSA PRIVATE KEY-----
... signature data ...
-----END RSA PRIVATE KEY-----""")
# In:  {"claims":{"sub":"user123"}}
# Out: {"signed":"eyJhbGciOiJSUzM4NCIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE1MTYyMzkwMjIsIm1vb2QiOiJEaXNkYWluZnVsIiwic3ViIjoiMTIzNDU2Nzg5MCJ9.orcXYBcjVE5DU7mvq4KKWFfNdXR4nEY_xupzWoETRpYmQZIozlZnM_nHxEk2dySvpXlAzVm7kgOPK2RFtGlOVaNRIa3x-pMMr-bhZTno4L8Hl4sYxOks3bWtjK7wql4uqUbqThSJB12psAXw2-S-I_FMngOPGIn4jDT9b802ottJSvTpXcy0-eKTjrV2PSkRRu-EYJh0CJZW55MNhqlt6kCGhAXfbhNazN3ASX-dmpd_JixyBKphrngr_zRA-FCn_Xf3QQDA-5INopb4Yp5QiJ7UxVqQEKI80X_JvJqz9WE1qiAw8pq5-xTen1t7zTP-HT1NbbD3kltcNa3G8acmNg"}

Hash and sign an object representing JSON Web Token (JWT) claims using RS512.

Introduced in version v4.18.0.

signing_secret <string> The secret to use for signing the token.

root.signed = this.claims.sign_jwt_rs512("""-----BEGIN RSA PRIVATE KEY-----
... signature data ...
-----END RSA PRIVATE KEY-----""")
# In:  {"claims":{"sub":"user123"}}
# Out: {"signed":"eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE1MTYyMzkwMjIsIm1vb2QiOiJEaXNkYWluZnVsIiwic3ViIjoiMTIzNDU2Nzg5MCJ9.rsMp_X5HMrUqKnZJIxo27aAoscovRA6SSQYR9rq7pifIj0YHXxMyNyOBDGnvVALHKTi25VUGHpfNUW0VVMmae0A4t_ObNU6hVZHguWvetKZZq4FZpW1lgWHCMqgPGwT5_uOqwYCH6r8tJuZT3pqXeL0CY4putb1AN2w6CVp620nh3l8d3XWb4jaifycd_4CEVCqHuWDmohfug4VhmoVKlIXZkYoAQowgHlozATDssBSWdYtv107Wd2AzEoiXPu6e3pflsuXULlyqQnS4ELEKPYThFLafh1NqvZDPddqozcPZ-iODBW-xf3A4DYDdivnMYLrh73AZOGHexxu8ay6nDA"}

path <string> A path to an mmdb (maxmind) file.

path <string> A path to an mmdb (maxmind) file.

path <string> A path to an mmdb (maxmind) file.

path <string> A path to an mmdb (maxmind) file.

path <string> A path to an mmdb (maxmind) file.

path <string> A path to an mmdb (maxmind) file.

path <string> A path to an mmdb (maxmind) file.

path <string> A path to an mmdb (maxmind) file.

Attempts to format a timestamp value as a string according to a specified format, or RFC 3339 by default. Timestamp values can either be a numerical unix time in seconds (with up to nanosecond precision via decimals), or a string in RFC 3339 format.

format <string, default "2006-01-02T15:04:05.999999999Z07:00" > The output format to use. tz <(optional) string> An optional timezone to use, otherwise the timezone of the input string is used, or in the case of unix timestamps the local timezone is used.

Attempts to format a timestamp value as a string according to a specified strftime-compatible format. Timestamp values can either be a numerical unix time in seconds (with up to nanosecond precision via decimals), or a string in RFC 3339 format.

format <string> The output format to use. tz <(optional) string> An optional timezone to use, otherwise the timezone of the input string is used.

format <string> The format of the target string.

format <string> The format of the target string.

Simple online edits

For simple changes, such as fixing a typo, you can edit the content directly on GitHub.

Or, open an issue to let us know about something that you want us to change.