search()#

relationalai.std.re
#search(regex: str|Producer, string: str|Producer) -> Match

Filters strings that contain a regular expression match and returns a Match object. Must be used in a rule or query context.

Parameters#

NameTypeDescription
regexstr or ProducerA regular expression string.
stringstr or ProducerThe string to search.

Returns#

A Match object.

Example#

#import relationalai as rai
from relationalai.std import alias, re

# =====
# SETUP
# =====

model = rai.Model("companies")
Company = model.Type("Company")

with model.rule():
    Company.add(name="RelationalAI")
    Company.add(name="Snowflake")


# =======
# EXAMPLE
# =======

with model.query() as select:
    company = Company()
    # Filter companies whose name contains 'AI'.
    re.search(r"AI", company.name)
    response = select(company.name)

print(response.results)
#            name
# 0  RelationalAI

Note that raw strings are recommended for regular expressions to avoid issues with backslashes.

See Also#