1 | /**
|
2 | * object that holds all operator symbols
|
3 | */
|
4 | declare const Op: {
|
5 | /**
|
6 | * Operator -|- (PG range is adjacent to operator)
|
7 | *
|
8 | * ```js
|
9 | * [Op.adjacent]: [1, 2]
|
10 | * ```
|
11 | * In SQL
|
12 | * ```sql
|
13 | * -|- [1, 2)
|
14 | * ```
|
15 | */
|
16 | readonly adjacent: unique symbol;
|
17 | /**
|
18 | * Operator ALL
|
19 | *
|
20 | * ```js
|
21 | * [Op.gt]: {
|
22 | * [Op.all]: literal('SELECT 1')
|
23 | * }
|
24 | * ```
|
25 | * In SQL
|
26 | * ```sql
|
27 | * > ALL (SELECT 1)
|
28 | * ```
|
29 | */
|
30 | readonly all: unique symbol;
|
31 | /**
|
32 | * Operator AND
|
33 | *
|
34 | * ```js
|
35 | * [Op.and]: {a: 5}
|
36 | * ```
|
37 | * In SQL
|
38 | * ```sql
|
39 | * AND (a = 5)
|
40 | * ```
|
41 | */
|
42 | readonly and: unique symbol;
|
43 | /**
|
44 | * Operator ANY ARRAY (PG only)
|
45 | *
|
46 | * ```js
|
47 | * [Op.any]: [2,3]
|
48 | * ```
|
49 | * In SQL
|
50 | * ```sql
|
51 | * ANY ARRAY[2, 3]::INTEGER
|
52 | * ```
|
53 | *
|
54 | * Operator LIKE ANY ARRAY (also works for iLike and notLike)
|
55 | *
|
56 | * ```js
|
57 | * [Op.like]: { [Op.any]: ['cat', 'hat']}
|
58 | * ```
|
59 | * In SQL
|
60 | * ```sql
|
61 | * LIKE ANY ARRAY['cat', 'hat']
|
62 | * ```
|
63 | */
|
64 | readonly any: unique symbol;
|
65 | /**
|
66 | * Operator BETWEEN
|
67 | *
|
68 | * ```js
|
69 | * [Op.between]: [6, 10]
|
70 | * ```
|
71 | * In SQL
|
72 | * ```sql
|
73 | * BETWEEN 6 AND 10
|
74 | * ```
|
75 | */
|
76 | readonly between: unique symbol;
|
77 | /**
|
78 | * With dialect specific column identifiers (PG in this example)
|
79 | *
|
80 | * ```js
|
81 | * [Op.col]: 'user.organization_id'
|
82 | * ```
|
83 | * In SQL
|
84 | * ```sql
|
85 | * = "user"."organization_id"
|
86 | * ```
|
87 | */
|
88 | readonly col: unique symbol;
|
89 | /**
|
90 | * Operator <@ (PG array contained by operator)
|
91 | *
|
92 | * ```js
|
93 | * [Op.contained]: [1, 2]
|
94 | * ```
|
95 | * In SQL
|
96 | * ```sql
|
97 | * <@ [1, 2)
|
98 | * ```
|
99 | */
|
100 | readonly contained: unique symbol;
|
101 | /**
|
102 | * Operator @> (PG array contains operator)
|
103 | *
|
104 | * ```js
|
105 | * [Op.contains]: [1, 2]
|
106 | * ```
|
107 | * In SQL
|
108 | * ```sql
|
109 | * @> [1, 2)
|
110 | * ```
|
111 | */
|
112 | readonly contains: unique symbol;
|
113 | /**
|
114 | * Operator LIKE
|
115 | *
|
116 | * ```js
|
117 | * [Op.endsWith]: 'hat'
|
118 | * ```
|
119 | * In SQL
|
120 | * ```sql
|
121 | * LIKE '%hat'
|
122 | * ```
|
123 | */
|
124 | readonly endsWith: unique symbol;
|
125 | /**
|
126 | * Operator =
|
127 | *
|
128 | * ```js
|
129 | * [Op.eq]: 3
|
130 | * ```
|
131 | * In SQL
|
132 | * ```sql
|
133 | * = 3
|
134 | * ```
|
135 | */
|
136 | readonly eq: unique symbol;
|
137 | /**
|
138 | * Operator >
|
139 | *
|
140 | * ```js
|
141 | * [Op.gt]: 6
|
142 | * ```
|
143 | * In SQL
|
144 | * ```sql
|
145 | * > 6
|
146 | * ```
|
147 | */
|
148 | readonly gt: unique symbol;
|
149 | /**
|
150 | * Operator >=
|
151 | *
|
152 | * ```js
|
153 | * [Op.gte]: 6
|
154 | * ```
|
155 | * In SQL
|
156 | * ```sql
|
157 | * >= 6
|
158 | * ```
|
159 | */
|
160 | readonly gte: unique symbol;
|
161 |
|
162 | /**
|
163 | * Operator ILIKE (case insensitive) (PG only)
|
164 | *
|
165 | * ```js
|
166 | * [Op.iLike]: '%hat'
|
167 | * ```
|
168 | * In SQL
|
169 | * ```sql
|
170 | * ILIKE '%hat'
|
171 | * ```
|
172 | */
|
173 | readonly iLike: unique symbol;
|
174 | /**
|
175 | * Operator IN
|
176 | *
|
177 | * ```js
|
178 | * [Op.in]: [1, 2]
|
179 | * ```
|
180 | * In SQL
|
181 | * ```sql
|
182 | * IN [1, 2]
|
183 | * ```
|
184 | */
|
185 | readonly in: unique symbol;
|
186 | /**
|
187 | * Operator ~* (PG only)
|
188 | *
|
189 | * ```js
|
190 | * [Op.iRegexp]: '^[h|a|t]'
|
191 | * ```
|
192 | * In SQL
|
193 | * ```sql
|
194 | * ~* '^[h|a|t]'
|
195 | * ```
|
196 | */
|
197 | readonly iRegexp: unique symbol;
|
198 | /**
|
199 | * Operator IS
|
200 | *
|
201 | * ```js
|
202 | * [Op.is]: null
|
203 | * ```
|
204 | * In SQL
|
205 | * ```sql
|
206 | * IS null
|
207 | * ```
|
208 | */
|
209 | readonly is: unique symbol;
|
210 | /**
|
211 | * Operator LIKE
|
212 | *
|
213 | * ```js
|
214 | * [Op.like]: '%hat'
|
215 | * ```
|
216 | * In SQL
|
217 | * ```sql
|
218 | * LIKE '%hat'
|
219 | * ```
|
220 | */
|
221 | readonly like: unique symbol;
|
222 | /**
|
223 | * Operator <
|
224 | *
|
225 | * ```js
|
226 | * [Op.lt]: 10
|
227 | * ```
|
228 | * In SQL
|
229 | * ```sql
|
230 | * < 10
|
231 | * ```
|
232 | */
|
233 | readonly lt: unique symbol;
|
234 | /**
|
235 | * Operator <=
|
236 | *
|
237 | * ```js
|
238 | * [Op.lte]: 10
|
239 | * ```
|
240 | * In SQL
|
241 | * ```sql
|
242 | * <= 10
|
243 | * ```
|
244 | */
|
245 | readonly lte: unique symbol;
|
246 | /**
|
247 | * Operator !=
|
248 | *
|
249 | * ```js
|
250 | * [Op.ne]: 20
|
251 | * ```
|
252 | * In SQL
|
253 | * ```sql
|
254 | * != 20
|
255 | * ```
|
256 | */
|
257 | readonly ne: unique symbol;
|
258 | /**
|
259 | * Operator &> (PG range does not extend to the left of operator)
|
260 | *
|
261 | * ```js
|
262 | * [Op.noExtendLeft]: [1, 2]
|
263 | * ```
|
264 | * In SQL
|
265 | * ```sql
|
266 | * &> [1, 2)
|
267 | * ```
|
268 | */
|
269 | readonly noExtendLeft: unique symbol;
|
270 | /**
|
271 | * Operator &< (PG range does not extend to the right of operator)
|
272 | *
|
273 | * ```js
|
274 | * [Op.noExtendRight]: [1, 2]
|
275 | * ```
|
276 | * In SQL
|
277 | * ```sql
|
278 | * &< [1, 2)
|
279 | * ```
|
280 | */
|
281 | readonly noExtendRight: unique symbol;
|
282 | /**
|
283 | * Operator NOT
|
284 | *
|
285 | * ```js
|
286 | * [Op.not]: true
|
287 | * ```
|
288 | * In SQL
|
289 | * ```sql
|
290 | * IS NOT TRUE
|
291 | * ```
|
292 | */
|
293 | readonly not: unique symbol;
|
294 | /**
|
295 | * Operator NOT BETWEEN
|
296 | *
|
297 | * ```js
|
298 | * [Op.notBetween]: [11, 15]
|
299 | * ```
|
300 | * In SQL
|
301 | * ```sql
|
302 | * NOT BETWEEN 11 AND 15
|
303 | * ```
|
304 | */
|
305 | readonly notBetween: unique symbol;
|
306 | /**
|
307 | * Operator NOT ILIKE (case insensitive) (PG only)
|
308 | *
|
309 | * ```js
|
310 | * [Op.notILike]: '%hat'
|
311 | * ```
|
312 | * In SQL
|
313 | * ```sql
|
314 | * NOT ILIKE '%hat'
|
315 | * ```
|
316 | */
|
317 | readonly notILike: unique symbol;
|
318 | /**
|
319 | * Operator NOT IN
|
320 | *
|
321 | * ```js
|
322 | * [Op.notIn]: [1, 2]
|
323 | * ```
|
324 | * In SQL
|
325 | * ```sql
|
326 | * NOT IN [1, 2]
|
327 | * ```
|
328 | */
|
329 | readonly notIn: unique symbol;
|
330 | /**
|
331 | * Operator !~* (PG only)
|
332 | *
|
333 | * ```js
|
334 | * [Op.notIRegexp]: '^[h|a|t]'
|
335 | * ```
|
336 | * In SQL
|
337 | * ```sql
|
338 | * !~* '^[h|a|t]'
|
339 | * ```
|
340 | */
|
341 | readonly notIRegexp: unique symbol;
|
342 | /**
|
343 | * Operator NOT LIKE
|
344 | *
|
345 | * ```js
|
346 | * [Op.notLike]: '%hat'
|
347 | * ```
|
348 | * In SQL
|
349 | * ```sql
|
350 | * NOT LIKE '%hat'
|
351 | * ```
|
352 | */
|
353 | readonly notLike: unique symbol;
|
354 | /**
|
355 | * Operator NOT REGEXP (MySQL/PG only)
|
356 | *
|
357 | * ```js
|
358 | * [Op.notRegexp]: '^[h|a|t]'
|
359 | * ```
|
360 | * In SQL
|
361 | * ```sql
|
362 | * NOT REGEXP/!~ '^[h|a|t]'
|
363 | * ```
|
364 | */
|
365 | readonly notRegexp: unique symbol;
|
366 | /**
|
367 | * Operator OR
|
368 | *
|
369 | * ```js
|
370 | * [Op.or]: [{a: 5}, {a: 6}]
|
371 | * ```
|
372 | * In SQL
|
373 | * ```sql
|
374 | * (a = 5 OR a = 6)
|
375 | * ```
|
376 | */
|
377 | readonly or: unique symbol;
|
378 | /**
|
379 | * Operator && (PG array overlap operator)
|
380 | *
|
381 | * ```js
|
382 | * [Op.overlap]: [1, 2]
|
383 | * ```
|
384 | * In SQL
|
385 | * ```sql
|
386 | * && [1, 2)
|
387 | * ```
|
388 | */
|
389 | readonly overlap: unique symbol;
|
390 | /**
|
391 | * Internal placeholder
|
392 | *
|
393 | * ```js
|
394 | * [Op.placeholder]: true
|
395 | * ```
|
396 | */
|
397 | readonly placeholder: unique symbol;
|
398 | /**
|
399 | * Operator REGEXP (MySQL/PG only)
|
400 | *
|
401 | * ```js
|
402 | * [Op.regexp]: '^[h|a|t]'
|
403 | * ```
|
404 | * In SQL
|
405 | * ```sql
|
406 | * REGEXP/~ '^[h|a|t]'
|
407 | * ```
|
408 | */
|
409 | readonly regexp: unique symbol;
|
410 | /**
|
411 | * Operator LIKE
|
412 | *
|
413 | * ```js
|
414 | * [Op.startsWith]: 'hat'
|
415 | * ```
|
416 | * In SQL
|
417 | * ```sql
|
418 | * LIKE 'hat%'
|
419 | * ```
|
420 | */
|
421 | readonly startsWith: unique symbol;
|
422 | /**
|
423 | * Operator << (PG range strictly left of operator)
|
424 | *
|
425 | * ```js
|
426 | * [Op.strictLeft]: [1, 2]
|
427 | * ```
|
428 | * In SQL
|
429 | * ```sql
|
430 | * << [1, 2)
|
431 | * ```
|
432 | */
|
433 | readonly strictLeft: unique symbol;
|
434 | /**
|
435 | * Operator >> (PG range strictly right of operator)
|
436 | *
|
437 | * ```js
|
438 | * [Op.strictRight]: [1, 2]
|
439 | * ```
|
440 | * In SQL
|
441 | * ```sql
|
442 | * >> [1, 2)
|
443 | * ```
|
444 | */
|
445 | readonly strictRight: unique symbol;
|
446 | /**
|
447 | * Operator LIKE
|
448 | *
|
449 | * ```js
|
450 | * [Op.substring]: 'hat'
|
451 | * ```
|
452 | * In SQL
|
453 | * ```sql
|
454 | * LIKE '%hat%'
|
455 | * ```
|
456 | */
|
457 | readonly substring: unique symbol;
|
458 | /**
|
459 | * Operator VALUES
|
460 | *
|
461 | * ```js
|
462 | * [Op.values]: [4, 5, 6]
|
463 | * ```
|
464 | * In SQL
|
465 | * ```sql
|
466 | * VALUES (4), (5), (6)
|
467 | * ```
|
468 | */
|
469 | readonly values: unique symbol;
|
470 | };
|
471 |
|
472 | export = Op;
|