Cypher Builder - v2.7.1
    Preparing search index...

    Class Match

    Hierarchy (View Summary)

    • WithReturn
    • WithWhere
    • WithSetRemove
    • WithWith
    • WithDelete
    • WithUnwind
    • WithCreate
    • WithMerge
    • WithFinish
    • WithCallProcedure
    • WithCall
    • WithOrder
    • WithForeach
    • Clause
    Index

    Constructors

    • Parameters

      • pattern: MatchClausePattern

      Returns Match

    Methods

    • Compiles a clause into Cypher and params

      Parameters

      • Optionalconfig: Partial<
            {
                cypherVersion: "5";
                extraParams: Record<string, unknown>;
                labelOperator: ":" | "&";
                prefix: string;
                unsafeEscapeOptions: Partial<
                    {
                        disableNodeLabelEscaping: boolean;
                        disableRelationshipTypeEscaping: boolean;
                    },
                >;
            },
        >

      Returns CypherResult

    • Makes the clause an OPTIONAL MATCH

      Returns this

      new Cypher.Match(new Node({labels: ["Movie"]})).optional();
      

      Cypher:

      OPTIONAL MATCH (this:Movie)
      
    • Parameters

      • k: number

      Returns this

      Neo4j 5.21

    • Parameters

      • k: number

      Returns this

      Neo4j 5.21