`ContainsStrRegex`

This reference topic applies to FQL v4. Go to this page for the latest FQL v10 reference topics.

ContainsStrRegex( value, pattern )

contains_str_regex( value, pattern )

ContainsStrRegex( value, pattern )

ContainsStrRegex( value, pattern )

ContainsStrRegex( 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

Parameter	Type	Definition and Requirements
`value`	String	The string to compare.
`pattern`	String	The regular expression to match within `value`.

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:

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

result, err := client.Query(
	f.ContainsStrRegex("Fauna", "(Fa|na)"))

if err != nil {
	fmt.Fprintln(os.Stderr, err)
} else {
	fmt.Println(result)
}

true

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

BooleanV(True)

System.out.println(
    client.query(
        ContainsStrRegex("Fauna", "(Fa|na)")
    ).get()
);

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:

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

result, err := client.Query(
	f.ContainsStrRegex("Fauna", ".Faa*"))

if err != nil {
	fmt.Fprintln(os.Stderr, err)
} else {
	fmt.Println(result)
}

false

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

BooleanV(False)

System.out.println(
    client.query(
        ContainsStrRegex("Fauna", ".Faa*")
    ).get()
);

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