UNPKG

@neo4j/cypher-builder

Version:

A programmatic API for building Cypher queries for Neo4j

neo4j.github.io/cypher-builder/

neo4j/cypher-builder

133 lines (132 loc) • 5.66 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
import { CypherASTNode } from "../../CypherASTNode"; import type { CypherEnvironment } from "../../Environment"; import type { Expr, NormalizationType } from "../../types"; type ComparisonOperator = "=" | "<" | ">" | "<>" | "<=" | ">=" | "IS NULL" | "IS NOT NULL" | "IN" | "CONTAINS" | "STARTS WITH" | "ENDS WITH" | "=~" | "IS NORMALIZED" | "IS NOT NORMALIZED"; /** * Comparison operator expression. Created using comparison operator functions. * @group Operators * @category Comparison * @example * ``` * const op = Cypher.gt(var1, var2); * ``` */ export declare class ComparisonOp extends CypherASTNode { protected operator: ComparisonOperator; protected leftExpr: Expr; protected rightExpr: Expr | undefined; /** @internal */ constructor(operator: ComparisonOperator, left: Expr, right: Expr | undefined); /** * @internal */ getCypher(env: CypherEnvironment): string; } export declare class NormalizationOperator extends ComparisonOp { private readonly normalizationType; constructor(operator: "IS NORMALIZED" | "IS NOT NORMALIZED", left: Expr, normalizationType: NormalizationType | undefined); /** * @internal */ getCypher(env: CypherEnvironment): string; } /** Equality (`=`) operator * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison | Cypher Documentation} * @group Operators * @category Comparison */ export declare function eq(leftExpr: Expr, rightExpr: Expr): ComparisonOp; /** Inequality (`<>`) operator * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison | Cypher Documentation} * @group Operators * @category Comparison */ export declare function neq(leftExpr: Expr, rightExpr: Expr): ComparisonOp; /** Greater Than (`>`) operator * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison | Cypher Documentation} * @group Operators * @category Comparison */ export declare function gt(leftExpr: Expr, rightExpr: Expr): ComparisonOp; /** Greater Than Equal (`>=`) operator * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison | Cypher Documentation} * @group Operators * @category Comparison */ export declare function gte(leftExpr: Expr, rightExpr: Expr): ComparisonOp; /** Less Than (`<`) operator * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison | Cypher Documentation} * @group Operators * @category Comparison */ export declare function lt(leftExpr: Expr, rightExpr: Expr): ComparisonOp; /** Less Than Equal (`<=`) operator * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison | Cypher Documentation} * @group Operators * @category Comparison */ export declare function lte(leftExpr: Expr, rightExpr: Expr): ComparisonOp; /** `IS NULL` operator * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison | Cypher Documentation} * @group Operators * @category Comparison * @example * ```cypher * this0.title IS NULL * ``` */ export declare function isNull(childExpr: Expr): ComparisonOp; /** `IS NOT NULL` operator * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison | Cypher Documentation} * @group Operators * @category Comparison * @example * ```cypher * this0.title IS NULL * ``` */ export declare function isNotNull(childExpr: Expr): ComparisonOp; /** `IN` operator * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison | Cypher Documentation} * @group Operators * @category Comparison */ export declare function inOp(leftExpr: Expr, rightExpr: Expr): ComparisonOp; /** `CONTAINS` operator * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison | Cypher Documentation} * @group Operators * @category Comparison */ export declare function contains(leftExpr: Expr, rightExpr: Expr): ComparisonOp; /** `STARTS WITH` operator * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison | Cypher Documentation} * @group Operators * @category Comparison */ export declare function startsWith(leftExpr: Expr, rightExpr: Expr): ComparisonOp; /** `ENDS WITH` operator * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison | Cypher Documentation} * @group Operators * @category Comparison */ export declare function endsWith(leftExpr: Expr, rightExpr: Expr): ComparisonOp; /** Matching (=~) operator. * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison | Cypher Documentation} * @group Operators * @category Comparison */ export declare function matches(leftExpr: Expr, rightExpr: Expr): ComparisonOp; /** `IS NORMALIZED` operator * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison | Cypher Documentation} * @group Operators * @category Comparison * @since Neo4j 5.17 */ export declare function isNormalized(leftExpr: Expr, normalizationType?: NormalizationType): ComparisonOp; /** `IS NOT NORMALIZED` operator * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-comparison | Cypher Documentation} * @group Operators * @category Comparison */ export declare function isNotNormalized(leftExpr: Expr, normalizationType?: NormalizationType): ComparisonOp; export {};