UNPKG

@neo4j/cypher-builder

Version:

A programmatic API for building Cypher queries for Neo4j

37 lines (36 loc) 1.86 kB
import type { CypherEnvironment } from "../Environment"; import type { Literal } from "../references/Literal"; import type { Variable } from "../references/Variable"; import type { Expr } from "../types"; import { Clause } from "./Clause"; import { WithCall } from "./mixins/clauses/WithCall"; import { WithCallProcedure } from "./mixins/clauses/WithCallProcedure"; import { WithCreate } from "./mixins/clauses/WithCreate"; import { WithFilter } from "./mixins/clauses/WithFilter"; import { WithLet } from "./mixins/clauses/WithLet"; import { WithMatch } from "./mixins/clauses/WithMatch"; import { WithMerge } from "./mixins/clauses/WithMerge"; import { WithReturn } from "./mixins/clauses/WithReturn"; import { WithUnwind } from "./mixins/clauses/WithUnwind"; import { WithWith } from "./mixins/clauses/WithWith"; import { WithDelete } from "./mixins/sub-clauses/WithDelete"; import { WithOrder } from "./mixins/sub-clauses/WithOrder"; import { WithSetRemove } from "./mixins/sub-clauses/WithSetRemove"; import { WithWhere } from "./mixins/sub-clauses/WithWhere"; import { WithDistinctAll } from "./mixins/WithDistinctAll"; /** @inline */ export type WithProjection = Variable | [Expr, string | Variable | Literal]; export interface With extends WithOrder, WithReturn, WithWhere, WithSetRemove, WithDelete, WithMatch, WithUnwind, WithCreate, WithMerge, WithCallProcedure, WithCall, WithDistinctAll, WithLet, WithFilter, WithWith { } /** * @see {@link https://neo4j.com/docs/cypher-manual/current/clauses/with/ | Cypher Documentation} * @group Clauses */ export declare class With extends Clause { private readonly projection; private readonly withStatement; constructor(...columns: Array<"*" | WithProjection>); addColumns(...columns: Array<"*" | WithProjection>): this; /** @internal */ getCypher(env: CypherEnvironment): string; }