ContainsStrRegex

ContainsStrRegex( value, pattern )
ContainsStrRegex( value, pattern )
ContainsStrRegex( value, pattern )
ContainsStrRegex( value, pattern )
contains_str_regex( value, pattern )
ContainsStrRegex( value, pattern )

Description

The ContainsStrRegex function returns true when the value string matches the pattern regular expression, or false when it does not.

Parameters

Parameter Type Definition and Requirements

value

String

The string to compare.

pattern

String

The regular expression to match within value.

Returns

Returns a Boolean: true when value matches the pattern regular expression, or false when it does not.

Examples

The following query demonstrates the case where the value string matches the pattern regular expression:

try
{
    Value result = await client.Query(
        ContainsStrRegex("Fauna", "(Fa|na)")
    );
    Console.WriteLine(result);
}
catch (Exception e)
{
    Console.WriteLine($"ERROR: {e.Message}");
}
BooleanV(True)
result, err := client.Query(
	f.ContainsStrRegex("Fauna", "(Fa|na)"))

if err != nil {
	fmt.Fprintln(os.Stderr, err)
} else {
	fmt.Println(result)
}
true
System.out.println(
    client.query(
        ContainsStrRegex("Fauna", "(Fa|na)")
    ).get()
);
true
client.query(
  q.ContainsStrRegex('Fauna', '(Fa|na)')
)
.then((ret) => console.log(ret))
.catch((err) => console.error(
  'Error: [%s] %s: %s',
  err.name,
  err.message,
  err.errors()[0].description,
))
true
result = client.query(
    q.contains_str_regex("Fauna", "(Fa|na)")
)
print(result)
True
ContainsStrRegex('Fauna', '(Fa|na)')
true
Query metrics:

  •    bytesIn:  48

  •   bytesOut:  17

  • computeOps:   1

  •    readOps:   0

  •   writeOps:   0

  •  readBytes:   0

  • writeBytes:   0

  •  queryTime: 3ms

  •    retries:   0

The following query demonstrates the case where the value string does not match the pattern regular expression:

try
{
    Value result = await client.Query(
        ContainsStrRegex("Fauna", ".Faa*")
    );
    Console.WriteLine(result);
}
catch (Exception e)
{
    Console.WriteLine($"ERROR: {e.Message}");
}
BooleanV(False)
result, err := client.Query(
	f.ContainsStrRegex("Fauna", ".Faa*"))

if err != nil {
	fmt.Fprintln(os.Stderr, err)
} else {
	fmt.Println(result)
}
false
System.out.println(
    client.query(
        ContainsStrRegex("Fauna", ".Faa*")
    ).get()
);
false
client.query(
  q.ContainsStrRegex('Fauna', '.Faa*')
)
.then((ret) => console.log(ret))
.catch((err) => console.error(
  'Error: [%s] %s: %s',
  err.name,
  err.message,
  err.errors()[0].description,
))
false
result = client.query(
    q.contains_str_regex("Fauna", ".Faa*")
)
print(result)
False
ContainsStrRegex('Fauna', '.Faa*')
false
Query metrics:

  •    bytesIn:  46

  •   bytesOut:  18

  • computeOps:   1

  •    readOps:   0

  •   writeOps:   0

  •  readBytes:   0

  • writeBytes:   0

  •  queryTime: 3ms

  •    retries:   0

Is this article helpful? 

Tell Fauna how the article can be improved:
 Visit Fauna's forums or email docs@fauna.com

Thank you for your feedback!