Skip to content

OPTIONAL MATCH clause

Jump to bottom
Marijn van Wezel edited this page Dec 13, 2022 · 5 revisions

The OPTIONAL MATCH clause accepts a list of patterns to (optionally) match on. Refer to the MATCH clause documentation for more information about the syntax of patterns.

Query::optionalMatch(CompletePattern|CompletePattern[] $patterns): Query

Parameters

  • $patterns : A single pattern to match, or a non-empty list of patterns to match.

Relevant methods

  • addPattern(CompletePattern ...$pattern): self : Add one or more patterns.

Examples

$movies = node("Movie");
$query = query()
    ->optionalMatch($movies)
    ->build();

$this->assertSame("OPTIONAL MATCH (:Movie)", $query);

External links

  1. Installation
  2. Usage
    1. Clauses
      1. CALL {} (subquery)
      2. CALL procedure
      3. CREATE
      4. DELETE
      5. LIMIT
      6. MATCH
      7. MERGE
      8. OPTIONAL MATCH
      9. ORDER BY
      10. REMOVE
      11. RETURN
      12. SET
      13. SKIP
      14. UNION
      15. WHERE
      16. WITH
      17. Raw clause
    2. Expressions
    3. Procedures
    4. Literals
    5. Parameters
    6. Examples
Clone this wiki locally