String indexing. | |
String slicing. | |
String concatenation. | |
Case-sensitive simple string matching. | |
Case-insensitive simple string matching. | |
Comparison operators. | |
Return string representation of the input value. | |
Return string’s length. | |
Test if a string contains a substring. | |
Find index of a substring. | |
Return a lowercase copy of the input string. | |
Return an uppercase copy of the input string. | |
Return a titlecase copy of the input string. | |
Return the input string padded at the start to the length n. | |
Return the input string padded at the end to the length n. | |
Return the input string with trim characters removed from both ends. | |
Return the input string with all trim characters removed from its start. | |
Return the input string with all trim characters removed from its end. | |
Repeat the input string n times. | |
Split a string into an array using a delimiter. | |
Find the first regular expression match in a string. | |
Find all regular expression matches in a string. | |
Replace matching substrings in a given string. | |
Test if a regular expression has a match in a string. |
String indexing.
db>
SELECT 'some text'[1];
{'o'}
db>
SELECT 'some text'[1:3];
{'om'}
db>
SELECT 'some text'[-4:];
{'text'}
String slicing.
db>
SELECT 'some text'[1:3];
{'om'}
db>
SELECT 'some text'[-4:];
{'text'}
String concatenation.
db>
SELECT 'some' ++ ' text';
{'some text'}
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 EQ
and NEQ
,
respectively.
db>
SELECT 'abc' LIKE 'abc';
{true}
db>
SELECT 'abc' LIKE 'a%';
{true}
db>
SELECT 'abc' LIKE '_b_';
{true}
db>
SELECT 'abc' LIKE 'c';
{false}
db>
SELECT 'a%%c' NOT LIKE r'a\%c';
{true}
Return a lowercase copy of the input string.
db>
SELECT str_lower('Some Fancy Title');
{'some fancy title'}
Return an uppercase copy of the input string.
db>
SELECT str_upper('Some Fancy Title');
{'SOME FANCY TITLE'}
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.
db>
SELECT str_title('sOmE fAnCy TiTlE');
{'Some Fancy Title'}
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).
db>
SELECT str_pad_start('short', 10);
{' short'}
db>
SELECT str_pad_start('much too long', 10);
{'much too l'}
db>
SELECT str_pad_start('short', 10, '.:');
{'.:.:.short'}
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).
db>
SELECT str_pad_end('short', 10);
{'short '}
db>
SELECT str_pad_end('much too long', 10);
{'much too l'}
db>
SELECT str_pad_end('short', 10, '.:');
{'short.:.:.'}
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.
db>
SELECT str_trim_start(' data');
{'data'}
db>
SELECT str_trim_start('.....data', '.:');
{'data'}
db>
SELECT str_trim_start(':::::data', '.:');
{'data'}
db>
SELECT str_trim_start(':...:data', '.:');
{'data'}
db>
SELECT str_trim_start('.:.:.data', '.:');
{'data'}
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.
db>
SELECT str_trim_end('data ');
{'data'}
db>
SELECT str_trim_end('data.....', '.:');
{'data'}
db>
SELECT str_trim_end('data:::::', '.:');
{'data'}
db>
SELECT str_trim_end('data:...:', '.:');
{'data'}
db>
SELECT str_trim_end('data.:.:.', '.:');
{'data'}
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()
.
db>
SELECT str_trim(' data ');
{'data'}
db>
SELECT str_trim('::data.....', '.:');
{'data'}
db>
SELECT str_trim('..data:::::', '.:');
{'data'}
db>
SELECT str_trim('.:data:...:', '.:');
{'data'}
db>
SELECT str_trim(':.:.data.:.', '.:');
{'data'}
Repeat the input string n times.
If n is zero or negative an empty string is returned.
db>
SELECT str_repeat('.', 3);
{'...'}
db>
SELECT str_repeat('foo', -1);
{''}
Split string into array elements using the supplied delimiter.
db>
SELECT str_split('1, 2, 3', ', ');
{['1', '2', '3']}
db>
SELECT str_split('123', '');
{['1', '2', '3']}
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<str>
of matched groups.
db>
SELECT re_match(r'\w{4}ql', 'I ❤️ edgeql');
{['edgeql']}
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<str>
of matched groups.
db>
SELECT re_match_all(r'a\w+', 'an abstract concept');
{['an'], ['abstract']}
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.
db> ...
SELECT re_replace(r'l', r'L', 'Hello World',
flags := 'g');
{'HeLLo WorLd'}
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.
db>
SELECT re_test(r'a', 'abc');
{true}
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.
db> ...
SELECT to_str(<datetime>'2018-05-07 15:01:22.306916-05',
'FMDDth of FMMonth, YYYY');
{'7th of May, 2018'}
db>
SELECT to_str(<cal::local_date>'2018-05-07', 'CCth "century"');
{'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()
.
db>
SELECT to_str(123, '999999');
{' 123'}
db>
SELECT to_str(123, '099999');
{' 000123'}
db>
SELECT to_str(123.45, 'S999.999');
{'+123.450'}
db>
SELECT to_str(123.45e-20, '9.99EEEE');
{' 1.23e-18'}
db>
SELECT to_str(-123.45n, 'S999.99');
{'-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()
.
db>
SELECT to_str(<json>2);
{'2'}
db>
SELECT to_str(<json>['hello', 'world']);
{'["hello", "world"]'}
db>
SELECT to_str(<json>(a := 2, b := 'hello'), 'pretty');
{'{ "a": 2, "b": "hello" }'}
When converting arrays
, a delimiter argument
is required:
db>
SELECT to_str(['one', 'two', 'three'], ', ');
{'one, two, three'}
There’s a deprecated version of std::to_str
which operates
on arrays, however array_join()
should be used instead.
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 flag
argument to various regular expression
functions:
Option |
Description |
---|---|
|
rest of RE is a BRE |
|
case-sensitive matching (overrides operator type) |
|
rest of RE is an ERE |
|
case-insensitive matching (overrides operator type) |
|
historical synonym for n |
|
newline-sensitive matching |
|
partial newline-sensitive matching |
|
rest of RE is a literal (“quoted”) string, all ordinary characters |
|
non-newline-sensitive matching (default) |
|
tight syntax (default) |
|
inverse partial newline-sensitive (“weird”) matching |
|
expanded syntax ignoring white-space characters |
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.
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:
db> ...
SELECT cal::to_local_date(
'2000 JUN', 'YYYY MON');
{<cal::local_date>'2000-06-01'}
db> ...
SELECT cal::to_local_date(
'2000 JUN', 'FXYYYY MON');
InternalServerError: invalid value " " for "MON"
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 |