String Functions and Operators

str

String

str[i]

String indexing.

str[from:to]

String slicing.

str ++ str

String concatenation.

str like pattern

Case-sensitive simple string matching.

str ilike pattern

Case-insensitive simple string matching.

= != ?= ?!= < > <= >=

Comparison operators

to_str()

Return string representation of the input value.

len()

Return string’s length.

contains()

Test if a string contains a substring.

find()

Find index of a substring.

str_lower()

Return a lowercase copy of the input string.

str_upper()

Return an uppercase copy of the input string.

str_title()

Return a titlecase copy of the input string.

str_pad_start()

Return the input string padded at the start to the length n.

str_pad_end()

Return the input string padded at the end to the length n.

str_trim()

Return the input string with trim characters removed from both ends.

str_trim_start()

Return the input string with all trim characters removed from its start.

str_trim_end()

Return the input string with all trim characters removed from its end.

str_repeat()

Repeat the input string n times.

str_replace()

Replace all occurrences of old substring with the new one.

str_reverse()

Reverse the order of the characters in the string.

str_split()

Split a string into an array using a delimiter.

re_match()

Find the first regular expression match in a string.

re_match_all()

Find all regular expression matches in a string.

re_replace()

Replace matching substrings in a given string.

re_test()

Test if a regular expression has a match in a string.

type

str

Strings - 图1

Strings - 图2

Strings - 图3

str

A unicode string of text.

Any other type (except bytes) can be cast to and from a string:

  1. db>
  1. select <str>42;
  1. {'42'}
  1. db>
  1. select <bool>'true';
  1. {true}
  1. db>
  1. select "I ❤️ EdgeDB";
  1. {'I ❤️ EdgeDB'}

Note that when a str is cast into a json, the result is a JSON string value. Same applies for casting back from json - only a JSON string value can be cast into a str:

  1. db>
  1. select <json>'Hello, world';
  1. {'"Hello, world"'}

There are two kinds of string literals in EdgeQL: regular and raw. Raw string literals do not evaluate \, so \n in in a raw string is two characters \ and n.

The regular string literal syntax is 'a string' or a "a string". Two raw string syntaxes are illustrated below:

  1. db>
  1. select r'a raw \\\ string';
  1. {'a raw \\\ string'}
  1. db>
  1. select $$something$$;
  1. {'something'}
  1. db>
  2. ...
  1. select $marker$something $$
  2. nested \!$$$marker$;
  1. {'something $$
  2. nested \!$$'}

Regular strings use \ to indicate line continuation. When a line continuation symbol is encountered, the symbol itself as well as all the whitespace characters up to the next non-whitespace character are omitted from the string:

  1. db>
  2. ...
  1. select 'Hello, \
  2. world';
  1. {'"Hello, world"'}

operator

str[i]

Strings - 图4

Strings - 图5

Strings - 图6

str [ int64 ] -> str

String indexing.

Indexing starts at 0. Negative indexes are also valid and count from the end of the string.

  1. db>
  1. select 'some text'[1];
  1. {'o'}
  1. db>
  1. select 'some text'[-1];
  1. {'t'}

It is an error to attempt to extract a character at an index outside the bounds of the string:

  1. db>
  1. select 'some text'[10];
  1. InvalidValueError: string index 10 is out of bounds

operator

str[from:to]

Strings - 图7

Strings - 图8

Strings - 图9

str [ int64 : int64 ] -> str

String slicing.

Indexing starts at 0. Negative indexes are also valid and count from the end of the string.

  1. db>
  1. select 'some text'[1:3];
  1. {'om'}
  1. db>
  1. select 'some text'[-4:];
  1. {'text'}
  1. db>
  1. select 'some text'[:-5];
  1. {'some'}
  1. db>
  1. select 'some text'[5:-2];
  1. {'te'}

It is perfectly acceptable to use indexes outside the bounds of a string in a slice:

  1. db>
  1. select 'some text'[-4:100];
  1. {'text'}
  1. db>
  1. select 'some text'[-100:-5];
  1. {'some'}

operator

str ++ str

Strings - 图10

Strings - 图11

Strings - 图12

str ++ str -> str

String concatenation.

  1. db>
  1. select 'some' ++ ' text';
  1. {'some text'}

operator

str like pattern

Strings - 图13

Strings - 图14

Strings - 图15

str like str -> boolstr not like str -> bool

Case-sensitive simple string matching.

Returns true if the value V matches the pattern P and false otherwise. The operator not like is the negation of like.

The pattern matching rules are as follows:

pattern

interpretation

%

matches zero or more characters

matches exactly one character

\%

matches a literal “%”

\

matches a literal “_”

any other character

matches itself

In particular, this means that if there are no special symbols in the pattern, the operators like and not like work identical to \= and !=, respectively.

  1. db>
  1. select 'abc' like 'abc';
  1. {true}
  1. db>
  1. select 'abc' like 'a%';
  1. {true}
  1. db>
  1. select 'abc' like '_b_';
  1. {true}
  1. db>
  1. select 'abc' like 'c';
  1. {false}
  1. db>
  1. select 'a%%c' not like r'a\%c';
  1. {true}

operator

str ilike pattern

Strings - 图16

Strings - 图17

Strings - 图18

str ilike str -> boolstr not ilike str -> bool

Case-insensitive simple string matching.

The operators ilike and not ilike work the same way as like and not like, except that the pattern is matched in a case-insensitive manner.

  1. db>
  1. select 'Abc' ilike 'a%';
  1. {true}

function

str_lower()

Strings - 图19

Strings - 图20

Strings - 图21

std::str_lower(string: str) -> str

Return a lowercase copy of the input string.

  1. db>
  1. select str_lower('Some Fancy Title');
  1. {'some fancy title'}

function

str_upper()

Strings - 图22

Strings - 图23

Strings - 图24

std::str_upper(string: str) -> str

Return an uppercase copy of the input string.

  1. db>
  1. select str_upper('Some Fancy Title');
  1. {'SOME FANCY TITLE'}

function

str_title()

Strings - 图25

Strings - 图26

Strings - 图27

std::str_title(string: str) -> str

Return a titlecase copy of the input string.

Every word in the string will have the first letter capitalized and the rest converted to lowercase.

  1. db>
  1. select str_title('sOmE fAnCy TiTlE');
  1. {'Some Fancy Title'}

function

str_pad_start()

Strings - 图28

Strings - 图29

Strings - 图30

std::str_pad_start(string: str, n: int64, fill: str = ‘ ‘) -> str

Return the input string padded at the start to the length n.

If the string is longer than n, then it is truncated to the first n characters. Otherwise, the string is padded on the left up to the total length n using fill characters (space by default).

  1. db>
  1. select str_pad_start('short', 10);
  1. {' short'}
  1. db>
  1. select str_pad_start('much too long', 10);
  1. {'much too l'}
  1. db>
  1. select str_pad_start('short', 10, '.:');
  1. {'.:.:.short'}

function

str_pad_end()

Strings - 图31

Strings - 图32

Strings - 图33

std::str_pad_end(string: str, n: int64, fill: str = ‘ ‘) -> str

Return the input string padded at the end to the length n.

If the string is longer than n, then it is truncated to the first n characters. Otherwise, the string is padded on the right up to the total length n using fill characters (space by default).

  1. db>
  1. select str_pad_end('short', 10);
  1. {'short '}
  1. db>
  1. select str_pad_end('much too long', 10);
  1. {'much too l'}
  1. db>
  1. select str_pad_end('short', 10, '.:');
  1. {'short.:.:.'}

function

str_trim_start()

Strings - 图34

Strings - 图35

Strings - 图36

std::str_trim_start(string: str, trim: str = ‘ ‘) -> str

Return the input string with all trim characters removed from its start.

If the trim specifies more than one character they will be removed from the beginning of the string regardless of the order in which they appear.

  1. db>
  1. select str_trim_start(' data');
  1. {'data'}
  1. db>
  1. select str_trim_start('.....data', '.:');
  1. {'data'}
  1. db>
  1. select str_trim_start(':::::data', '.:');
  1. {'data'}
  1. db>
  1. select str_trim_start(':...:data', '.:');
  1. {'data'}
  1. db>
  1. select str_trim_start('.:.:.data', '.:');
  1. {'data'}

function

str_trim_end()

Strings - 图37

Strings - 图38

Strings - 图39

std::str_trim_end(string: str, trim: str = ‘ ‘) -> str

Return the input string with all trim characters removed from its end.

If the trim specifies more than one character they will be removed from the end of the string regardless of the order in which they appear.

  1. db>
  1. select str_trim_end('data ');
  1. {'data'}
  1. db>
  1. select str_trim_end('data.....', '.:');
  1. {'data'}
  1. db>
  1. select str_trim_end('data:::::', '.:');
  1. {'data'}
  1. db>
  1. select str_trim_end('data:...:', '.:');
  1. {'data'}
  1. db>
  1. select str_trim_end('data.:.:.', '.:');
  1. {'data'}

function

str_trim()

Strings - 图40

Strings - 图41

Strings - 图42

std::str_trim(string: str, trim: str = ‘ ‘) -> str

Return the input string with trim characters removed from both ends.

If the trim specifies more than one character they will be removed from both ends of the string regardless of the order in which they appear. This is the same as applying str_ltrim() and str_rtrim().

  1. db>
  1. select str_trim(' data ');
  1. {'data'}
  1. db>
  1. select str_trim('::data.....', '.:');
  1. {'data'}
  1. db>
  1. select str_trim('..data:::::', '.:');
  1. {'data'}
  1. db>
  1. select str_trim('.:data:...:', '.:');
  1. {'data'}
  1. db>
  1. select str_trim(':.:.data.:.', '.:');
  1. {'data'}

function

str_repeat()

Strings - 图43

Strings - 图44

Strings - 图45

std::str_repeat(string: str, n: int64) -> str

Repeat the input string n times.

If n is zero or negative an empty string is returned.

  1. db>
  1. select str_repeat('.', 3);
  1. {'...'}
  1. db>
  1. select str_repeat('foo', -1);
  1. {''}

function

str_replace()

Strings - 图46

Strings - 图47

Strings - 图48

std::str_replace(s: str, old: str, new: str) -> str

Replace all occurrences of old substring with the new one.

Given a string s find all non-overlapping occurrences of the substring old and replace them with the substring new.

  1. db>
  1. select str_replace('hello world', 'h', 'H');
  1. {'Hello world'}
  1. db>
  1. select str_replace('hello world', 'l', '[L]');
  1. {'he[L][L]o wor[L]d'}
  1. db>
  1. select str_replace('hello world', 'o', '😄');
  1. {'hell😄 w😄rld'}

function

str_reverse()

Strings - 图49

Strings - 图50

Strings - 图51

std::str_reverse(string: str) -> str

Reverse the order of the characters in the string.

  1. db>
  1. select str_reverse('Hello world');
  1. {'dlrow olleH'}
  1. db>
  1. select str_reverse('Hello 👋 world 😄');
  1. {'😄 dlrow 👋 olleH'}

function

str_split()

Strings - 图52

Strings - 图53

Strings - 图54

std::str_split(s: str, delimiter: str) -> array<str>

Split string into array elements using the supplied delimiter.

  1. db>
  1. select str_split('1, 2, 3', ', ');
  1. {['1', '2', '3']}
  1. db>
  1. select str_split('123', '');
  1. {['1', '2', '3']}

function

re_match()

Strings - 图55

Strings - 图56

Strings - 图57

std::re_match(pattern: str, string: str) -> array<str>

Find the first regular expression match in a string.

Given an input string and a regular expression pattern find the first match for the regular expression within the string. Return the match, each match represented by an array of matched groups.

  1. db>
  1. select re_match(r'\w{4}ql', 'I ❤️ edgeql');
  1. {['edgeql']}

function

re_match_all()

Strings - 图58

Strings - 图59

Strings - 图60

std::re_match_all(pattern: str, string: str) -> set of array<str>

Find all regular expression matches in a string.

Given an input string and a regular expression pattern repeatedly match the regular expression within the string. Return the set of all matches, each match represented by an array of matched groups.

  1. db>
  1. select re_match_all(r'a\w+', 'an abstract concept');
  1. {['an'], ['abstract']}

function

re_replace()

Strings - 图61

Strings - 图62

Strings - 图63

std::re_replace(pattern: str, sub: str, string: str, named only flags: str=’’) -> str

Replace matching substrings in a given string.

Given an input string and a regular expression pattern replace matching substrings with the replacement string sub. Optional flag arguments can be used to specify additional regular expression flags. Return the string resulting from substring replacement.

  1. db>
  2. ...
  1. select re_replace(r'l', r'L', 'Hello World',
  2. flags := 'g');
  1. {'HeLLo WorLd'}

function

re_test()

Strings - 图64

Strings - 图65

Strings - 图66

std::re_test(pattern: str, string: str) -> bool

Test if a regular expression has a match in a string.

Given an input string and a regular expression pattern test whether there is a match for the regular expression within the string. Return true if there is a match, false otherwise.

  1. db>
  1. select re_test(r'a', 'abc');
  1. {true}

function

to_str()

Strings - 图67

Strings - 图68

Strings - 图69

std::to_str(val: datetime, fmt: optional str={}) -> strstd::to_str(val: duration, fmt: optional str={}) -> strstd::to_str(val: int64, fmt: optional str={}) -> strstd::to_str(val: float64, fmt: optional str={}) -> strstd::to_str(val: bigint, fmt: optional str={}) -> strstd::to_str(val: decimal, fmt: optional str={}) -> strstd::to_str(val: json, fmt: optional str={}) -> strstd::to_str(val: cal::local_datetime, fmt: optional str={}) -> strstd::to_str(val: cal::local_date, fmt: optional str={}) -> strstd::to_str(val: cal::local_time, fmt: optional str={}) -> str

Return string representation of the input value.

This is a very versatile polymorphic function that is defined for many different input types. In general, there are corresponding converter functions from str back to the specific types, which share the meaning of the format argument fmt.

When converting datetime, cal::local_datetime, cal::local_date, cal::local_time, duration this function is the inverse of to_datetime(), cal::to_local_datetime(), cal::to_local_date(), cal::to_local_time(), to_duration(), correspondingly.

For valid date and time formatting patterns see here.

  1. db>
  2. ...
  1. select to_str(<datetime>'2018-05-07 15:01:22.306916-05',
  2. 'FMDDth of FMMonth, YYYY');
  1. {'7th of May, 2018'}
  1. db>
  1. select to_str(<cal::local_date>'2018-05-07', 'CCth "century"');
  1. {'21st century'}

When converting one of the numeric types, this function is the reverse of: to_bigint(), to_decimal(), to_int16(), to_int32(), to_int64(), to_float32(), to_float64().

For valid number formatting patterns see here.

See also to_json().

  1. db>
  1. select to_str(123, '999999');
  1. {' 123'}
  1. db>
  1. select to_str(123, '099999');
  1. {' 000123'}
  1. db>
  1. select to_str(123.45, 'S999.999');
  1. {'+123.450'}
  1. db>
  1. select to_str(123.45e-20, '9.99EEEE');
  1. {' 1.23e-18'}
  1. db>
  1. select to_str(-123.45n, 'S999.99');
  1. {'-123.45'}

When converting json, this function can take 'pretty' as the optional fmt argument to produce a pretty-formatted JSON string.

See also to_json().

  1. db>
  1. select to_str(<json>2);
  1. {'2'}
  1. db>
  1. select to_str(<json>['hello', 'world']);
  1. {'["hello", "world"]'}
  1. db>
  1. select to_str(<json>(a := 2, b := 'hello'), 'pretty');
  1. {'{
  2. "a": 2,
  3. "b": "hello"
  4. }'}

When converting arrays, a delimiter argument is required:

  1. db>
  1. select to_str(['one', 'two', 'three'], ', ');
  1. {'one, two, three'}

There’s a deprecated version of std::to_str which operates on arrays, however array_join() should be used instead.

Regular Expressions

EdgeDB supports Regular expressions (REs), as defined in POSIX 1003.2. They come in two forms: BRE (basic RE) and ERE (extended RE). In addition, EdgeDB supports certain common extensions to the POSIX standard commonly known as ARE (advanced RE). More details about BRE, ERE, and ARE support can be found in PostgreSQL documentation.

For convenience, here’s a table outlining the different options accepted as the flags argument to various regular expression functions, or as embedded options in the pattern itself, e.g. '(?i)fooBAR':

Option Flags

Option

Description

b

rest of RE is a BRE

c

case-sensitive matching (overrides operator type)

e

rest of RE is an ERE

i

case-insensitive matching (overrides operator type)

m

historical synonym for n

n

newline-sensitive matching

p

partial newline-sensitive matching

q

rest of RE is a literal (“quoted”) string, all ordinary characters

s

non-newline-sensitive matching (default)

t

tight syntax (default)

w

inverse partial newline-sensitive (“weird”) matching

x

expanded syntax ignoring white-space characters

Formatting

Some of the type converter functions take an extra argument specifying the formatting (either for converting to a str or parsing from one). The different formatting options are collected in this section.

Date and time formatting options

Pattern

Description

HH

hour of day (01-12)

HH12

hour of day (01-12)

HH24

hour of day (00-23)

MI

minute (00-59)

SS

second (00-59)

MS

millisecond (000-999)

US

microsecond (000000-999999)

SSSS

seconds past midnight (0-86399)

AM, am, PM or pm

meridiem indicator (without periods)

A.M., a.m., P.M. or p.m.

meridiem indicator (with periods)

Y,YYY

year (4 or more digits) with comma

YYYY

year (4 or more digits)

YYY

last 3 digits of year

YY

last 2 digits of year

Y

last digit of year

IYYY

ISO 8601 week-numbering year (4 or more digits)

IYY

last 3 digits of ISO 8601 week- numbering year

IY

last 2 digits of ISO 8601 week- numbering year

I

last digit of ISO 8601 week-numbering year

BC, bc, AD or ad

era indicator (without periods)

B.C., b.c., A.D. or a.d.

era indicator (with periods)

MONTH

full upper case month name (blank- padded to 9 chars)

Month

full capitalized month name (blank- padded to 9 chars)

month

full lower case month name (blank- padded to 9 chars)

MON

abbreviated upper case month name (3 chars in English, localized lengths vary)

Mon

abbreviated capitalized month name (3 chars in English, localized lengths vary)

mon

abbreviated lower case month name (3 chars in English, localized lengths vary)

MM

month number (01-12)

DAY

full upper case day name (blank-padded to 9 chars)

Day

full capitalized day name (blank- padded to 9 chars)

day

full lower case day name (blank-padded to 9 chars)

DY

abbreviated upper case day name (3 chars in English, localized lengths vary)

Dy

abbreviated capitalized day name (3 chars in English, localized lengths vary)

dy

abbreviated lower case day name (3 chars in English, localized lengths vary)

DDD

day of year (001-366)

IDDD

day of ISO 8601 week-numbering year (001-371; day 1 of the year is Monday of the first ISO week)

DD

day of month (01-31)

D

day of the week, Sunday (1) to Saturday (7)

ID

ISO 8601 day of the week, Monday (1) to Sunday (7)

W

week of month (1-5) (the first week starts on the first day of the month)

WW

week number of year (1-53) (the first week starts on the first day of the year)

IW

week number of ISO 8601 week-numbering year (01-53; the first Thursday of the year is in week 1)

CC

century (2 digits) (the twenty-first century starts on 2001-01-01)

J

Julian Day (integer days since November 24, 4714 BC at midnight UTC)

Q

quarter

RM

month in upper case Roman numerals (I-XII; I=January)

rm

month in lower case Roman numerals (i-xii; i=January)

TZ

upper case time-zone abbreviation (only supported in to_char)

tz

lower case time-zone abbreviation (only supported in to_char)

TZH

time-zone hours

TZM

time-zone minutes

OF

time-zone offset from UTC (only supported in to_char)

Some additional formatting modifiers:

Modifier

Description

Example

FM prefix

fill mode (suppress leading zeroes and padding blanks)

FMMonth

TH suffix

upper case ordinal number suffix

DDTH, e.g., 12TH

th suffix

lower case ordinal number suffix

DDth, e.g., 12th

FX prefix

fixed format global option (see usage notes)

FX Month DD Day

Normally when parsing a string input whitespace is ignored, unless the FX prefix modifier is used. For example:

  1. db>
  2. ...
  1. select cal::to_local_date(
  2. '2000 JUN', 'YYYY MON');
  1. {<cal::local_date>'2000-06-01'}
  1. db>
  2. ...
  1. select cal::to_local_date(
  2. '2000 JUN', 'FXYYYY MON');
  1. InternalServerError: invalid value " " for "MON"

Number formatting options

Pattern

Description

9

digit position (can be dropped if insignificant)

0

digit position (will not be dropped, even if insignificant)

.

(period) decimal point

,

(comma) group (thousands) separator

PR

negative value in angle brackets

S

sign anchored to number (uses locale)

L

currency symbol (uses locale)

D

decimal point (uses locale)

G

group separator (uses locale)

MI

minus sign in specified position (if number < 0)

PL

plus sign in specified position (if number > 0)

SG

plus/minus sign in specified position

RN

Roman numeral (input between 1 and 3999)

TH or th

ordinal number suffix

V

shift specified number of digits (see notes)

EEEE

exponent for scientific notation

Some additional formatting modifiers:

Modifier

Description

Example

FM prefix

fill mode (suppress leading zeroes and padding blanks)

FM99.99

TH suffix

upper case ordinal number suffix

999TH

th suffix

lower case ordinal number suffix

999th