Skip to main content
Skip to main content

Functions for Working with Strings

Functions for searching in strings and for replacing in strings are described separately.

empty

Checks whether the input string is empty. A string is considered non-empty if it contains at least one byte, even if this byte is a space or the null byte.

The function is also available for arrays and UUIDs.

Syntax

Arguments

Returned value

  • Returns 1 for an empty string or 0 for a non-empty string. UInt8.

Example

Result:

notEmpty

Checks whether the input string is non-empty. A string is considered non-empty if it contains at least one byte, even if this byte is a space or the null byte.

The function is also available for arrays and UUIDs.

Syntax

Arguments

Returned value

  • Returns 1 for a non-empty string or 0 for an empty string string. UInt8.

Example

Result:

length

Returns the length of a string in bytes rather than in characters or Unicode code points. The function also works for arrays.

Alias: OCTET_LENGTH

Syntax

Parameters

Returned value

  • Length of the string or array s in bytes. UInt64.

Example

Query:

Result:

Query:

Result:

lengthUTF8

Returns the length of a string in Unicode code points rather than in bytes or characters. It assumes that the string contains valid UTF-8 encoded text. If this assumption is violated, no exception is thrown and the result is undefined.

Aliases:

  • CHAR_LENGTH
  • CHARACTER_LENGTH

Syntax

Parameters

  • s — String containing valid UTF-8 encoded text. String.

Returned value

  • Length of the string s in Unicode code points. UInt64.

Example

Query:

Result:

left

Returns a substring of string s with a specified offset starting from the left.

Syntax

Parameters

  • s — The string to calculate a substring from. String or FixedString.
  • offset — The number of bytes of the offset. (U)Int*.

Returned value

  • For positive offset: A substring of s with offset many bytes, starting from the left of the string.
  • For negative offset: A substring of s with length(s) - |offset| bytes, starting from the left of the string.
  • An empty string if length is 0.

Example

Query:

Result:

Query:

Result:

leftUTF8

Returns a substring of a UTF-8 encoded string s with a specified offset starting from the left.

Syntax

Parameters

  • s — The UTF-8 encoded string to calculate a substring from. String or FixedString.
  • offset — The number of bytes of the offset. (U)Int*.

Returned value

  • For positive offset: A substring of s with offset many bytes, starting from the left of the string.
  • For negative offset: A substring of s with length(s) - |offset| bytes, starting from the left of the string.
  • An empty string if length is 0.

Example

Query:

Result:

Query:

Result:

leftPad

Pads a string from the left with spaces or with a specified string (multiple times, if needed) until the resulting string reaches the specified length.

Syntax

Alias: LPAD

Arguments

  • string — Input string that should be padded. String.
  • length — The length of the resulting string. UInt or Int. If the value is smaller than the input string length, then the input string is shortened to length characters.
  • pad_string — The string to pad the input string with. String. Optional. If not specified, then the input string is padded with spaces.

Returned value

  • A left-padded string of the given length. String.

Example

Result:

leftPadUTF8

Pads the string from the left with spaces or a specified string (multiple times, if needed) until the resulting string reaches the given length. Unlike leftPad which measures the string length in bytes, the string length is measured in code points.

Syntax

Arguments

  • string — Input string that should be padded. String.
  • length — The length of the resulting string. UInt or Int. If the value is smaller than the input string length, then the input string is shortened to length characters.
  • pad_string — The string to pad the input string with. String. Optional. If not specified, then the input string is padded with spaces.

Returned value

  • A left-padded string of the given length. String.

Example

Result:

Returns a substring of string s with a specified offset starting from the right.

Syntax

Parameters

  • s — The string to calculate a substring from. String or FixedString.
  • offset — The number of bytes of the offset. (U)Int*.

Returned value

  • For positive offset: A substring of s with offset many bytes, starting from the right of the string.
  • For negative offset: A substring of s with length(s) - |offset| bytes, starting from the right of the string.
  • An empty string if length is 0.

Example

Query:

Result:

Query:

Result:

rightUTF8

Returns a substring of UTF-8 encoded string s with a specified offset starting from the right.

Syntax

Parameters

  • s — The UTF-8 encoded string to calculate a substring from. String or FixedString.
  • offset — The number of bytes of the offset. (U)Int*.

Returned value

  • For positive offset: A substring of s with offset many bytes, starting from the right of the string.
  • For negative offset: A substring of s with length(s) - |offset| bytes, starting from the right of the string.
  • An empty string if length is 0.

Example

Query:

Result:

Query:

Result:

rightPad

Pads a string from the right with spaces or with a specified string (multiple times, if needed) until the resulting string reaches the specified length.

Syntax

Alias: RPAD

Arguments

  • string — Input string that should be padded. String.
  • length — The length of the resulting string. UInt or Int. If the value is smaller than the input string length, then the input string is shortened to length characters.
  • pad_string — The string to pad the input string with. String. Optional. If not specified, then the input string is padded with spaces.

Returned value

  • A left-padded string of the given length. String.

Example

Result:

rightPadUTF8

Pads the string from the right with spaces or a specified string (multiple times, if needed) until the resulting string reaches the given length. Unlike rightPad which measures the string length in bytes, the string length is measured in code points.

Syntax

Arguments

  • string — Input string that should be padded. String.
  • length — The length of the resulting string. UInt or Int. If the value is smaller than the input string length, then the input string is shortened to length characters.
  • pad_string — The string to pad the input string with. String. Optional. If not specified, then the input string is padded with spaces.

Returned value

  • A right-padded string of the given length. String.

Example

Result:

lower

Converts the ASCII Latin symbols in a string to lowercase.

Syntax*

Alias: lcase

Parameters

  • input: A string type String.

Returned value

Example

Query:

upper

Converts the ASCII Latin symbols in a string to uppercase.

Syntax

Alias: ucase

Parameters

  • input — A string type String.

Returned value

Examples

Query:

lowerUTF8

Converts a string to lowercase, assuming that the string contains valid UTF-8 encoded text. If this assumption is violated, no exception is thrown and the result is undefined.

Note

Does not detect the language, e.g. for Turkish the result might not be exactly correct (i/İ vs. i/I). If the length of the UTF-8 byte sequence is different for upper and lower case of a code point (such as and ß), the result may be incorrect for this code point.

Syntax

Parameters

  • input — A string type String.

Returned value

Example

Query:

Result:

upperUTF8

Converts a string to uppercase, assuming that the string contains valid UTF-8 encoded text. If this assumption is violated, no exception is thrown and the result is undefined.

Note

Does not detect the language, e.g. for Turkish the result might not be exactly correct (i/İ vs. i/I). If the length of the UTF-8 byte sequence is different for upper and lower case of a code point (such as and ß), the result may be incorrect for this code point.

Syntax

Parameters

  • input — A string type String.

Returned value

Example

Query:

Result:

isValidUTF8

Returns 1, if the set of bytes constitutes valid UTF-8-encoded text, otherwise 0.

Syntax

Parameters

  • input — A string type String.

Returned value

  • Returns 1, if the set of bytes constitutes valid UTF-8-encoded text, otherwise 0.

Query:

Result:

toValidUTF8

Replaces invalid UTF-8 characters by the (U+FFFD) character. All running in a row invalid characters are collapsed into the one replacement character.

Syntax

Arguments

  • input_string — Any set of bytes represented as the String data type object.

Returned value

  • A valid UTF-8 string.

Example

repeat

Concatenates a string as many times with itself as specified.

Syntax

Alias: REPEAT

Arguments

  • s — The string to repeat. String.
  • n — The number of times to repeat the string. UInt* or Int*.

Returned value

A string containing string s repeated n times. If n <= 0, the function returns the empty string. String.

Example

Result:

space

Concatenates a space ( ) as many times with itself as specified.

Syntax

Alias: SPACE.

Arguments

Returned value

The string containing string repeated n times. If n <= 0, the function returns the empty string. String.

Example

Query:

Result:

reverse

Reverses the sequence of bytes in a string.

reverseUTF8

Reverses a sequence of Unicode code points in a string. Assumes that the string contains valid UTF-8 encoded text. If this assumption is violated, no exception is thrown and the result is undefined.

concat

Concatenates the given arguments.

Syntax

Arguments

Values of arbitrary type.

Arguments which are not of types String or FixedString are converted to strings using their default serialization. As this decreases performance, it is not recommended to use non-String/FixedString arguments.

Returned values

The String created by concatenating the arguments.

If any of arguments is NULL, the function returns NULL.

Example

Query:

Result:

Query:

Result:

Note
|| operator

Use the || operator for string concatenation as a concise alternative to concat(). For example, 'Hello, ' || 'World!' is equivalent to concat('Hello, ', 'World!').

concatAssumeInjective

Like concat but assumes that concat(s1, s2, ...) → sn is injective. Can be used for optimization of GROUP BY.

A function is called injective if it returns for different arguments different results. In other words: different arguments never produce identical result.

Syntax

Arguments

Values of type String or FixedString.

Returned values

The String created by concatenating the arguments.

If any of argument values is NULL, the function returns NULL.

Example

Input table:

Result:

concatWithSeparator

Concatenates the given strings with a given separator.

Syntax

Alias: concat_ws

Arguments

  • sep — separator. Const String or FixedString.
  • exprN — expression to be concatenated. Arguments which are not of types String or FixedString are converted to strings using their default serialization. As this decreases performance, it is not recommended to use non-String/FixedString arguments.

Returned values

The String created by concatenating the arguments.

If any of the argument values is NULL, the function returns NULL.

Example

Result:

concatWithSeparatorAssumeInjective

Like concatWithSeparator but assumes that concatWithSeparator(sep, expr1, expr2, expr3...) → result is injective. Can be used for optimization of GROUP BY.

A function is called injective if it returns for different arguments different results. In other words: different arguments never produce identical result.

substring

Returns the substring of a string s which starts at the specified byte index offset. Byte counting starts from 1. If offset is 0, an empty string is returned. If offset is negative, the substring starts pos characters from the end of the string, rather than from the beginning. An optional argument length specifies the maximum number of bytes the returned substring may have.

Syntax

Aliases:

  • substr
  • mid
  • byteSlice

Arguments

  • s — The string to calculate a substring from. String, FixedString or Enum
  • offset — The starting position of the substring in s . (U)Int*.
  • length — The maximum length of the substring. (U)Int*. Optional.

Returned value

A substring of s with length many bytes, starting at index offset. String.

Example

Result:

substringUTF8

Returns the substring of a string s which starts at the specified byte index offset for Unicode code points. Byte counting starts from 1. If offset is 0, an empty string is returned. If offset is negative, the substring starts pos characters from the end of the string, rather than from the beginning. An optional argument length specifies the maximum number of bytes the returned substring may have.

Assumes that the string contains valid UTF-8 encoded text. If this assumption is violated, no exception is thrown and the result is undefined.

Syntax

Arguments

  • s — The string to calculate a substring from. String, FixedString or Enum
  • offset — The starting position of the substring in s . (U)Int*.
  • length — The maximum length of the substring. (U)Int*. Optional.

Returned value

A substring of s with length many bytes, starting at index offset.

Implementation details

Assumes that the string contains valid UTF-8 encoded text. If this assumption is violated, no exception is thrown and the result is undefined.

Example

substringIndex

Returns the substring of s before count occurrences of the delimiter delim, as in Spark or MySQL.

Syntax

Alias: SUBSTRING_INDEX

Arguments

  • s — The string to extract substring from. String.
  • delim — The character to split. String.
  • count — The number of occurrences of the delimiter to count before extracting the substring. If count is positive, everything to the left of the final delimiter (counting from the left) is returned. If count is negative, everything to the right of the final delimiter (counting from the right) is returned. UInt or Int

Example

Result:

substringIndexUTF8

Returns the substring of s before count occurrences of the delimiter delim, specifically for Unicode code points.

Assumes that the string contains valid UTF-8 encoded text. If this assumption is violated, no exception is thrown and the result is undefined.

Syntax

Arguments

  • s — The string to extract substring from. String.
  • delim — The character to split. String.
  • count — The number of occurrences of the delimiter to count before extracting the substring. If count is positive, everything to the left of the final delimiter (counting from the left) is returned. If count is negative, everything to the right of the final delimiter (counting from the right) is returned. UInt or Int

Returned value

A substring String of s before count occurrences of delim.

Implementation details

Assumes that the string contains valid UTF-8 encoded text. If this assumption is violated, no exception is thrown and the result is undefined.

Example

appendTrailingCharIfAbsent

Appends character c to string s if s is non-empty and does not end with character c.

Syntax

convertCharset

Returns string s converted from the encoding from to encoding to.

Syntax

base58Encode

Encodes a string using Base58 in the "Bitcoin" alphabet.

Syntax

Arguments

  • plaintextString column or constant.

Returned value

Example

Result:

base58Decode

Accepts a string and decodes it using Base58 encoding scheme using "Bitcoin" alphabet.

Syntax

Arguments

  • encodedString or FixedString. If the string is not a valid Base58-encoded value, an exception is thrown.

Returned value

  • A string containing the decoded value of the argument. String.

Example

Result:

tryBase58Decode

Like base58Decode but returns an empty string in case of error.

Syntax

Parameters

  • encoded: String or FixedString. If the string is not a valid Base58-encoded value, returns an empty string in case of error.

Returned value

  • A string containing the decoded value of the argument.

Examples

Query:

base64Encode

Encodes a String or FixedString as base64, according to RFC 4648.

Alias: TO_BASE64.

Syntax

Arguments

  • plaintextString column or constant.

Returned value

  • A string containing the encoded value of the argument.

Example

Result:

base64URLEncode

Encodes an URL (String or FixedString) as base64 with URL-specific modifications, according to RFC 4648.

Syntax

Arguments

  • urlString column or constant.

Returned value

  • A string containing the encoded value of the argument.

Example

Result:

base64Decode

Accepts a String and decodes it from base64, according to RFC 4648. Throws an exception in case of an error.

Alias: FROM_BASE64.

Syntax

Arguments

  • encodedString column or constant. If the string is not a valid Base64-encoded value, an exception is thrown.

Returned value

  • A string containing the decoded value of the argument.

Example

Result:

base64URLDecode

Accepts a base64-encoded URL and decodes it from base64 with URL-specific modifications, according to RFC 4648. Throws an exception in case of an error.

Syntax

Arguments

  • encodedURLString column or constant. If the string is not a valid Base64-encoded value with URL-specific modifications, an exception is thrown.

Returned value

  • A string containing the decoded value of the argument.

Example

Result:

tryBase64Decode

Like base64Decode but returns an empty string in case of error.

Syntax

Arguments

  • encodedString column or constant. If the string is not a valid Base64-encoded value, returns an empty string.

Returned value

  • A string containing the decoded value of the argument.

Examples

Query:

tryBase64URLDecode

Like base64URLDecode but returns an empty string in case of error.

Syntax

Parameters

  • encodedURLString column or constant. If the string is not a valid Base64-encoded value with URL-specific modifications, returns an empty string.

Returned value

  • A string containing the decoded value of the argument.

Examples

Query:

endsWith

Returns whether string str ends with suffix.

Syntax

endsWithUTF8

Returns whether string str ends with suffix, the difference between endsWithUTF8 and endsWith is that endsWithUTF8 match str and suffix by UTF-8 characters.

Syntax

Example

Result:

startsWith

Returns whether string str starts with prefix.

Syntax

Example

startsWithUTF8

Available in version 23.8 and later

Returns whether string str starts with prefix, the difference between startsWithUTF8 and startsWith is that startsWithUTF8 match str and suffix by UTF-8 characters.

Example

Result:

trim

Removes the specified characters from the start or end of a string. If not specified otherwise, the function removes whitespace (ASCII-character 32).

Syntax

Arguments

  • trim_character — Specified characters for trim. String.
  • input_string — String for trim. String.

Returned value

A string without leading and/or trailing specified characters. String.

Example

Result:

trimLeft

Removes the consecutive occurrences of whitespace (ASCII-character 32) from the start of a string.

Syntax

Alias: ltrim(input_string).

Arguments

  • input_string — string to trim. String.

Returned value

A string without leading common whitespaces. String.

Example

Result:

trimRight

Removes the consecutive occurrences of whitespace (ASCII-character 32) from the end of a string.

Syntax

Alias: rtrim(input_string).

Arguments

  • input_string — string to trim. String.

Returned value

A string without trailing common whitespaces. String.

Example

Result:

trimBoth

Removes the consecutive occurrences of whitespace (ASCII-character 32) from both ends of a string.

Syntax

Alias: trim(input_string).

Arguments

  • input_string — string to trim. String.

Returned value

A string without leading and trailing common whitespaces. String.

Example

Result:

CRC32

Returns the CRC32 checksum of a string using CRC-32-IEEE 802.3 polynomial and initial value 0xffffffff (zlib implementation).

The result type is UInt32.

CRC32IEEE

Returns the CRC32 checksum of a string, using CRC-32-IEEE 802.3 polynomial.

The result type is UInt32.

CRC64

Returns the CRC64 checksum of a string, using CRC-64-ECMA polynomial.

The result type is UInt64.

normalizeQuery

Replaces literals, sequences of literals and complex aliases (containing whitespace, more than two digits or at least 36 bytes long such as UUIDs) with placeholder ?.

Syntax

Arguments

  • x — Sequence of characters. String.

Returned value

  • Sequence of characters with placeholders. String.

Example

Query:

Result:

normalizeQueryKeepNames

Replaces literals, sequences of literals with placeholder ? but does not replace complex aliases (containing whitespace, more than two digits or at least 36 bytes long such as UUIDs). This helps better analyze complex query logs.

Syntax

Arguments

  • x — Sequence of characters. String.

Returned value

  • Sequence of characters with placeholders. String.

Example

Query:

Result:

normalizedQueryHash

Returns identical 64bit hash values without the values of literals for similar queries. Can be helpful to analyze query logs.

Syntax

Arguments

  • x — Sequence of characters. String.

Returned value

Example

Query:

Result:

normalizedQueryHashKeepNames

Like normalizedQueryHash it returns identical 64bit hash values without the values of literals for similar queries but it does not replace complex aliases (containing whitespace, more than two digits or at least 36 bytes long such as UUIDs) with a placeholder before hashing. Can be helpful to analyze query logs.

Syntax

Arguments

  • x — Sequence of characters. String.

Returned value

Example

Result:

normalizeUTF8NFC

Converts a string to NFC normalized form, assuming the string is valid UTF8-encoded text.

Syntax

Arguments

  • words — UTF8-encoded input string. String.

Returned value

  • String transformed to NFC normalization form. String.

Example

Result:

normalizeUTF8NFD

Converts a string to NFD normalized form, assuming the string is valid UTF8-encoded text.

Syntax

Arguments

  • words — UTF8-encoded input string. String.

Returned value

  • String transformed to NFD normalization form. String.

Example

Result:

normalizeUTF8NFKC

Converts a string to NFKC normalized form, assuming the string is valid UTF8-encoded text.

Syntax

Arguments

  • words — UTF8-encoded input string. String.

Returned value

  • String transformed to NFKC normalization form. String.

Example

Result:

normalizeUTF8NFKD

Converts a string to NFKD normalized form, assuming the string is valid UTF8-encoded text.

Syntax

Arguments

  • words — UTF8-encoded input string. String.

Returned value

  • String transformed to NFKD normalization form. String.

Example

Result:

encodeXMLComponent

Escapes characters with special meaning in XML such that they can afterwards be place into a XML text node or attribute.

The following characters are replaced: <, &, >, ", '. Also see the list of XML and HTML character entity references.

Syntax

Arguments

  • x — An input string. String.

Returned value

Example

Result:

decodeXMLComponent

Un-escapes substrings with special meaning in XML. These substrings are: &quot; &amp; &apos; &gt; &lt;

This function also replaces numeric character references with Unicode characters. Both decimal (like &#10003;) and hexadecimal (&#x2713;) forms are supported.

Syntax

Arguments

  • x — An input string. String.

Returned value

  • The un-escaped string. String.

Example

Result:

decodeHTMLComponent

Un-escapes substrings with special meaning in HTML. For example: &hbar; &gt; &diamondsuit; &heartsuit; &lt; etc.

This function also replaces numeric character references with Unicode characters. Both decimal (like &#10003;) and hexadecimal (&#x2713;) forms are supported.

Syntax

Arguments

  • x — An input string. String.

Returned value

  • The un-escaped string. String.

Example

Result:

extractTextFromHTML

This function extracts plain text from HTML or XHTML.

It does not conform 100% to the HTML, XML or XHTML specification but the implementation is reasonably accurate and fast. The rules are the following:

  1. Comments are skipped. Example: <!-- test -->. Comment must end with -->. Nested comments are disallowed. Note: constructions like <!--> and <!---> are not valid comments in HTML but they are skipped by other rules.
  2. CDATA is pasted verbatim. Note: CDATA is XML/XHTML-specific and processed on a "best-effort" basis.
  3. script and style elements are removed with all their content. Note: it is assumed that closing tag cannot appear inside content. For example, in JS string literal has to be escaped like "<\/script>". Note: comments and CDATA are possible inside script or style - then closing tags are not searched inside CDATA. Example: <script><![CDATA[</script>]]></script>. But they are still searched inside comments. Sometimes it becomes complicated: <script>var x = "<!--"; </script> var y = "-->"; alert(x + y);</script> Note: script and style can be the names of XML namespaces - then they are not treated like usual script or style elements. Example: <script:a>Hello</script:a>. Note: whitespaces are possible after closing tag name: </script > but not before: < / script>.
  4. Other tags or tag-like elements are skipped without inner content. Example: <a>.</a> Note: it is expected that this HTML is illegal: <a test=">"></a> Note: it also skips something like tags: <>, <!>, etc. Note: tag without end is skipped to the end of input: <hello
  5. HTML and XML entities are not decoded. They must be processed by separate function.
  6. Whitespaces in the text are collapsed or inserted by specific rules.
    • Whitespaces at the beginning and at the end are removed.
    • Consecutive whitespaces are collapsed.
    • But if the text is separated by other elements and there is no whitespace, it is inserted.
    • It may cause unnatural examples: Hello<b>world</b>, Hello<!-- -->world - there is no whitespace in HTML, but the function inserts it. Also consider: Hello<p>world</p>, Hello<br>world. This behavior is reasonable for data analysis, e.g. to convert HTML to a bag of words.
  7. Also note that correct handling of whitespaces requires the support of <pre></pre> and CSS display and white-space properties.

Syntax

Arguments

Returned value

Example

The first example contains several tags and a comment and also shows whitespace processing. The second example shows CDATA and script tag processing. In the third example text is extracted from the full HTML response received by the url function.

Result:

ascii

Returns the ASCII code point (as Int32) of the first character of string s.

If s is empty, the result is 0. If the first character is not an ASCII character or not part of the Latin-1 supplement range of UTF-16, the result is undefined.

Syntax

soundex

Returns the Soundex code of a string.

Syntax

Arguments

Returned value

  • The Soundex code of the input value. String

Example

Result:

punycodeEncode

Returns the Punycode representation of a string. The string must be UTF8-encoded, otherwise the behavior is undefined.

Syntax

Arguments

Returned value

  • A Punycode representation of the input value. String

Example

Result:

punycodeDecode

Returns the UTF8-encoded plaintext of a Punycode-encoded string. If no valid Punycode-encoded string is given, an exception is thrown.

Syntax

Arguments

  • val — Punycode-encoded string. String

Returned value

  • The plaintext of the input value. String

Example

Result:

tryPunycodeDecode

Like punycodeDecode but returns an empty string if no valid Punycode-encoded string is given.

idnaEncode

Returns the ASCII representation (ToASCII algorithm) of a domain name according to the Internationalized Domain Names in Applications (IDNA) mechanism. The input string must be UTF-encoded and translatable to an ASCII string, otherwise an exception is thrown. Note: No percent decoding or trimming of tabs, spaces or control characters is performed.

Syntax

Arguments

Returned value

  • A ASCII representation according to the IDNA mechanism of the input value. String

Example

Result:

tryIdnaEncode

Like idnaEncode but returns an empty string in case of an error instead of throwing an exception.

idnaDecode

Returns the Unicode (UTF-8) representation (ToUnicode algorithm) of a domain name according to the Internationalized Domain Names in Applications (IDNA) mechanism. In case of an error (e.g. because the input is invalid), the input string is returned. Note that repeated application of idnaEncode() and idnaDecode() does not necessarily return the original string due to case normalization.

Syntax

Arguments

Returned value

  • A Unicode (UTF-8) representation according to the IDNA mechanism of the input value. String

Example

Result:

byteHammingDistance

Calculates the hamming distance between two byte strings.

Syntax

Examples

Result:

Alias: mismatches

stringJaccardIndex

Calculates the Jaccard similarity index between two byte strings.

Syntax

Examples

Result:

stringJaccardIndexUTF8

Like stringJaccardIndex but for UTF8-encoded strings.

editDistance

Calculates the edit distance between two byte strings.

Syntax

Examples

Result:

Alias: levenshteinDistance

editDistanceUTF8

Calculates the edit distance between two UTF8 strings.

Syntax

Examples

Result:

Alias: levenshteinDistanceUTF8

damerauLevenshteinDistance

Calculates the Damerau-Levenshtein distance between two byte strings.

Syntax

Examples

Result:

jaroSimilarity

Calculates the Jaro similarity between two byte strings.

Syntax

Examples

Result:

jaroWinklerSimilarity

Calculates the Jaro-Winkler similarity between two byte strings.

Syntax

Examples

Result:

initcap

Convert the first letter of each word to upper case and the rest to lower case. Words are sequences of alphanumeric characters separated by non-alphanumeric characters.

Note

Because initCap converts only the first letter of each word to upper case you may observe unexpected behaviour for words containing apostrophes or capital letters. For example:

will return

This is a known behaviour, with no plans currently to fix it.

Syntax

Arguments

  • val — Input value. String.

Returned value

  • val with the first letter of each word converted to upper case. String.

Example

Query:

Result:

initcapUTF8

Like initcap, initcapUTF8 converts the first letter of each word to upper case and the rest to lower case. Assumes that the string contains valid UTF-8 encoded text. If this assumption is violated, no exception is thrown and the result is undefined.

Note

This function does not detect the language, e.g. for Turkish the result might not be exactly correct (i/İ vs. i/I). If the length of the UTF-8 byte sequence is different for upper and lower case of a code point, the result may be incorrect for this code point.

Syntax

Arguments

  • val — Input value. String.

Returned value

  • val with the first letter of each word converted to upper case. String.

Example

Query:

Result:

firstLine

Returns the first line from a multi-line string.

Syntax

Arguments

Returned value

  • The first line of the input value or the whole value if there is no line separators. String

Example

Result: