String Functions

char_length()

Returns the number of characters in a string. character_length() and length() are synonyms.

GQL
RETURN char_length("Ultipa Graph")

Result: 12

byte_length()

Returns the number of bytes in a string. octet_length() is a synonym to byte_length().

GQL
RETURN byte_length("hello"), byte_length("你好")

Result:

lower()

Converts all the characters in a given string to lowercase.

GQL
RETURN lower("Ultipa Graph")

Result: "ultipa graph"

upper()

Converts all the characters in a given string to uppercase.

GQL
RETURN upper("Ultipa Graph")

Result: "ULTIPA GRAPH"

left()

Returns a substring of the given string containing the specified number of leftmost characters.

GQL
RETURN left("Ultipa Graph", 6)

Result: "Ultipa"

right()

Returns a substring of the given string containing the specified number of rightmost characters.

GQL
RETURN right("Ultipa Graph", 5)

Result: "Graph"

substring()

Returns a substring of a given length from the given string, beginning with a 0-based index start. substr() is a synonym to substring().

GQL
RETURN substring("crystal hawk river", 0, 7)

Result: "crystal"

trim()

Removes all the occurrences of the specified single character from either the leftmost, rightmost, or both ends of a given string.

GQL
RETURN trim("  Ultipa Graph   ") AS newString

Result: "Ultipa Graph"

GQL
RETURN trim(BOTH "a" FROM "aaGraph DBa") AS newString

Result: "Graph DB"

GQL
RETURN trim(LEADING "a" FROM "aaGraph DBa") AS newString

Result:

GQL
RETURN trim(TRAILING FROM "  Graph DB   ") AS newString

Result: " Graph DB"

ltrim()

Removes characters from the begining of a given string until encountering a character that is not contained in the specified set of characters.

GQL
RETURN ltrim("  Ultipa Graph   ") AS newString

Result: "Ultipa Graph "

GQL
RETURN ltrim("124ABC341", "123") AS newString

Result: "4ABC341"

rtrim()

Removes characters from the end of a given string until encountering a character that is not contained in the specified set of characters.

GQL
RETURN rtrim("  Ultipa Graph   ") AS newString

Result: " Ultipa Graph"

GQL
RETURN rtrim("123ABC4321", "123") AS newString

Result: "123ABC4"

btrim()

Removes characters from both ends of a given string until encountering a character that is not contained in the specified set of characters.

GQL
RETURN btrim("  Ultipa Graph   ") AS newString

Result: "Ultipa Graph"

GQL
RETURN btrim("123ABC341", "123") AS newString

Result: "ABC34"

replace()

Returns a string where all occurrences of a specified substring are replaced with another string.

GQL
RETURN replace("hello world", "world", "graph") AS result

Result: "hello graph"

split()

Returns a list of string resulting from the splitting of the given string around matches of the given delimiter.

GQL
RETURN split("apple,banana,grape", ",")

Result: ["apple","banana","grape"]

GQL
RETURN split("[email protected]", "@")[0] AS username

Result: "appleLEE"

contains()

Returns true if a string contains the specified substring.

GQL
RETURN contains("Graph Database", "Graph")

Result: true

starts_with()

Returns true if a string starts with the specified prefix.

GQL
RETURN starts_with("Graph Database", "Graph")

Result: true

ends_with()

Returns true if a string ends with the specified suffix.

GQL
RETURN ends_with("Graph Database", "Database")

Result: true

normalize()

Converts a string into a consistent format based on the normalization form specified, in accordance with Unicode Standard Annex #15.

This function is typically used to compare two strings by their Unicode codepoints. Two characters appear identical to human eyes may have different codepoints, such as the multiplication sign × (U+00D7) and the letter x (U+0078).

GQL
RETURN normalize('×') = normalize('x')

Result: false

hex()

Encodes a string or bytes value to a hexadecimal string.

GQL
RETURN hex("hello")

Result: "68656c6c6f"

unhex()

Decodes a hexadecimal string to bytes.

GQL
RETURN unhex("68656c6c6f")

Result:

JSON
{
  "0": 104,
  "1": 101,
  "2": 108,
  "3": 108,
  "4": 111
}

base64()

Encodes a string to a Base64 string.

GQL
RETURN base64("hello")

Result: "aGVsbG8="

unbase64()

Decodes a Base64 string to bytes.

GQL
RETURN unbase64("aGVsbG8=")

Result:

JSON
{
  "0": 104,
  "1": 101,
  "2": 108,
  "3": 108,
  "4": 111
}