9.7.3.1. Regular Expression Details

Regular expressions (REs),as defined in POSIX 1003.2,come in two forms: extended REs or EREs (roughly those of egrep),and basic REs or BREs (roughly those of ed). PostgreSQL supports both forms,and also implements some extensions that are not in the POSIX standard,but have become widely used anyway due to their availability in programming languages such as Perl and Tcl. REs using these non-POSIX extensions are called advanced REs or AREs in this documentation. AREs are almost an exact superset of EREs,but BREs have several notational incompatibilities (as well as being much more limited). We first describe the ARE and ERE forms,noting features that apply only to AREs,and then describe how BREs differ.

A regular expression is defined as one or more branches,separated by |. It matches anything that matches one of the branches.

A branch is zero or more quantified atoms or constraints,concatenated. It matches a match for the first,followed by a match for the second,etc; an empty branch matches the empty string.

A quantified atom is an atom possibly followed by a single quantifier. Without a quantifier,it matches a match for the atom. With a quantifier,it can match some number of matches of the atom. An atom can be any of the possibilities shown in Table 9-12. The possible quantifiers and their meanings are shown in Table 9-13.

A constraint matches an empty string,but matches only when specific conditions are met. A constraint can be used where an atom could be used,except it may not be followed by a quantifier. The simple constraints are shown in Table 9-14; some more constraints are described later.

An RE may not end with /.

The forms using {...} are known as bounds. The numbers m and n within a bound are unsigned decimal integers with permissible values from 0 to 255 inclusive.

Non-greedy quantifiers (available in AREs only) match the same possibilities as their corresponding normal (greedy) counterparts,but prefer the smallest number rather than the largest number of matches. See Section 9.7.3.5 for more detail.

Lookahead constraints may not contain back references (see Section 9.7.3.3),and all parentheses within them are considered non-capturing.

9.7.3.2. Bracket Expressions

A bracket expression is a list of characters enclosed in []. It normally matches any single character from the list (but see below). If the list begins with ^,it matches any single character not from the rest of the list. If two characters in the list are separated by -,this is shorthand for the full range of characters between those two (inclusive) in the collating sequence,e.g. [0-9] in ASCII matches any decimal digit. It is illegal for two ranges to share an endpoint,e.g. a-c-e. Ranges are very collating-sequence-dependent,so portable programs should avoid relying on them.

To include a literal ] in the list,make it the first character (following a possible ^). To include a literal -,make it the first or last character,or the second endpoint of a range. To use a literal - as the first endpoint of a range,enclose it in [. and .] to make it a collating element (see below). With the exception of these characters,some combinations using [ (see next paragraphs),and escapes (AREs only),all other special characters lose their special significance within a bracket expression. In particular,/ is not special when following ERE or BRE rules,though it is special (as introducing an escape) in AREs.

Within a bracket expression,a collating element (a character,a multiple-character sequence that collates as if it were a single character,or a collating-sequence name for either) enclosed in [. and .] stands for the sequence of characters of that collating element. The sequence is a single element of the bracket expression's list. A bracket expression containing a multiple-character collating element can thus match more than one character,e.g. if the collating sequence includes a ch collating element,then the RE [[.ch.]]*c matches the first five characters of chchcc.

Within a bracket expression,a collating element enclosed in [= and =] is an equivalence class,standing for the sequences of characters of all collating elements equivalent to that one,including itself. (If there are no other equivalent collating elements,the treatment is as if the enclosing delimiters were [. and .].) For example,if o and ^ are the members of an equivalence class,then [[=o=]],[[=^=]],and [o^] are all synonymous. An equivalence class may not be an endpoint of a range.

Within a bracket expression,the name of a character class enclosed in [: and :] stands for the list of all characters belonging to that class. Standard character class names are: alnum,alpha,blank,cntrl,digit,graph,lower,print,punct,space,upper,xdigit. These stand for the character classes defined in ctype. A locale may provide others. A character class may not be used as an endpoint of a range.

There are two special cases of bracket expressions: the bracket expressions [[:<:]] and [[:>:]] are constraints,matching empty strings at the beginning and end of a word respectively. A word is defined as a sequence of word characters that is neither preceded nor followed by word characters. A word character is an alnum character (as defined by ctype) or an underscore. This is an extension,compatible with but not specified by POSIX 1003.2,and should be used with caution in software intended to be portable to other systems. The constraint escapes described below are usually preferable (they are no more standard,but are certainly easier to type).

9.7.3.3. Regular Expression Escapes

Escapes are special sequences beginning with / followed by an alphanumeric character. Escapes come in several varieties: character entry,class shorthands,constraint escapes,and back references. A / followed by an alphanumeric character but not constituting a valid escape is illegal in AREs. In EREs,there are no escapes: outside a bracket expression,a / followed by an alphanumeric character merely stands for that character as an ordinary character,and inside a bracket expression,/ is an ordinary character. (The latter is the one actual incompatibility between EREs and AREs.)

Character-entry escapes exist to make it easier to specify non-printing and otherwise inconvenient characters in REs. They are shown in Table 9-15.

Class-shorthand escapes provide shorthands for certain commonly-used character classes. They are shown in Table 9-16.

A constraint escape is a constraint,matching the empty string if specific conditions are met,written as an escape. They are shown in Table 9-17.

A back reference (/n) matches the same string matched by the prevIoUs parenthesized subexpression specified by the number n (see Table 9-18). For example,([bc])/1 matches bb or cc but not bc or cb. The subexpression must entirely precede the back reference in the RE. Subexpressions are numbered in the order of their leading parentheses. Non-capturing parentheses do not define subexpressions.

Hexadecimal digits are 0-9,a-f,and A-F. Octal digits are 0-7.

The character-entry escapes are always taken as ordinary characters. For example,/135 is ] in ASCII,but /135 does not terminate a bracket expression.

Within bracket expressions,/d,/s,and /w lose their outer brackets,and /D,/S,and /W are illegal. (So,for example,[a-c/d] is equivalent to [a-c[:digit:]]. Also,[a-c/D],which is equivalent to [a-c^[:digit:]],is illegal.)

A word is defined as in the specification of [[:<:]] and [[:>:]] above. Constraint escapes are illegal within bracket expressions.

9.7.3.4. Regular Expression Metasyntax

In addition to the main Syntax described above,there are some special forms and miscellaneous syntactic facilities available.

Normally the flavor of RE being used is determined by regex_flavor. However,this can be overridden by a director prefix. If an RE begins with ***:,the rest of the RE is taken as an ARE regardless of regex_flavor. If an RE begins with ***=,the rest of the RE is taken to be a literal string,with all characters considered ordinary characters.

An ARE may begin with embedded options: a sequence (?xyz) (where xyz is one or more alphabetic characters) specifies options affecting the rest of the RE. These options override any prevIoUsly determined options (including both the RE flavor and case sensitivity). The available option letters are shown in Table 9-19.

Embedded options take effect at the ) terminating the sequence. They may appear only at the start of an ARE (after the ***: director if any).

In addition to the usual (tight) RE Syntax,in which all characters are significant,there is an expanded Syntax,available by specifying the embedded x option. In the expanded Syntax,white-space characters in the RE are ignored,as are all characters between a # and the following newline (or the end of the RE). This permits paragraphing and commenting a complex RE. There are three exceptions to that basic rule:

• a white-space character or # preceded by / is retained

• white space or # within a bracket expression is retained

• white space and comments cannot appear within multicharacter symbols,such as (?:

For this purpose,white-space characters are blank,tab,newline,and any character that belongs to the space character class.

Finally,in an ARE,outside bracket expressions,the sequence (?#ttt) (where ttt is any text not containing a )) is a comment,completely ignored. Again,this is not allowed between the characters of multicharacter symbols,like (?:. Such comments are more a historical artifact than a useful facility,and their use is deprecated; use the expanded Syntax instead.

None of these MetaSyntax extensions is available if an initial ***= director has specified that the user's input be treated as a literal string rather than as an RE.

9.7.3.5. Regular Expression Matching Rules

In the event that an RE could match more than one substring of a given string,the RE matches the one starting earliest in the string. If the RE could match more than one substring starting at that point,either the longest possible match or the shortest possible match will be taken,depending on whether the RE is greedy or non-greedy.

Whether an RE is greedy or not is determined by the following rules:

• Most atoms,and all constraints,have no greediness attribute (because they cannot match variable amounts of text anyway).

• Adding parentheses around an RE does not change its greediness.

• A quantified atom with a fixed-repetition quantifier ({m} or {m}?) has the same greediness (possibly none) as the atom itself.

• A quantified atom with other normal quantifiers (including {m,n} with m equal to n) is greedy (prefers longest match).

• A quantified atom with a non-greedy quantifier (including {m,n}? with m equal to n) is non-greedy (prefers shortest match).

• A branch — that is,an RE that has no top-level | operator — has the same greediness as the first quantified atom in it that has a greediness attribute.

• An RE consisting of two or more branches connected by the | operator is always greedy.

The above rules associate greediness attributes not only with individual quantified atoms,but with branches and entire REs that contain quantified atoms. What that means is that the matching is done in such a way that the branch,or whole RE,matches the longest or shortest possible substring as a whole. Once the length of the entire match is determined,the part of it that matches any particular subexpression is determined on the basis of the greediness attribute of that subexpression,with subexpressions starting earlier in the RE taking priority over ones starting later.

An example of what this means:

SELECT SUBSTRING('XY1234Z','Y*([0-9]{1,3})');
Result: 123
SELECT SUBSTRING('XY1234Z','Y*?([0-9]{1,3})');
Result: 1

In the first case,the RE as a whole is greedy because Y* is greedy. It can match beginning at the Y,and it matches the longest possible string starting there,i.e.,Y123. The output is the parenthesized part of that,or 123. In the second case,the RE as a whole is non-greedy because Y*? is non-greedy. It can match beginning at the Y,and it matches the shortest possible string starting there,Y1. The subexpression [0-9]{1,3} is greedy but it cannot change the decision as to the overall match length; so it is forced to match just 1.

In short,when an RE contains both greedy and non-greedy subexpressions,the total match length is either as long as possible or as short as possible,according to the attribute assigned to the whole RE. The attributes assigned to the subexpressions only affect how much of that match they are allowed to "eat" relative to each other.

The quantifiers {1,1} and {1,1}? can be used to force greediness or non-greediness,respectively,on a subexpression or a whole RE.

Match lengths are measured in characters,not collating elements. An empty string is considered longer than no match at all. For example: bb* matches the three middle characters of abbbc; (week|wee)(night|knights) matches all ten characters of weeknights; when (.*).* is matched against abc the parenthesized subexpression matches all three characters; and when (a*)* is matched against bc both the whole RE and the parenthesized subexpression match an empty string.

If case-independent matching is specified,the effect is much as if all case distinctions had vanished from the alphabet. When an alphabetic that exists in multiple cases appears as an ordinary character outside a bracket expression,it is effectively transformed into a bracket expression containing both cases,e.g. x becomes [xX]. When it appears inside a bracket expression,all case counterparts of it are added to the bracket expression,e.g. [x] becomes [xX] and [^x] becomes [^xX].

If newline-sensitive matching is specified,. and bracket expressions using ^ will never match the newline character (so that matches will never cross newlines unless the RE explicitly arranges it) and ^and $ will match the empty string after and before a newline respectively,in addition to matching at beginning and end of string respectively. But the ARE escapes /A and /Z continue to match beginning or end of string only.

If partial newline-sensitive matching is specified,this affects . and bracket expressions as with newline-sensitive matching,but not ^ and $.

If inverse partial newline-sensitive matching is specified,this affects ^ and $ as with newline-sensitive matching,but not . and bracket expressions. This isn't very useful but is provided for symmetry.

9.7.3.6. Limits and Compatibility

No particular limit is imposed on the length of REs in this implementation. However,programs intended to be highly portable should not employ REs longer than 256 bytes,as a POSIX-compliant implementation can refuse to accept such REs.

The only feature of AREs that is actually incompatible with POSIX EREs is that / does not lose its special significance inside bracket expressions. All other ARE features use Syntax which is illegal or has undefined or unspecified effects in POSIX EREs; the *** Syntax of directors likewise is outside the POSIX Syntax for both BREs and EREs.

Many of the ARE extensions are borrowed from Perl,but some have been changed to clean them up,and a few Perl extensions are not present. Incompatibilities of note include /b,/B,the lack of special treatment for a trailing newline,the addition of complemented bracket expressions to the things affected by newline-sensitive matching,the restrictions on parentheses and back references in lookahead constraints,and the longest/shortest-match (rather than first-match) matching semantics.

Two significant incompatibilities exist between AREs and the ERE Syntax recognized by pre-7.4 releases of Postgresql:

• In AREs,/ followed by an alphanumeric character is either an escape or an error,while in prevIoUs releases,it was just another way of writing the alphanumeric. This should not be much of a problem because there was no reason to write such a sequence in earlier releases.

• In AREs,/ remains a special character within [],so a literal / within a bracket expression must be written //.

While these differences are unlikely to create a problem for most applications,you can avoid them if necessary by setting regex_flavor to extended.

9.7.3.7. Basic Regular Expressions

BREs differ from EREs in several respects. |,+,and ? are ordinary characters and there is no equivalent for their functionality. The delimiters for bounds are /{ and /},with { and } by themselves ordinary characters. The parentheses for nested subexpressions are /( and /),with ( and ) by themselves ordinary characters. ^ is an ordinary character except at the beginning of the RE or the beginning of a parenthesized subexpression,$ is an ordinary character except at the end of the RE or the end of a parenthesized subexpression,and * is an ordinary character if it appears at the beginning of the RE or the beginning of a parenthesized subexpression (after a possible leading ^). Finally,single-digit back references are available,and /< and /> are synonyms for [[:<:]] and [[:>:]] respectively; no other escapes are available.