Back to top

    ReQL command: match

    Command syntax

    string.match(regexp) → nil/object


    Matches against a regular expression. If there is a match, returns an object with the fields:

    • str: The matched string
    • start: The matched string’s start
    • end: The matched string’s end
    • groups: The capture groups defined with parentheses

    If no match is found, returns nil.

    Accepts RE2 syntax. You can enable case-insensitive matching by prefixing the regular expression with (?i). See the linked RE2 documentation for more flags.

    The match command does not support backreferences.

    Example: Get all users whose name starts with “A”. Because nil evaluates to false in filter, you can just use the result of match for the predicate.

    r.table('users').filter{ |doc|

    Example: Get all users whose name ends with “n”.

    r.table('users').filter{ |doc|

    Example: Get all users whose name has “li” in it

    r.table('users').filter{ |doc|

    Example: Get all users whose name is “John” with a case-insensitive search.

    r.table('users').filter{ |doc|

    Example: Get all users whose name is composed of only characters between “a” and “z”.

    r.table('users').filter{ |doc|

    Example: Get all users where the zipcode is a string of 5 digits.

    r.table('users').filter{ |doc|

    Example: Retrieve the domain of a basic email



        :start => 0,
        :end => 20,
        :str => "",
        :groups => [
                :end => 17,
                :start => 7,
                :str => ""

    You can then retrieve only the domain with the [] selector.


    Returns ''

    Example: Fail to parse out the domain and returns nil.


    Get more help

    Couldn't find what you were looking for?