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

    Interface Yield<T>

    Yield statement after a Procedure CALL

    Cypher Documentation

    interface Yield<T extends string = string> {
        and(input: undefined | Predicate): this;
        and(
            target: Variable | Property,
            params: Record<string, Variable | Property | Literal<LiteralValue>>,
        ): this;
        build(
            config?: Partial<
                {
                    cypherVersion: "5";
                    extraParams: Record<string, unknown>;
                    labelOperator: ":" | "&";
                    prefix: string;
                    unsafeEscapeOptions: Partial<
                        {
                            disableNodeLabelEscaping: boolean;
                            disableRelationshipTypeEscaping: boolean;
                        },
                    >;
                },
            >,
        ): CypherResult;
        create(clauseOrPattern: Pattern | Create): Create;
        delete(...deleteInput: DeleteInput): this;
        detachDelete(...deleteInput: DeleteInput): this;
        limit(value: number | Expr): this;
        match(clauseOrPattern: Match | MatchClausePattern): Match;
        merge(clauseOrPattern: Pattern | Merge): Merge;
        noDetachDelete(...deleteInput: DeleteInput): this;
        offset(value: number | Expr): this;
        optionalMatch(
            clauseOrPattern: MatchClausePattern | OptionalMatch,
        ): OptionalMatch;
        orderBy(...exprs: (Expr | [Expr, Order] | [Expr])[]): this;
        remove(...properties: (Property | Label)[]): this;
        return(clause: Return): Return;
        return(...columns: ("*" | ProjectionColumn)[]): Return;
        set(...params: SetParam[]): this;
        skip(value: number | Expr): this;
        unwind(clause: Unwind): Unwind;
        unwind(projection: UnwindProjectionColumn): Unwind;
        where(input: undefined | Predicate): this;
        where(
            target: Variable | Property,
            params: Record<string, Variable | Property | Literal<LiteralValue>>,
        ): this;
        with(clause: With): With;
        with(
            ...columns: (
                "*"
                | Variable | [Expr, string | Variable | Literal<LiteralValue>]
            )[],
        ): With;
        yield(...columns: YieldProjectionColumn<T>[]): this;
    }

    Type Parameters

    • T extends string = string

    Hierarchy (View Summary)

    • WithReturn
    • WithWhere
    • WithWith
    • WithMatch
    • WithUnwind
    • WithDelete
    • WithMerge
    • WithCreate
    • WithSetRemove
    • WithOrder
    • Clause
      • Yield
    Index

    Methods

    and build create delete detachDelete limit match merge noDetachDelete offset optionalMatch orderBy remove return set skip unwind where with yield

    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

    Settings

    On This Page

    Methods