Oihana PHP Arango

minMatch.php

Table of Contents

Functions

minMatch()  : string
Match documents where at least a minimum number of search expressions are true.

Functions

minMatch()

Match documents where at least a minimum number of search expressions are true.

minMatch(array<string|int, mixed> $expressions, int $minMatchCount) : string

Wraps the variadic ArangoDB AQL function MIN_MATCH(expr1, ... exprN, minMatchCount). Inside a SEARCH operation it is index-accelerated; the same function also exists as a miscellaneous function outside of SEARCH (hence the constant living in MiscFunction).

Example AQL usage:

MIN_MATCH(doc.text == "quick", doc.text == "brown", doc.text == "fox", 2)
Parameters
$expressions : array<string|int, mixed>

The candidate search expressions (kept raw).

$minMatchCount : int

Minimum number of expressions that must be satisfied.

Tags
example
use function oihana\arango\db\functions\search\minMatch;

$expr = minMatch( [ 'doc.text == "quick"' , 'doc.text == "brown"' , 'doc.text == "fox"' ] , 2 ) ;
// 'MIN_MATCH(doc.text == "quick",doc.text == "brown",doc.text == "fox",2)'
see
https://docs.arangodb.com/stable/aql/functions/arangosearch/#min_match
since
1.2.0
author

Marc Alcaraz

Return values
string

The formatted AQL expression.

On this page

Search results