Class Return

See

Cypher Documentation

Hierarchy (View Summary)

WithOrder
Clause
- Return

Index

Constructors

Methods

addColumns build distinct limit offset orderBy skip

Constructors

constructor

new Return(...columns: ("*" | ProjectionColumn)[]): Return
Parameters
- ...columns: ("*" | ProjectionColumn)[]
Returns Return
Inherited from WithOrder.constructor
- Defined in clauses/Return.ts:40

Methods

addColumns

addColumns(...columns: ("*" | ProjectionColumn)[]): this
Parameters
- ...columns: ("*" | ProjectionColumn)[]
Returns this
- Defined in clauses/Return.ts:45

build

build(
    config?: Partial<
        {
            cypherVersion: "5";
            extraParams: Record<string, unknown>;
            labelOperator: ":" | "&";
            prefix: string;
            unsafeEscapeOptions: Partial<
                {
                    disableNodeLabelEscaping: boolean;
                    disableRelationshipTypeEscaping: boolean;
                },
            >;
        },
    >,
): CypherResult
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
Inherited from Clause.build
- Defined in clauses/Clause.ts:84

distinct

distinct(): this
Returns this
- Defined in clauses/Return.ts:50

limit

limit(value: number | Expr): this
Add a LIMIT subclause.
Parameters
- value: number | Expr
Returns this
See
Cypher Documentation
Inherited from WithOrder.limit
- Defined in clauses/mixins/sub-clauses/WithOrder.ts:69

offset

offset(value: number | Expr): this
Add a OFFSET subclause. An alias to SKIP
Parameters
- value: number | Expr
Returns this
See
Cypher Documentation

Since
Neo4j 5.24
Inherited from WithOrder.offset
- Defined in clauses/mixins/sub-clauses/WithOrder.ts:60

orderBy

orderBy(...exprs: (Expr | [Expr, Order] | [Expr])[]): this
Add an ORDER BY subclause. Note that ASC is the default sorting order
Parameters
- ...exprs: (Expr | [Expr, Order] | [Expr])[]
Returns this
See
Cypher Documentation
Inherited from WithOrder.orderBy
- Defined in clauses/mixins/sub-clauses/WithOrder.ts:33

skip

skip(value: number | Expr): this
Add a SKIP subclause.
Parameters
- value: number | Expr
Returns this
See
Cypher Documentation
Inherited from WithOrder.skip
- Defined in clauses/mixins/sub-clauses/WithOrder.ts:50