apoc.text

Qualified Name Type

Qualified Name	Type
apoc.text.phoneticDelta `apoc.text.phoneticDelta(text1 STRING, text2 STRING)` - returns the US_ENGLISH soundex character difference between the two given `STRING` values.	Procedure
apoc.text.base64Decode `apoc.text.base64Decode(text STRING)` - decodes the given Base64 encoded `STRING`.	Function
apoc.text.base64Encode `apoc.text.base64Encode(text STRING)` - encodes the given `STRING` with Base64.	Function
apoc.text.base64UrlDecode `apoc.text.base64UrlDecode(url STRING)` - decodes the given Base64 encoded URL.	Function
apoc.text.base64UrlEncode `apoc.text.base64UrlEncode(url STRING)` - encodes the given URL with Base64.	Function
apoc.text.byteCount `apoc.text.byteCount(text STRING, charset STRING)` - returns the size of the given `STRING` in bytes.	Function
apoc.text.bytes `apoc.text.bytes(text STRING, charset STRING)` - returns the given `STRING` as bytes.	Function
apoc.text.camelCase `apoc.text.camelCase(text STRING)` - converts the given `STRING` to camel case.	Function
apoc.text.capitalize `apoc.text.capitalize(text STRING)` - capitalizes the first letter of the given `STRING`.	Function
apoc.text.capitalizeAll `apoc.text.capitalizeAll(text STRING)` - capitalizes the first letter of every word in the given `STRING`.	Function
apoc.text.charAt `apoc.text.charAt(text STRING, index INTEGER)` - returns the `INTEGER` value of the character at the given index.	Function
apoc.text.clean `apoc.text.clean(text STRING)` - strips the given `STRING` of everything except alpha numeric characters and converts it to lower case.	Function
apoc.text.code `apoc.text.code(codepoint INTEGER)` - converts the `INTEGER` value into a `STRING`.	Function
apoc.text.compareCleaned `apoc.text.compareCleaned(text1 STRING, text2 STRING)` - compares two given `STRING` values stripped of everything except alpha numeric characters converted to lower case.	Function
apoc.text.decapitalize `apoc.text.decapitalize(text STRING)` - turns the first letter of the given `STRING` from upper case to lower case.	Function
apoc.text.decapitalizeAll `apoc.text.decapitalizeAll(text STRING)` - turns the first letter of every word in the given `STRING` to lower case.	Function
apoc.text.distance `apoc.text.distance(text1 STRING, text2 STRING)` - compares the two given `STRING` values using the Levenshtein distance algorithm.	Function
apoc.text.doubleMetaphone `apoc.text.doubleMetaphone(value STRING)` - returns the double metaphone phonetic encoding of all words in the given `STRING` value.	Function
apoc.text.format `apoc.text.format(text STRING, params LIST<ANY>, language STRING)` - formats the given `STRING` with the given parameters.	Function
apoc.text.fuzzyMatch `apoc.text.fuzzyMatch(text1 STRING, text2 STRING)` - performs a fuzzy match search of the two given `STRING` values.	Function
apoc.text.hammingDistance `apoc.text.hammingDistance(text1 STRING, text2 STRING)` - compares the two given `STRING` values using the Hamming distance algorithm.	Function
apoc.text.hexCharAt `apoc.text.hexCharAt(text STRING, index INTEGER)` - returns the hexadecimal value of the given `STRING` at the given index.	Function
apoc.text.hexValue `apoc.text.hexValue(value INTEGER)` - returns the hexadecimal value of the given value.	Function
apoc.text.indexOf `apoc.text.indexOf(text STRING, lookup STRING, from INTEGER, to INTEGER)` - returns the first occurrence of the lookup `STRING` in the given `STRING`, or -1 if not found.	Function
apoc.text.indexesOf `apoc.text.indexesOf(text STRING, lookup STRING, from INTEGER, to INTEGER)` - returns all occurrences of the lookup `STRING` in the given `STRING`, or an empty list if not found.	Function
apoc.text.jaroWinklerDistance `apoc.text.jaroWinklerDistance(text1 STRING, text2 STRING)` - compares the two given `STRING` values using the Jaro-Winkler distance algorithm.	Function
apoc.text.join `apoc.text.join(texts LIST<STRING>, delimiter STRING)` - joins the given `STRING` values using the given delimiter.	Function
apoc.text.levenshteinDistance `apoc.text.levenshteinDistance(text1 STRING, text2 STRING)` - compares the given `STRING` values using the Levenshtein distance algorithm.	Function
apoc.text.levenshteinSimilarity `apoc.text.levenshteinSimilarity(text1 STRING, text2 STRING)` - returns the similarity (a value within 0 and 1) between the two given `STRING` values based on the Levenshtein distance algorithm.	Function
apoc.text.lpad `apoc.text.lpad(text STRING, count INTEGER, delimiter STRING)` - left pads the given `STRING` by the given width.	Function
apoc.text.phonetic `apoc.text.phonetic(text STRING)` - returns the US_ENGLISH phonetic soundex encoding of all words of the `STRING`.	Function
apoc.text.random `apoc.text.random(length INTEGER, valid STRING)` - generates a random `STRING` to the given length using a length parameter and an optional `STRING` of valid characters. Unsuitable for cryptographic use-cases.	Function
apoc.text.regexGroups `apoc.text.regexGroups(text STRING, regex STRING)` - returns all groups matching the given regular expression in the given text.	Function
apoc.text.regexGroupsByName `apoc.text.regexGroupsByName(text STRING, regex STRING)` - returns all groups with their group name matching the regular expression in the given text.	Function
apoc.text.regreplace `apoc.text.regreplace(text STRING, regex STRING, replacement STRING)` - finds and replaces all matches found by the given regular expression with the given replacement.	Function
apoc.text.repeat `apoc.text.repeat(item STRING, count INTEGER)` - returns the result of the given item multiplied by the given count.	Function
apoc.text.replace `apoc.text.replace(text STRING, regex STRING, replacement STRING)` - finds and replaces all matches found by the given regular expression with the given replacement.	Function
apoc.text.rpad `apoc.text.rpad(text STRING, count INTEGER, delimiter STRING)` - right pads the given `STRING` by the given width.	Function
apoc.text.slug `apoc.text.slug(text STRING, delimiter STRING)` - replaces the whitespace in the given `STRING` with the given delimiter.	Function
apoc.text.snakeCase `apoc.text.snakeCase(text STRING)` - converts the given `STRING` to snake case.	Function
apoc.text.sorensenDiceSimilarity `apoc.text.sorensenDiceSimilarityWithLanguage(text1 STRING, text2 STRING, languageTag STRING)` - compares the two given `STRING` values using the Sørensen–Dice coefficient formula, with the provided IETF language tag.	Function
apoc.text.split `apoc.text.split(text STRING, regex STRING, limit INTEGER)` - splits the given `STRING` using a given regular expression as a separator.	Function
apoc.text.swapCase `apoc.text.swapCase(text STRING)` - swaps the cases in the given `STRING`.	Function
apoc.text.toCypher `apoc.text.toCypher(value ANY, config MAP<STRING, ANY>)` - converts the given value to a Cypher property `STRING`.	Function
apoc.text.toUpperCase `apoc.text.toUpperCase(text STRING)` - converts the given `STRING` to upper case.	Function
apoc.text.upperCamelCase `apoc.text.upperCamelCase(text STRING)` - converts the given `STRING` to upper camel case.	Function
apoc.text.urldecode `apoc.text.urldecode(text STRING)` - decodes the given URL encoded `STRING`.	Function
apoc.text.urlencode `apoc.text.urlencode(text STRING)` - encodes the given URL `STRING`.	Function

apoc.text.phoneticDelta

apoc.text.phoneticDelta(text1 STRING, text2 STRING) - returns the US_ENGLISH soundex character difference between the two given STRING values.

Procedure

apoc.text.base64Decode

apoc.text.base64Decode(text STRING) - decodes the given Base64 encoded STRING.

Function

apoc.text.base64Encode

apoc.text.base64Encode(text STRING) - encodes the given STRING with Base64.

Function

apoc.text.base64UrlDecode

apoc.text.base64UrlDecode(url STRING) - decodes the given Base64 encoded URL.

Function

apoc.text.base64UrlEncode

apoc.text.base64UrlEncode(url STRING) - encodes the given URL with Base64.

Function

apoc.text.byteCount

apoc.text.byteCount(text STRING, charset STRING) - returns the size of the given STRING in bytes.

Function

apoc.text.bytes

apoc.text.bytes(text STRING, charset STRING) - returns the given STRING as bytes.

Function

apoc.text.camelCase

apoc.text.camelCase(text STRING) - converts the given STRING to camel case.

Function

apoc.text.capitalize

apoc.text.capitalize(text STRING) - capitalizes the first letter of the given STRING.

Function

apoc.text.capitalizeAll

apoc.text.capitalizeAll(text STRING) - capitalizes the first letter of every word in the given STRING.

Function

apoc.text.charAt

apoc.text.charAt(text STRING, index INTEGER) - returns the INTEGER value of the character at the given index.

Function

apoc.text.clean

apoc.text.clean(text STRING) - strips the given STRING of everything except alpha numeric characters and converts it to lower case.

Function

apoc.text.code

apoc.text.code(codepoint INTEGER) - converts the INTEGER value into a STRING.

Function

apoc.text.compareCleaned

apoc.text.compareCleaned(text1 STRING, text2 STRING) - compares two given STRING values stripped of everything except alpha numeric characters converted to lower case.

Function

apoc.text.decapitalize

apoc.text.decapitalize(text STRING) - turns the first letter of the given STRING from upper case to lower case.

Function

apoc.text.decapitalizeAll

apoc.text.decapitalizeAll(text STRING) - turns the first letter of every word in the given STRING to lower case.

Function

apoc.text.distance

apoc.text.distance(text1 STRING, text2 STRING) - compares the two given STRING values using the Levenshtein distance algorithm.

Function

apoc.text.doubleMetaphone

apoc.text.doubleMetaphone(value STRING) - returns the double metaphone phonetic encoding of all words in the given STRING value.

Function

apoc.text.format

apoc.text.format(text STRING, params LIST<ANY>, language STRING) - formats the given STRING with the given parameters.

Function

apoc.text.fuzzyMatch

apoc.text.fuzzyMatch(text1 STRING, text2 STRING) - performs a fuzzy match search of the two given STRING values.

Function

apoc.text.hammingDistance

apoc.text.hammingDistance(text1 STRING, text2 STRING) - compares the two given STRING values using the Hamming distance algorithm.

Function

apoc.text.hexCharAt

apoc.text.hexCharAt(text STRING, index INTEGER) - returns the hexadecimal value of the given STRING at the given index.

Function

apoc.text.hexValue

apoc.text.hexValue(value INTEGER) - returns the hexadecimal value of the given value.

Function

apoc.text.indexOf

apoc.text.indexOf(text STRING, lookup STRING, from INTEGER, to INTEGER) - returns the first occurrence of the lookup STRING in the given STRING, or -1 if not found.

Function

apoc.text.indexesOf

apoc.text.indexesOf(text STRING, lookup STRING, from INTEGER, to INTEGER) - returns all occurrences of the lookup STRING in the given STRING, or an empty list if not found.

Function

apoc.text.jaroWinklerDistance

apoc.text.jaroWinklerDistance(text1 STRING, text2 STRING) - compares the two given STRING values using the Jaro-Winkler distance algorithm.

Function

apoc.text.join

apoc.text.join(texts LIST<STRING>, delimiter STRING) - joins the given STRING values using the given delimiter.

Function

apoc.text.levenshteinDistance

apoc.text.levenshteinDistance(text1 STRING, text2 STRING) - compares the given STRING values using the Levenshtein distance algorithm.

Function

apoc.text.levenshteinSimilarity

apoc.text.levenshteinSimilarity(text1 STRING, text2 STRING) - returns the similarity (a value within 0 and 1) between the two given STRING values based on the Levenshtein distance algorithm.

Function

apoc.text.lpad

apoc.text.lpad(text STRING, count INTEGER, delimiter STRING) - left pads the given STRING by the given width.

Function

apoc.text.phonetic

apoc.text.phonetic(text STRING) - returns the US_ENGLISH phonetic soundex encoding of all words of the STRING.

Function

apoc.text.random

apoc.text.random(length INTEGER, valid STRING) - generates a random STRING to the given length using a length parameter and an optional STRING of valid characters. Unsuitable for cryptographic use-cases.

Function

apoc.text.regexGroups

apoc.text.regexGroups(text STRING, regex STRING) - returns all groups matching the given regular expression in the given text.

Function

apoc.text.regexGroupsByName

apoc.text.regexGroupsByName(text STRING, regex STRING) - returns all groups with their group name matching the regular expression in the given text.

Function

apoc.text.regreplace

apoc.text.regreplace(text STRING, regex STRING, replacement STRING) - finds and replaces all matches found by the given regular expression with the given replacement.

Function

apoc.text.repeat

apoc.text.repeat(item STRING, count INTEGER) - returns the result of the given item multiplied by the given count.

Function

apoc.text.replace

apoc.text.replace(text STRING, regex STRING, replacement STRING) - finds and replaces all matches found by the given regular expression with the given replacement.

Function

apoc.text.rpad

apoc.text.rpad(text STRING, count INTEGER, delimiter STRING) - right pads the given STRING by the given width.

Function

apoc.text.slug

apoc.text.slug(text STRING, delimiter STRING) - replaces the whitespace in the given STRING with the given delimiter.

Function

apoc.text.snakeCase

apoc.text.snakeCase(text STRING) - converts the given STRING to snake case.

Function

apoc.text.sorensenDiceSimilarity

apoc.text.sorensenDiceSimilarityWithLanguage(text1 STRING, text2 STRING, languageTag STRING) - compares the two given STRING values using the Sørensen–Dice coefficient formula, with the provided IETF language tag.

Function

apoc.text.split

apoc.text.split(text STRING, regex STRING, limit INTEGER) - splits the given STRING using a given regular expression as a separator.

Function

apoc.text.swapCase

apoc.text.swapCase(text STRING) - swaps the cases in the given STRING.

Function

apoc.text.toCypher

apoc.text.toCypher(value ANY, config MAP<STRING, ANY>) - converts the given value to a Cypher property STRING.

Function

apoc.text.toUpperCase

apoc.text.toUpperCase(text STRING) - converts the given STRING to upper case.