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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
|
/**
* Copyright (C) 2018-present MongoDB, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* <http://www.mongodb.com/licensing/server-side-public-license>.
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the Server Side Public License in all respects for
* all of the code used other than as permitted herein. If you modify file(s)
* with this exception, you may extend this exception to your version of the
* file(s), but you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version. If you delete this
* exception statement from all source files in the program, then also delete
* it in the license file.
*/
#pragma once
#include "mongo/platform/basic.h"
#include <algorithm>
#include <boost/intrusive_ptr.hpp>
#include <functional>
#include <map>
#include <pcre.h>
#include <string>
#include <utility>
#include <vector>
#include "mongo/base/init.h"
#include "mongo/db/exec/document_value/document.h"
#include "mongo/db/exec/document_value/value.h"
#include "mongo/db/pipeline/dependencies.h"
#include "mongo/db/pipeline/expression_context.h"
#include "mongo/db/pipeline/expression_visitor.h"
#include "mongo/db/pipeline/field_path.h"
#include "mongo/db/pipeline/variables.h"
#include "mongo/db/query/datetime/date_time_support.h"
#include "mongo/db/server_options.h"
#include "mongo/util/intrusive_counter.h"
#include "mongo/util/str.h"
namespace mongo {
class BSONArrayBuilder;
class BSONElement;
class BSONObjBuilder;
class DocumentSource;
/**
* Registers a Parser so it can be called from parseExpression and friends.
*
* As an example, if your expression looks like {"$foo": [1,2,3]} you would add this line:
* REGISTER_EXPRESSION(foo, ExpressionFoo::parse);
*
* An expression registered this way can be used in any featureCompatibilityVersion.
*/
#define REGISTER_EXPRESSION(key, parser) \
MONGO_INITIALIZER(addToExpressionParserMap_##key)(InitializerContext*) { \
Expression::registerExpression("$" #key, (parser), boost::none); \
return Status::OK(); \
}
/**
* Registers a Parser so it can be called from parseExpression and friends. Use this version if your
* expression can only be persisted to a catalog data structure in a feature compatibility version
* >= X.
*
* As an example, if your expression looks like {"$foo": [1,2,3]}, and can only be used in a feature
* compatibility version >= X, you would add this line:
* REGISTER_EXPRESSION_WITH_MIN_VERSION(foo, ExpressionFoo::parse, X);
*/
#define REGISTER_EXPRESSION_WITH_MIN_VERSION(key, parser, minVersion) \
MONGO_INITIALIZER(addToExpressionParserMap_##key)(InitializerContext*) { \
Expression::registerExpression("$" #key, (parser), (minVersion)); \
return Status::OK(); \
}
class Expression : public RefCountable {
public:
using Parser = std::function<boost::intrusive_ptr<Expression>(
ExpressionContext* const, BSONElement, const VariablesParseState&)>;
/**
* Represents new paths computed by an expression. Computed paths are partitioned into renames
* and non-renames. See the comments for Expression::getComputedPaths() for more information.
*/
struct ComputedPaths {
// Non-rename computed paths.
std::set<std::string> paths;
// Mappings from the old name of a path before applying this expression, to the new one
// after applying this expression.
StringMap<std::string> renames;
};
virtual ~Expression(){};
/**
* Optimize the Expression.
*
* This provides an opportunity to do constant folding, or to collapse nested operators that
* have the same precedence, such as $add, $and, or $or.
*
* The Expression will be replaced with the return value, which may or may not be the same
* object. In the case of constant folding, a computed expression may be replaced by a constant.
*
* Returns the optimized Expression.
*/
virtual boost::intrusive_ptr<Expression> optimize() {
return this;
}
/**
* Add the fields and variables used in this expression to 'deps'. References to variables which
* are local to a particular expression will be filtered out of the tracker upon return.
*/
void addDependencies(DepsTracker* deps) const {
_doAddDependencies(deps);
// Filter out references to any local variables.
if (_boundaryVariableId) {
deps->vars.erase(deps->vars.upper_bound(*_boundaryVariableId), deps->vars.end());
}
}
/**
* Serialize the Expression tree recursively.
*
* If 'explain' is false, the returned Value must result in the same Expression when parsed by
* parseOperand().
*/
virtual Value serialize(bool explain) const = 0;
/**
* Evaluate the expression with respect to the Document given by 'root' and the Variables given
* by 'variables'. It is an error to supply a Variables argument whose built-in variables (like
* $$NOW) are not set. This method is thread-safe, so long as the 'variables' passed in here is
* not shared between threads.
*/
virtual Value evaluate(const Document& root, Variables* variables) const = 0;
/**
* Returns information about the paths computed by this expression. This only needs to be
* overridden by expressions that have renaming semantics, where optimization code could take
* advantage of knowledge of these renames.
*
* Partitions paths involved in this expression into the set of computed paths and the set of
* ("new" => "old") rename mappings. Here "new" refers to the name of the path after applying
* this expression, whereas "old" refers to the name of the path before applying this
* expression.
*
* The 'exprFieldPath' is the field path at which the result of this expression will be stored.
* This is used to determine the value of the "new" path created by the rename.
*
* The 'renamingVar' is needed for checking whether a field path is a rename. For example, at
* the top level only field paths that begin with the ROOT variable, as in "$$ROOT.path", are
* renames. A field path such as "$$var.path" is not a rename.
*
* Now consider the example of a rename expressed via a $map:
*
* {$map: {input: "$array", as: "iter", in: {...}}}
*
* In this case, only field paths inside the "in" clause beginning with "iter", such as
* "$$iter.path", are renames.
*/
virtual ComputedPaths getComputedPaths(const std::string& exprFieldPath,
Variables::Id renamingVar = Variables::kRootId) const {
return {{exprFieldPath}, {}};
}
/**
* This allows an arbitrary class to implement logic which gets dispatched to at runtime
* depending on the type of the Expression.
*/
virtual void acceptVisitor(ExpressionVisitor* visitor) = 0;
/**
* Parses a BSON Object that could represent an object literal or a functional expression like
* $add.
*
* Calls parseExpression() on any sub-document (including possibly the entire document) which
* consists of a single field name starting with a '$'.
*/
static boost::intrusive_ptr<Expression> parseObject(ExpressionContext* const expCtx,
BSONObj obj,
const VariablesParseState& vps);
/**
* Parses a BSONObj which has already been determined to be a functional expression.
*
* Throws an error if 'obj' does not contain exactly one field, or if that field's name does not
* match a registered expression name.
*/
static boost::intrusive_ptr<Expression> parseExpression(ExpressionContext* const expCtx,
BSONObj obj,
const VariablesParseState& vps);
/**
* Parses a BSONElement which is an argument to an Expression.
*
* An argument is allowed to be another expression, or a literal value, so this can call
* parseObject(), ExpressionFieldPath::parse(), ExpressionArray::parse(), or
* ExpressionConstant::parse() as necessary.
*/
static boost::intrusive_ptr<Expression> parseOperand(ExpressionContext* const expCtx,
BSONElement exprElement,
const VariablesParseState& vps);
/**
* Return whether 'name' refers to an expression in the language.
*/
static bool isExpressionName(StringData name);
/*
Produce a field path std::string with the field prefix removed.
Throws an error if the field prefix is not present.
@param prefixedField the prefixed field
@returns the field path with the prefix removed
*/
static std::string removeFieldPrefix(const std::string& prefixedField);
/**
* Registers an Parser so it can be called from parseExpression.
*
* DO NOT call this method directly. Instead, use the REGISTER_EXPRESSION macro defined in this
* file.
*/
static void registerExpression(
std::string key,
Parser parser,
boost::optional<ServerGlobalParams::FeatureCompatibility::Version> requiredMinVersion);
const auto& getChildren() const {
return _children;
}
auto& getChildren() {
return _children;
}
auto getExpressionContext() const {
return _expCtx;
}
protected:
using ExpressionVector = std::vector<boost::intrusive_ptr<Expression>>;
Expression(ExpressionContext* const expCtx) : Expression(expCtx, {}) {}
Expression(ExpressionContext* const expCtx, ExpressionVector&& children)
: _children(std::move(children)), _expCtx(expCtx) {
auto varIds = _expCtx->variablesParseState.getDefinedVariableIDs();
if (!varIds.empty()) {
_boundaryVariableId = *std::prev(varIds.end());
}
}
virtual void _doAddDependencies(DepsTracker* deps) const = 0;
/**
* Owning container for all sub-Expressions.
*
* Some derived classes contain named fields since they orginate from user syntax containing
* field names. These classes contain alternate data structures or object members for accessing
* children. These structures or object memebers are expected to reference this data structure.
* In addition this structure should not be modified by named-field derivied classes to avoid
* invalidating references.
*/
ExpressionVector _children;
private:
boost::optional<Variables::Id> _boundaryVariableId;
ExpressionContext* const _expCtx;
};
/**
* Inherit from ExpressionVariadic or ExpressionFixedArity instead of directly from this class.
*/
class ExpressionNary : public Expression {
public:
boost::intrusive_ptr<Expression> optimize() override;
Value serialize(bool explain) const override;
/*
Add an operand to the n-ary expression.
@param pExpression the expression to add
*/
virtual void addOperand(const boost::intrusive_ptr<Expression>& pExpression);
virtual bool isAssociative() const {
return false;
}
virtual bool isCommutative() const {
return false;
}
virtual const char* getOpName() const = 0;
virtual void validateArguments(const ExpressionVector& args) const {}
static ExpressionVector parseArguments(ExpressionContext* const expCtx,
BSONElement bsonExpr,
const VariablesParseState& vps);
const ExpressionVector& getOperandList() const {
return _children;
}
protected:
explicit ExpressionNary(ExpressionContext* const expCtx) : Expression(expCtx) {}
void _doAddDependencies(DepsTracker* deps) const override;
};
/// Inherit from ExpressionVariadic or ExpressionFixedArity instead of directly from this class.
template <typename SubClass>
class ExpressionNaryBase : public ExpressionNary {
public:
static boost::intrusive_ptr<Expression> parse(ExpressionContext* const expCtx,
BSONElement bsonExpr,
const VariablesParseState& vps) {
auto expr = make_intrusive<SubClass>(expCtx);
ExpressionVector args = parseArguments(expCtx, bsonExpr, vps);
expr->validateArguments(args);
expr->_children = std::move(args);
return std::move(expr);
}
protected:
explicit ExpressionNaryBase(ExpressionContext* const expCtx) : ExpressionNary(expCtx) {}
};
/// Inherit from this class if your expression takes a variable number of arguments.
template <typename SubClass>
class ExpressionVariadic : public ExpressionNaryBase<SubClass> {
public:
explicit ExpressionVariadic(ExpressionContext* const expCtx)
: ExpressionNaryBase<SubClass>(expCtx) {}
};
/**
* Inherit from this class if your expression can take a range of arguments, e.g. if it has some
* optional arguments.
*/
template <typename SubClass, int MinArgs, int MaxArgs>
class ExpressionRangedArity : public ExpressionNaryBase<SubClass> {
public:
explicit ExpressionRangedArity(ExpressionContext* const expCtx)
: ExpressionNaryBase<SubClass>(expCtx) {}
void validateArguments(const Expression::ExpressionVector& args) const override {
uassert(28667,
str::stream() << "Expression " << this->getOpName() << " takes at least " << MinArgs
<< " arguments, and at most " << MaxArgs << ", but " << args.size()
<< " were passed in.",
MinArgs <= args.size() && args.size() <= MaxArgs);
}
};
/// Inherit from this class if your expression takes a fixed number of arguments.
template <typename SubClass, int NArgs>
class ExpressionFixedArity : public ExpressionNaryBase<SubClass> {
public:
explicit ExpressionFixedArity(ExpressionContext* const expCtx)
: ExpressionNaryBase<SubClass>(expCtx) {}
void validateArguments(const Expression::ExpressionVector& args) const override {
uassert(16020,
str::stream() << "Expression " << this->getOpName() << " takes exactly " << NArgs
<< " arguments. " << args.size() << " were passed in.",
args.size() == NArgs);
}
};
/**
* Used to make Accumulators available as Expressions, e.g., to make $sum available as an Expression
* use "REGISTER_EXPRESSION(sum, ExpressionAccumulator<AccumulatorSum>::parse);".
*/
template <typename AccumulatorState>
class ExpressionFromAccumulator
: public ExpressionVariadic<ExpressionFromAccumulator<AccumulatorState>> {
public:
explicit ExpressionFromAccumulator(ExpressionContext* const expCtx)
: ExpressionVariadic<ExpressionFromAccumulator<AccumulatorState>>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final {
AccumulatorState accum(this->getExpressionContext());
const auto n = this->_children.size();
// If a single array arg is given, loop through it passing each member to the accumulator.
// If a single, non-array arg is given, pass it directly to the accumulator.
if (n == 1) {
Value singleVal = this->_children[0]->evaluate(root, variables);
if (singleVal.getType() == Array) {
for (const Value& val : singleVal.getArray()) {
accum.process(val, false);
}
} else {
accum.process(singleVal, false);
}
} else {
// If multiple arguments are given, pass all arguments to the accumulator.
for (auto&& argument : this->_children) {
accum.process(argument->evaluate(root, variables), false);
}
}
return accum.getValue(false);
}
bool isAssociative() const final {
// Return false if a single argument is given to avoid a single array argument being treated
// as an array instead of as a list of arguments.
if (this->_children.size() == 1) {
return false;
}
return AccumulatorState(this->getExpressionContext()).isAssociative();
}
bool isCommutative() const final {
return AccumulatorState(this->getExpressionContext()).isCommutative();
}
const char* getOpName() const final {
return AccumulatorState(this->getExpressionContext()).getOpName();
}
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
/**
* Inherit from this class if your expression takes exactly one numeric argument.
*/
template <typename SubClass>
class ExpressionSingleNumericArg : public ExpressionFixedArity<SubClass, 1> {
public:
explicit ExpressionSingleNumericArg(ExpressionContext* const expCtx)
: ExpressionFixedArity<SubClass, 1>(expCtx) {}
virtual ~ExpressionSingleNumericArg() = default;
Value evaluate(const Document& root, Variables* variables) const final {
Value arg = this->_children[0]->evaluate(root, variables);
if (arg.nullish())
return Value(BSONNULL);
uassert(28765,
str::stream() << this->getOpName() << " only supports numeric types, not "
<< typeName(arg.getType()),
arg.numeric());
return evaluateNumericArg(arg);
}
virtual Value evaluateNumericArg(const Value& numericArg) const = 0;
};
/**
* Inherit from this class if your expression takes exactly two numeric arguments.
*/
template <typename SubClass>
class ExpressionTwoNumericArgs : public ExpressionFixedArity<SubClass, 2> {
public:
explicit ExpressionTwoNumericArgs(ExpressionContext* const expCtx)
: ExpressionFixedArity<SubClass, 2>(expCtx) {}
virtual ~ExpressionTwoNumericArgs() = default;
/**
* Evaluate performs the type checking necessary to make sure that both arguments are numeric,
* then calls the evaluateNumericArgs on the two numeric args:
* 1. If either input is nullish, it returns null.
* 2. If either input is not numeric, it throws an error.
* 3. Call evaluateNumericArgs on the two numeric args.
*/
Value evaluate(const Document& root, Variables* variables) const final {
Value arg1 = this->_children[0]->evaluate(root, variables);
if (arg1.nullish())
return Value(BSONNULL);
uassert(51044,
str::stream() << this->getOpName() << " only supports numeric types, not "
<< typeName(arg1.getType()),
arg1.numeric());
Value arg2 = this->_children[1]->evaluate(root, variables);
if (arg2.nullish())
return Value(BSONNULL);
uassert(51045,
str::stream() << this->getOpName() << " only supports numeric types, not "
<< typeName(arg2.getType()),
arg2.numeric());
return evaluateNumericArgs(arg1, arg2);
}
/**
* Evaluate the expression on exactly two numeric arguments.
*/
virtual Value evaluateNumericArgs(const Value& numericArg1, const Value& numericArg2) const = 0;
};
/**
* A constant expression. Repeated calls to evaluate() will always return the same thing.
*/
class ExpressionConstant final : public Expression {
public:
boost::intrusive_ptr<Expression> optimize() final;
Value evaluate(const Document& root, Variables* variables) const final;
Value serialize(bool explain) const final;
const char* getOpName() const;
/**
* Creates a new ExpressionConstant with value 'value'.
*/
static boost::intrusive_ptr<ExpressionConstant> create(ExpressionContext* const expCtx,
const Value& value);
static boost::intrusive_ptr<Expression> parse(ExpressionContext* const expCtx,
BSONElement bsonExpr,
const VariablesParseState& vps);
/**
* Returns true if 'expression' is nullptr or if 'expression' is an instance of an
* ExpressionConstant.
*/
static bool isNullOrConstant(boost::intrusive_ptr<Expression> expression) {
return !expression || dynamic_cast<ExpressionConstant*>(expression.get());
}
/**
* Returns true if every expression in 'expressions' is either a nullptr or an instance of an
* ExpressionConstant.
*/
static bool allNullOrConstant(
const std::initializer_list<boost::intrusive_ptr<Expression>>& expressions) {
return std::all_of(expressions.begin(), expressions.end(), [](auto exp) {
return ExpressionConstant::isNullOrConstant(exp);
});
}
/**
* Returns the constant value represented by this Expression.
*/
Value getValue() const {
return _value;
}
void setValue(const Value& value) {
_value = value;
};
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
protected:
void _doAddDependencies(DepsTracker* deps) const override;
private:
ExpressionConstant(ExpressionContext* const expCtx, const Value& value);
Value _value;
};
/**
* Inherit from this class if your expression works with date types, and accepts either a single
* argument which is a date, or an object {date: <date>, timezone: <string>}.
*/
template <typename SubClass>
class DateExpressionAcceptingTimeZone : public Expression {
public:
virtual ~DateExpressionAcceptingTimeZone() {}
Value evaluate(const Document& root, Variables* variables) const final {
auto dateVal = _date->evaluate(root, variables);
if (dateVal.nullish()) {
return Value(BSONNULL);
}
auto date = dateVal.coerceToDate();
if (!_timeZone) {
return evaluateDate(date, TimeZoneDatabase::utcZone());
}
auto timeZoneId = _timeZone->evaluate(root, variables);
if (timeZoneId.nullish()) {
return Value(BSONNULL);
}
uassert(40533,
str::stream() << _opName
<< " requires a string for the timezone argument, but was given a "
<< typeName(timeZoneId.getType()) << " (" << timeZoneId.toString()
<< ")",
timeZoneId.getType() == BSONType::String);
invariant(getExpressionContext()->timeZoneDatabase);
auto timeZone =
getExpressionContext()->timeZoneDatabase->getTimeZone(timeZoneId.getString());
return evaluateDate(date, timeZone);
}
/**
* Always serializes to the full {date: <date arg>, timezone: <timezone arg>} format, leaving
* off the timezone if not specified.
*/
Value serialize(bool explain) const final {
auto timezone = _timeZone ? _timeZone->serialize(explain) : Value();
return Value(Document{
{_opName,
Document{{"date", _date->serialize(explain)}, {"timezone", std::move(timezone)}}}});
}
boost::intrusive_ptr<Expression> optimize() final {
_date = _date->optimize();
if (_timeZone) {
_timeZone = _timeZone->optimize();
}
if (ExpressionConstant::allNullOrConstant({_date, _timeZone})) {
// Everything is a constant, so we can turn into a constant.
return ExpressionConstant::create(
getExpressionContext(), evaluate(Document{}, &(getExpressionContext()->variables)));
}
return this;
}
static boost::intrusive_ptr<Expression> parse(ExpressionContext* const expCtx,
BSONElement operatorElem,
const VariablesParseState& variablesParseState) {
if (operatorElem.type() == BSONType::Object) {
if (operatorElem.embeddedObject().firstElementFieldName()[0] == '$') {
// Assume this is an expression specification representing the date argument
// like {$add: [<date>, 1000]}.
return new SubClass(expCtx,
Expression::parseObject(expCtx,
operatorElem.embeddedObject(),
variablesParseState));
} else {
// It's an object specifying the date and timezone options like {date: <date>,
// timezone: <timezone>}.
auto opName = operatorElem.fieldNameStringData();
boost::intrusive_ptr<Expression> date;
boost::intrusive_ptr<Expression> timeZone;
for (const auto& subElem : operatorElem.embeddedObject()) {
auto argName = subElem.fieldNameStringData();
if (argName == "date"_sd) {
date = Expression::parseOperand(expCtx, subElem, variablesParseState);
} else if (argName == "timezone"_sd) {
timeZone = Expression::parseOperand(expCtx, subElem, variablesParseState);
} else {
uasserted(40535,
str::stream() << "unrecognized option to " << opName << ": \""
<< argName << "\"");
}
}
uassert(40539,
str::stream() << "missing 'date' argument to " << opName
<< ", provided: " << operatorElem,
date);
return new SubClass(expCtx, std::move(date), std::move(timeZone));
}
} else if (operatorElem.type() == BSONType::Array) {
auto elems = operatorElem.Array();
uassert(
40536,
str::stream() << operatorElem.fieldNameStringData()
<< " accepts exactly one argument if given an array, but was given "
<< elems.size(),
elems.size() == 1);
// We accept an argument wrapped in a single array. For example, either {$week: <date>}
// or {$week: [<date>]} are valid, but not {$week: [{date: <date>}]}.
return new SubClass(expCtx,
Expression::parseOperand(expCtx, elems[0], variablesParseState));
}
// Exhausting the other possibilities, we are left with a literal value which should be
// treated as the date argument.
return new SubClass(expCtx,
Expression::parseOperand(expCtx, operatorElem, variablesParseState));
}
protected:
explicit DateExpressionAcceptingTimeZone(ExpressionContext* const expCtx,
const StringData opName,
boost::intrusive_ptr<Expression> date,
boost::intrusive_ptr<Expression> timeZone)
: Expression(expCtx, {date, timeZone}),
_opName(opName),
_date(_children[0]),
_timeZone(_children[1]) {}
void _doAddDependencies(DepsTracker* deps) const final {
_date->addDependencies(deps);
if (_timeZone) {
_timeZone->addDependencies(deps);
}
}
/**
* Subclasses should implement this to do their actual date-related logic. Uses 'timezone' to
* evaluate the expression against 'data'. If the user did not specify a time zone, 'timezone'
* will represent the UTC zone.
*/
virtual Value evaluateDate(Date_t date, const TimeZone& timezone) const = 0;
private:
// The name of this expression, e.g. $week or $month.
StringData _opName;
// The expression representing the date argument.
boost::intrusive_ptr<Expression>& _date;
// The expression representing the timezone argument.
boost::intrusive_ptr<Expression>& _timeZone;
};
class ExpressionAbs final : public ExpressionSingleNumericArg<ExpressionAbs> {
public:
explicit ExpressionAbs(ExpressionContext* const expCtx)
: ExpressionSingleNumericArg<ExpressionAbs>(expCtx) {}
Value evaluateNumericArg(const Value& numericArg) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionAdd final : public ExpressionVariadic<ExpressionAdd> {
public:
explicit ExpressionAdd(ExpressionContext* const expCtx)
: ExpressionVariadic<ExpressionAdd>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
bool isAssociative() const final {
return true;
}
bool isCommutative() const final {
return true;
}
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionAllElementsTrue final : public ExpressionFixedArity<ExpressionAllElementsTrue, 1> {
public:
explicit ExpressionAllElementsTrue(ExpressionContext* const expCtx)
: ExpressionFixedArity<ExpressionAllElementsTrue, 1>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionAnd final : public ExpressionVariadic<ExpressionAnd> {
public:
explicit ExpressionAnd(ExpressionContext* const expCtx)
: ExpressionVariadic<ExpressionAnd>(expCtx) {}
boost::intrusive_ptr<Expression> optimize() final;
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
bool isAssociative() const final {
return true;
}
bool isCommutative() const final {
return true;
}
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionAnyElementTrue final : public ExpressionFixedArity<ExpressionAnyElementTrue, 1> {
public:
explicit ExpressionAnyElementTrue(ExpressionContext* const expCtx)
: ExpressionFixedArity<ExpressionAnyElementTrue, 1>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionArray final : public ExpressionVariadic<ExpressionArray> {
public:
explicit ExpressionArray(ExpressionContext* const expCtx)
: ExpressionVariadic<ExpressionArray>(expCtx) {}
ExpressionArray(ExpressionContext* const expCtx,
std::vector<boost::intrusive_ptr<Expression>>&& children)
: ExpressionVariadic<ExpressionArray>(expCtx) {
_children = std::move(children);
}
Value evaluate(const Document& root, Variables* variables) const final;
Value serialize(bool explain) const final;
static boost::intrusive_ptr<ExpressionArray> create(
ExpressionContext* const expCtx, std::vector<boost::intrusive_ptr<Expression>>&& children) {
return make_intrusive<ExpressionArray>(expCtx, std::move(children));
}
boost::intrusive_ptr<Expression> optimize() final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionArrayElemAt final : public ExpressionFixedArity<ExpressionArrayElemAt, 2> {
public:
explicit ExpressionArrayElemAt(ExpressionContext* const expCtx)
: ExpressionFixedArity<ExpressionArrayElemAt, 2>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionFirst final : public ExpressionFixedArity<ExpressionFirst, 1> {
public:
explicit ExpressionFirst(ExpressionContext* const expCtx)
: ExpressionFixedArity<ExpressionFirst, 1>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionLast final : public ExpressionFixedArity<ExpressionLast, 1> {
public:
explicit ExpressionLast(ExpressionContext* const expCtx)
: ExpressionFixedArity<ExpressionLast, 1>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionObjectToArray final : public ExpressionFixedArity<ExpressionObjectToArray, 1> {
public:
explicit ExpressionObjectToArray(ExpressionContext* const expCtx)
: ExpressionFixedArity<ExpressionObjectToArray, 1>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionArrayToObject final : public ExpressionFixedArity<ExpressionArrayToObject, 1> {
public:
explicit ExpressionArrayToObject(ExpressionContext* const expCtx)
: ExpressionFixedArity<ExpressionArrayToObject, 1>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionBsonSize final : public ExpressionFixedArity<ExpressionBsonSize, 1> {
public:
explicit ExpressionBsonSize(ExpressionContext* const expCtx)
: ExpressionFixedArity<ExpressionBsonSize, 1>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final {
return "$bsonSize";
}
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionCeil final : public ExpressionSingleNumericArg<ExpressionCeil> {
public:
explicit ExpressionCeil(ExpressionContext* const expCtx)
: ExpressionSingleNumericArg<ExpressionCeil>(expCtx) {}
Value evaluateNumericArg(const Value& numericArg) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionCoerceToBool final : public Expression {
public:
boost::intrusive_ptr<Expression> optimize() final;
Value evaluate(const Document& root, Variables* variables) const final;
Value serialize(bool explain) const final;
static boost::intrusive_ptr<ExpressionCoerceToBool> create(
ExpressionContext* const expCtx, boost::intrusive_ptr<Expression> pExpression);
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
protected:
void _doAddDependencies(DepsTracker* deps) const final;
private:
ExpressionCoerceToBool(ExpressionContext* const expCtx,
boost::intrusive_ptr<Expression> pExpression);
boost::intrusive_ptr<Expression>& pExpression;
};
class ExpressionCompare final : public ExpressionFixedArity<ExpressionCompare, 2> {
public:
/**
* Enumeration of comparison operators. Any changes to these values require adjustment of
* the lookup table in the implementation.
*/
enum CmpOp {
EQ = 0, // return true for a == b, false otherwise
NE = 1, // return true for a != b, false otherwise
GT = 2, // return true for a > b, false otherwise
GTE = 3, // return true for a >= b, false otherwise
LT = 4, // return true for a < b, false otherwise
LTE = 5, // return true for a <= b, false otherwise
CMP = 6, // return -1, 0, 1 for a < b, a == b, a > b
};
ExpressionCompare(ExpressionContext* const expCtx, CmpOp cmpOp)
: ExpressionFixedArity<ExpressionCompare, 2>(expCtx), cmpOp(cmpOp) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
CmpOp getOp() const {
return cmpOp;
}
static boost::intrusive_ptr<Expression> parse(ExpressionContext* const expCtx,
BSONElement bsonExpr,
const VariablesParseState& vps,
CmpOp cmpOp);
static boost::intrusive_ptr<ExpressionCompare> create(
ExpressionContext* const expCtx,
CmpOp cmpOp,
const boost::intrusive_ptr<Expression>& exprLeft,
const boost::intrusive_ptr<Expression>& exprRight);
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
private:
CmpOp cmpOp;
};
class ExpressionConcat final : public ExpressionVariadic<ExpressionConcat> {
public:
explicit ExpressionConcat(ExpressionContext* const expCtx)
: ExpressionVariadic<ExpressionConcat>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
bool isAssociative() const final {
return true;
}
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionConcatArrays final : public ExpressionVariadic<ExpressionConcatArrays> {
public:
explicit ExpressionConcatArrays(ExpressionContext* const expCtx)
: ExpressionVariadic<ExpressionConcatArrays>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
bool isAssociative() const final {
return true;
}
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionCond final : public ExpressionFixedArity<ExpressionCond, 3> {
public:
explicit ExpressionCond(ExpressionContext* const expCtx) : Base(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
static boost::intrusive_ptr<Expression> parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vps);
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
private:
typedef ExpressionFixedArity<ExpressionCond, 3> Base;
};
class ExpressionDateFromString final : public Expression {
public:
boost::intrusive_ptr<Expression> optimize() final;
Value serialize(bool explain) const final;
Value evaluate(const Document& root, Variables* variables) const final;
static boost::intrusive_ptr<Expression> parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vps);
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
protected:
void _doAddDependencies(DepsTracker* deps) const final;
private:
ExpressionDateFromString(ExpressionContext* const expCtx,
boost::intrusive_ptr<Expression> dateString,
boost::intrusive_ptr<Expression> timeZone,
boost::intrusive_ptr<Expression> format,
boost::intrusive_ptr<Expression> onNull,
boost::intrusive_ptr<Expression> onError);
boost::intrusive_ptr<Expression>& _dateString;
boost::intrusive_ptr<Expression>& _timeZone;
boost::intrusive_ptr<Expression>& _format;
boost::intrusive_ptr<Expression>& _onNull;
boost::intrusive_ptr<Expression>& _onError;
};
class ExpressionDateFromParts final : public Expression {
public:
boost::intrusive_ptr<Expression> optimize() final;
Value serialize(bool explain) const final;
Value evaluate(const Document& root, Variables* variables) const final;
static boost::intrusive_ptr<Expression> parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vps);
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
protected:
void _doAddDependencies(DepsTracker* deps) const final;
private:
ExpressionDateFromParts(ExpressionContext* const expCtx,
boost::intrusive_ptr<Expression> year,
boost::intrusive_ptr<Expression> month,
boost::intrusive_ptr<Expression> day,
boost::intrusive_ptr<Expression> hour,
boost::intrusive_ptr<Expression> minute,
boost::intrusive_ptr<Expression> second,
boost::intrusive_ptr<Expression> millisecond,
boost::intrusive_ptr<Expression> isoWeekYear,
boost::intrusive_ptr<Expression> isoWeek,
boost::intrusive_ptr<Expression> isoDayOfWeek,
boost::intrusive_ptr<Expression> timeZone);
/**
* This function checks whether a field is a number.
*
* If 'field' is null, the default value is returned trough the 'returnValue' out
* parameter and the function returns true.
*
* If 'field' is not null:
* - if the value is "nullish", the function returns false.
* - if the value can not be coerced to an integral value, a UserException is thrown.
* - otherwise, the coerced integral value is returned through the 'returnValue'
* out parameter, and the function returns true.
*/
bool evaluateNumberWithDefault(const Document& root,
const Expression* field,
StringData fieldName,
long long defaultValue,
long long* returnValue,
Variables* variables) const;
/**
* This function has the same behavior as evaluteNumberWithDefault(), except that it uasserts if
* the resulting value is not in the range defined by kMaxValueForDatePart and
* kMinValueForDatePart.
*/
bool evaluateNumberWithDefaultAndBounds(const Document& root,
const Expression* field,
StringData fieldName,
long long defaultValue,
long long* returnValue,
Variables* variables) const;
boost::intrusive_ptr<Expression>& _year;
boost::intrusive_ptr<Expression>& _month;
boost::intrusive_ptr<Expression>& _day;
boost::intrusive_ptr<Expression>& _hour;
boost::intrusive_ptr<Expression>& _minute;
boost::intrusive_ptr<Expression>& _second;
boost::intrusive_ptr<Expression>& _millisecond;
boost::intrusive_ptr<Expression>& _isoWeekYear;
boost::intrusive_ptr<Expression>& _isoWeek;
boost::intrusive_ptr<Expression>& _isoDayOfWeek;
boost::intrusive_ptr<Expression>& _timeZone;
// Some date conversions spend a long time iterating through date tables when dealing with large
// input numbers, so we place a reasonable limit on the magnitude of any argument to
// $dateFromParts: inputs that fit within a 16-bit int are permitted.
static constexpr long long kMaxValueForDatePart = std::numeric_limits<int16_t>::max();
static constexpr long long kMinValueForDatePart = std::numeric_limits<int16_t>::lowest();
};
class ExpressionDateToParts final : public Expression {
public:
boost::intrusive_ptr<Expression> optimize() final;
Value serialize(bool explain) const final;
Value evaluate(const Document& root, Variables* variables) const final;
static boost::intrusive_ptr<Expression> parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vps);
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
protected:
void _doAddDependencies(DepsTracker* deps) const final;
private:
/**
* The iso8601 argument controls whether to output ISO8601 elements or natural calendar.
*/
ExpressionDateToParts(ExpressionContext* const expCtx,
boost::intrusive_ptr<Expression> date,
boost::intrusive_ptr<Expression> timeZone,
boost::intrusive_ptr<Expression> iso8601);
boost::optional<int> evaluateIso8601Flag(const Document& root, Variables* variables) const;
boost::intrusive_ptr<Expression>& _date;
boost::intrusive_ptr<Expression>& _timeZone;
boost::intrusive_ptr<Expression>& _iso8601;
};
class ExpressionDateToString final : public Expression {
public:
boost::intrusive_ptr<Expression> optimize() final;
Value serialize(bool explain) const final;
Value evaluate(const Document& root, Variables* variables) const final;
static boost::intrusive_ptr<Expression> parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vps);
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
protected:
void _doAddDependencies(DepsTracker* deps) const final;
private:
ExpressionDateToString(ExpressionContext* const expCtx,
boost::intrusive_ptr<Expression> format,
boost::intrusive_ptr<Expression> date,
boost::intrusive_ptr<Expression> timeZone,
boost::intrusive_ptr<Expression> onNull);
boost::intrusive_ptr<Expression>& _format;
boost::intrusive_ptr<Expression>& _date;
boost::intrusive_ptr<Expression>& _timeZone;
boost::intrusive_ptr<Expression>& _onNull;
};
class ExpressionDayOfMonth final : public DateExpressionAcceptingTimeZone<ExpressionDayOfMonth> {
public:
explicit ExpressionDayOfMonth(ExpressionContext* const expCtx,
boost::intrusive_ptr<Expression> date,
boost::intrusive_ptr<Expression> timeZone = nullptr)
: DateExpressionAcceptingTimeZone<ExpressionDayOfMonth>(
expCtx, "$dayOfMonth", std::move(date), std::move(timeZone)) {}
Value evaluateDate(Date_t date, const TimeZone& timeZone) const final {
return Value(timeZone.dateParts(date).dayOfMonth);
}
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionDayOfWeek final : public DateExpressionAcceptingTimeZone<ExpressionDayOfWeek> {
public:
explicit ExpressionDayOfWeek(ExpressionContext* const expCtx,
boost::intrusive_ptr<Expression> date,
boost::intrusive_ptr<Expression> timeZone = nullptr)
: DateExpressionAcceptingTimeZone<ExpressionDayOfWeek>(
expCtx, "$dayOfWeek", std::move(date), std::move(timeZone)) {}
Value evaluateDate(Date_t date, const TimeZone& timeZone) const final {
return Value(timeZone.dayOfWeek(date));
}
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionDayOfYear final : public DateExpressionAcceptingTimeZone<ExpressionDayOfYear> {
public:
explicit ExpressionDayOfYear(ExpressionContext* const expCtx,
boost::intrusive_ptr<Expression> date,
boost::intrusive_ptr<Expression> timeZone = nullptr)
: DateExpressionAcceptingTimeZone<ExpressionDayOfYear>(
expCtx, "$dayOfYear", std::move(date), std::move(timeZone)) {}
Value evaluateDate(Date_t date, const TimeZone& timeZone) const final {
return Value(timeZone.dayOfYear(date));
}
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionDivide final : public ExpressionFixedArity<ExpressionDivide, 2> {
public:
explicit ExpressionDivide(ExpressionContext* const expCtx)
: ExpressionFixedArity<ExpressionDivide, 2>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionExp final : public ExpressionSingleNumericArg<ExpressionExp> {
public:
explicit ExpressionExp(ExpressionContext* const expCtx)
: ExpressionSingleNumericArg<ExpressionExp>(expCtx) {}
Value evaluateNumericArg(const Value& numericArg) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionFieldPath final : public Expression {
public:
bool isRootFieldPath() const {
return _variable == Variables::kRootId;
}
boost::intrusive_ptr<Expression> optimize() final;
Value evaluate(const Document& root, Variables* variables) const final;
Value serialize(bool explain) const final;
/*
Create a field path expression using old semantics (rooted off of CURRENT).
// NOTE: this method is deprecated and only used by tests
// TODO remove this method in favor of parse()
Evaluation will extract the value associated with the given field
path from the source document.
@param fieldPath the field path string, without any leading document
indicator
@returns the newly created field path expression
*/
static boost::intrusive_ptr<ExpressionFieldPath> create(ExpressionContext* const expCtx,
const std::string& fieldPath);
/// Like create(), but works with the raw std::string from the user with the "$" prefixes.
static boost::intrusive_ptr<ExpressionFieldPath> parse(ExpressionContext* const expCtx,
const std::string& raw,
const VariablesParseState& vps);
/**
* Returns true if this expression logically represents the path 'dottedPath'. For example, if
* 'dottedPath' is 'a.b' and this FieldPath is '$$CURRENT.a.b', returns true.
*/
bool representsPath(const std::string& dottedPath) const;
const FieldPath& getFieldPath() const {
return _fieldPath;
}
Variables::Id getVariableId() const {
return _variable;
}
auto getFieldPathWithoutCurrentPrefix() const {
return _fieldPath.tail();
}
ComputedPaths getComputedPaths(const std::string& exprFieldPath,
Variables::Id renamingVar) const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
protected:
void _doAddDependencies(DepsTracker* deps) const final;
private:
ExpressionFieldPath(ExpressionContext* const expCtx,
const std::string& fieldPath,
Variables::Id variable);
/*
Internal implementation of evaluate(), used recursively.
The internal implementation doesn't just use a loop because of
the possibility that we need to skip over an array. If the path
is "a.b.c", and a is an array, then we fan out from there, and
traverse "b.c" for each element of a:[...]. This requires that
a be an array of objects in order to navigate more deeply.
@param index current path field index to extract
@param input current document traversed to (not the top-level one)
@returns the field found; could be an array
*/
Value evaluatePath(size_t index, const Document& input) const;
// Helper for evaluatePath to handle Array case
Value evaluatePathArray(size_t index, const Value& input) const;
const FieldPath _fieldPath;
const Variables::Id _variable;
};
class ExpressionFilter final : public Expression {
public:
boost::intrusive_ptr<Expression> optimize() final;
Value serialize(bool explain) const final;
Value evaluate(const Document& root, Variables* variables) const final;
static boost::intrusive_ptr<Expression> parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vps);
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
protected:
void _doAddDependencies(DepsTracker* deps) const final;
private:
ExpressionFilter(ExpressionContext* const expCtx,
std::string varName,
Variables::Id varId,
boost::intrusive_ptr<Expression> input,
boost::intrusive_ptr<Expression> filter);
// The name of the variable to set to each element in the array.
std::string _varName;
// The id of the variable to set.
Variables::Id _varId;
// The array to iterate over.
boost::intrusive_ptr<Expression>& _input;
// The expression determining whether each element should be present in the result array.
boost::intrusive_ptr<Expression>& _filter;
};
class ExpressionFloor final : public ExpressionSingleNumericArg<ExpressionFloor> {
public:
explicit ExpressionFloor(ExpressionContext* const expCtx)
: ExpressionSingleNumericArg<ExpressionFloor>(expCtx) {}
Value evaluateNumericArg(const Value& numericArg) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionHour final : public DateExpressionAcceptingTimeZone<ExpressionHour> {
public:
explicit ExpressionHour(ExpressionContext* const expCtx,
boost::intrusive_ptr<Expression> date,
boost::intrusive_ptr<Expression> timeZone = nullptr)
: DateExpressionAcceptingTimeZone<ExpressionHour>(
expCtx, "$hour", std::move(date), std::move(timeZone)) {}
Value evaluateDate(Date_t date, const TimeZone& timeZone) const final {
return Value(timeZone.dateParts(date).hour);
}
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionIfNull final : public ExpressionFixedArity<ExpressionIfNull, 2> {
public:
explicit ExpressionIfNull(ExpressionContext* const expCtx)
: ExpressionFixedArity<ExpressionIfNull, 2>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionIn final : public ExpressionFixedArity<ExpressionIn, 2> {
public:
explicit ExpressionIn(ExpressionContext* const expCtx)
: ExpressionFixedArity<ExpressionIn, 2>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionIndexOfArray : public ExpressionRangedArity<ExpressionIndexOfArray, 2, 4> {
public:
explicit ExpressionIndexOfArray(ExpressionContext* const expCtx)
: ExpressionRangedArity<ExpressionIndexOfArray, 2, 4>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const;
boost::intrusive_ptr<Expression> optimize() final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
protected:
struct Arguments {
Arguments(Value targetOfSearch, int startIndex, int endIndex)
: targetOfSearch(targetOfSearch), startIndex(startIndex), endIndex(endIndex) {}
Value targetOfSearch;
int startIndex;
int endIndex;
};
/**
* When given 'operands' which correspond to the arguments to $indexOfArray, evaluates and
* validates the target value, starting index, and ending index arguments and returns their
* values as a Arguments struct. The starting index and ending index are optional, so as default
* 'startIndex' will be 0 and 'endIndex' will be the length of the input array. Throws a
* UserException if the values are found to be invalid in some way, e.g. if the indexes are not
* numbers.
*/
Arguments evaluateAndValidateArguments(const Document& root,
const ExpressionVector& operands,
size_t arrayLength,
Variables* variables) const;
private:
class Optimized;
};
class ExpressionIndexOfBytes final : public ExpressionRangedArity<ExpressionIndexOfBytes, 2, 4> {
public:
explicit ExpressionIndexOfBytes(ExpressionContext* const expCtx)
: ExpressionRangedArity<ExpressionIndexOfBytes, 2, 4>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
/**
* Implements indexOf behavior for strings with UTF-8 encoding.
*/
class ExpressionIndexOfCP final : public ExpressionRangedArity<ExpressionIndexOfCP, 2, 4> {
public:
explicit ExpressionIndexOfCP(ExpressionContext* const expCtx)
: ExpressionRangedArity<ExpressionIndexOfCP, 2, 4>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionLet final : public Expression {
public:
boost::intrusive_ptr<Expression> optimize() final;
Value serialize(bool explain) const final;
Value evaluate(const Document& root, Variables* variables) const final;
static boost::intrusive_ptr<Expression> parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vps);
struct NameAndExpression {
std::string name;
boost::intrusive_ptr<Expression>& expression;
};
typedef std::map<Variables::Id, NameAndExpression> VariableMap;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
auto& getOrderedVariableIds() const {
return _orderedVariableIds;
}
auto& getVariableMap() const {
return _variables;
}
protected:
void _doAddDependencies(DepsTracker* deps) const final;
private:
ExpressionLet(ExpressionContext* const expCtx,
VariableMap&& vars,
std::vector<boost::intrusive_ptr<Expression>> children,
std::vector<Variables::Id> orderedVariableIds);
VariableMap _variables;
// These ids are ordered to match their corresponding _children expressions.
std::vector<Variables::Id> _orderedVariableIds;
// Reference to the last element in the '_children' list.
boost::intrusive_ptr<Expression>& _subExpression;
};
class ExpressionLn final : public ExpressionSingleNumericArg<ExpressionLn> {
public:
explicit ExpressionLn(ExpressionContext* const expCtx)
: ExpressionSingleNumericArg<ExpressionLn>(expCtx) {}
Value evaluateNumericArg(const Value& numericArg) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionLog final : public ExpressionFixedArity<ExpressionLog, 2> {
public:
explicit ExpressionLog(ExpressionContext* const expCtx)
: ExpressionFixedArity<ExpressionLog, 2>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionLog10 final : public ExpressionSingleNumericArg<ExpressionLog10> {
public:
explicit ExpressionLog10(ExpressionContext* const expCtx)
: ExpressionSingleNumericArg<ExpressionLog10>(expCtx) {}
Value evaluateNumericArg(const Value& numericArg) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionMap final : public Expression {
public:
boost::intrusive_ptr<Expression> optimize() final;
Value serialize(bool explain) const final;
Value evaluate(const Document& root, Variables* variables) const final;
static boost::intrusive_ptr<Expression> parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vps);
ComputedPaths getComputedPaths(const std::string& exprFieldPath,
Variables::Id renamingVar) const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
protected:
void _doAddDependencies(DepsTracker* deps) const final;
private:
ExpressionMap(
ExpressionContext* const expCtx,
const std::string& varName, // name of variable to set
Variables::Id varId, // id of variable to set
boost::intrusive_ptr<Expression> input, // yields array to iterate
boost::intrusive_ptr<Expression> each); // yields results to be added to output array
std::string _varName;
Variables::Id _varId;
boost::intrusive_ptr<Expression>& _input;
boost::intrusive_ptr<Expression>& _each;
};
class ExpressionMeta final : public Expression {
public:
Value serialize(bool explain) const final;
Value evaluate(const Document& root, Variables* variables) const final;
static boost::intrusive_ptr<Expression> parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vps);
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
DocumentMetadataFields::MetaType getMetaType() const {
return _metaType;
}
protected:
void _doAddDependencies(DepsTracker* deps) const final;
private:
ExpressionMeta(ExpressionContext* const expCtx, DocumentMetadataFields::MetaType metaType);
DocumentMetadataFields::MetaType _metaType;
};
class ExpressionMillisecond final : public DateExpressionAcceptingTimeZone<ExpressionMillisecond> {
public:
explicit ExpressionMillisecond(ExpressionContext* const expCtx,
boost::intrusive_ptr<Expression> date,
boost::intrusive_ptr<Expression> timeZone = nullptr)
: DateExpressionAcceptingTimeZone<ExpressionMillisecond>(
expCtx, "$millisecond", std::move(date), std::move(timeZone)) {}
Value evaluateDate(Date_t date, const TimeZone& timeZone) const final {
return Value(timeZone.dateParts(date).millisecond);
}
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionMinute final : public DateExpressionAcceptingTimeZone<ExpressionMinute> {
public:
explicit ExpressionMinute(ExpressionContext* const expCtx,
boost::intrusive_ptr<Expression> date,
boost::intrusive_ptr<Expression> timeZone = nullptr)
: DateExpressionAcceptingTimeZone<ExpressionMinute>(
expCtx, "$minute", std::move(date), std::move(timeZone)) {}
Value evaluateDate(Date_t date, const TimeZone& timeZone) const final {
return Value(timeZone.dateParts(date).minute);
}
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionMod final : public ExpressionFixedArity<ExpressionMod, 2> {
public:
explicit ExpressionMod(ExpressionContext* const expCtx)
: ExpressionFixedArity<ExpressionMod, 2>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionMultiply final : public ExpressionVariadic<ExpressionMultiply> {
public:
explicit ExpressionMultiply(ExpressionContext* const expCtx)
: ExpressionVariadic<ExpressionMultiply>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
bool isAssociative() const final {
return true;
}
bool isCommutative() const final {
return true;
}
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionMonth final : public DateExpressionAcceptingTimeZone<ExpressionMonth> {
public:
explicit ExpressionMonth(ExpressionContext* const expCtx,
boost::intrusive_ptr<Expression> date,
boost::intrusive_ptr<Expression> timeZone = nullptr)
: DateExpressionAcceptingTimeZone<ExpressionMonth>(
expCtx, "$month", std::move(date), std::move(timeZone)) {}
Value evaluateDate(Date_t date, const TimeZone& timeZone) const final {
return Value(timeZone.dateParts(date).month);
}
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionNot final : public ExpressionFixedArity<ExpressionNot, 1> {
public:
explicit ExpressionNot(ExpressionContext* const expCtx)
: ExpressionFixedArity<ExpressionNot, 1>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
/**
* This class is used to represent expressions that create object literals, such as the value of
* '_id' in this group stage:
* {$group: {
* _id: {b: "$a", c: {$add: [4, "$c"]}} <- This is represented as an ExpressionObject.
* ...
* }}
*/
class ExpressionObject final : public Expression {
public:
boost::intrusive_ptr<Expression> optimize() final;
Value evaluate(const Document& root, Variables* variables) const final;
Value serialize(bool explain) const final;
static boost::intrusive_ptr<ExpressionObject> create(
ExpressionContext* const expCtx,
std::vector<std::pair<std::string, boost::intrusive_ptr<Expression>>>&&
expressionsWithChildrenInPlace);
/**
* Parses and constructs an ExpressionObject from 'obj'.
*/
static boost::intrusive_ptr<ExpressionObject> parse(ExpressionContext* const expCtx,
BSONObj obj,
const VariablesParseState& vps);
/**
* This ExpressionObject must outlive the returned vector.
*/
const auto& getChildExpressions() const {
return _expressions;
}
ComputedPaths getComputedPaths(const std::string& exprFieldPath,
Variables::Id renamingVar) const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
protected:
void _doAddDependencies(DepsTracker* deps) const final;
private:
ExpressionObject(
ExpressionContext* const expCtx,
std::vector<boost::intrusive_ptr<Expression>> children,
std::vector<std::pair<std::string, boost::intrusive_ptr<Expression>&>>&& expressions);
// The mapping from field name to expression within this object. This needs to respect the order
// in which the fields were specified in the input BSON.
std::vector<std::pair<std::string, boost::intrusive_ptr<Expression>&>> _expressions;
};
class ExpressionOr final : public ExpressionVariadic<ExpressionOr> {
public:
explicit ExpressionOr(ExpressionContext* const expCtx)
: ExpressionVariadic<ExpressionOr>(expCtx) {}
boost::intrusive_ptr<Expression> optimize() final;
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
bool isAssociative() const final {
return true;
}
bool isCommutative() const final {
return true;
}
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionPow final : public ExpressionFixedArity<ExpressionPow, 2> {
public:
explicit ExpressionPow(ExpressionContext* const expCtx)
: ExpressionFixedArity<ExpressionPow, 2>(expCtx) {}
static boost::intrusive_ptr<Expression> create(ExpressionContext* const expCtx,
Value base,
Value exp);
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
private:
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
};
class ExpressionRange final : public ExpressionRangedArity<ExpressionRange, 2, 3> {
public:
explicit ExpressionRange(ExpressionContext* const expCtx)
: ExpressionRangedArity<ExpressionRange, 2, 3>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionReduce final : public Expression {
public:
ExpressionReduce(ExpressionContext* const expCtx,
boost::intrusive_ptr<Expression> input,
boost::intrusive_ptr<Expression> initial,
boost::intrusive_ptr<Expression> in,
Variables::Id thisVar,
Variables::Id valueVar)
: Expression(expCtx, {std::move(input), std::move(initial), std::move(in)}),
_input(_children[0]),
_initial(_children[1]),
_in(_children[2]),
_thisVar(thisVar),
_valueVar(valueVar) {}
Value evaluate(const Document& root, Variables* variables) const final;
boost::intrusive_ptr<Expression> optimize() final;
static boost::intrusive_ptr<Expression> parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vps);
Value serialize(bool explain) const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
protected:
void _doAddDependencies(DepsTracker* deps) const final;
private:
boost::intrusive_ptr<Expression>& _input;
boost::intrusive_ptr<Expression>& _initial;
boost::intrusive_ptr<Expression>& _in;
Variables::Id _thisVar;
Variables::Id _valueVar;
};
class ExpressionReplaceBase : public Expression {
public:
ExpressionReplaceBase(ExpressionContext* const expCtx,
boost::intrusive_ptr<Expression> input,
boost::intrusive_ptr<Expression> find,
boost::intrusive_ptr<Expression> replacement)
: Expression(expCtx, {std::move(input), std::move(find), std::move(replacement)}),
_input(_children[0]),
_find(_children[1]),
_replacement(_children[2]) {}
virtual const char* getOpName() const = 0;
Value evaluate(const Document& root, Variables* variables) const final;
boost::intrusive_ptr<Expression> optimize() final;
Value serialize(bool explain) const final;
protected:
void _doAddDependencies(DepsTracker* deps) const final;
virtual Value _doEval(StringData input, StringData find, StringData replacement) const = 0;
// These are owned by this->Expression::_children. They are references to intrusive_ptr instead
// of direct references to Expression because we need to be able to replace each child in
// optimize() without invalidating the references.
boost::intrusive_ptr<Expression>& _input;
boost::intrusive_ptr<Expression>& _find;
boost::intrusive_ptr<Expression>& _replacement;
};
class ExpressionReplaceOne final : public ExpressionReplaceBase {
public:
using ExpressionReplaceBase::ExpressionReplaceBase;
static boost::intrusive_ptr<Expression> parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vps);
static constexpr const char* const opName = "$replaceOne";
const char* getOpName() const final {
return opName;
}
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
protected:
Value _doEval(StringData input, StringData find, StringData replacement) const final;
};
class ExpressionReplaceAll final : public ExpressionReplaceBase {
public:
using ExpressionReplaceBase::ExpressionReplaceBase;
static boost::intrusive_ptr<Expression> parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vps);
static constexpr const char* const opName = "$replaceAll";
const char* getOpName() const final {
return opName;
}
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
protected:
Value _doEval(StringData input, StringData find, StringData replacement) const final;
};
class ExpressionSecond final : public DateExpressionAcceptingTimeZone<ExpressionSecond> {
public:
ExpressionSecond(ExpressionContext* const expCtx,
boost::intrusive_ptr<Expression> date,
boost::intrusive_ptr<Expression> timeZone = nullptr)
: DateExpressionAcceptingTimeZone<ExpressionSecond>(
expCtx, "$second", std::move(date), std::move(timeZone)) {}
Value evaluateDate(Date_t date, const TimeZone& timeZone) const final {
return Value(timeZone.dateParts(date).second);
}
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionSetDifference final : public ExpressionFixedArity<ExpressionSetDifference, 2> {
public:
explicit ExpressionSetDifference(ExpressionContext* const expCtx)
: ExpressionFixedArity<ExpressionSetDifference, 2>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionSetEquals final : public ExpressionVariadic<ExpressionSetEquals> {
public:
explicit ExpressionSetEquals(ExpressionContext* const expCtx)
: ExpressionVariadic<ExpressionSetEquals>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
void validateArguments(const ExpressionVector& args) const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionSetIntersection final : public ExpressionVariadic<ExpressionSetIntersection> {
public:
explicit ExpressionSetIntersection(ExpressionContext* const expCtx)
: ExpressionVariadic<ExpressionSetIntersection>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
bool isAssociative() const final {
return true;
}
bool isCommutative() const final {
return true;
}
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
// Not final, inherited from for optimizations.
class ExpressionSetIsSubset : public ExpressionFixedArity<ExpressionSetIsSubset, 2> {
public:
explicit ExpressionSetIsSubset(ExpressionContext* const expCtx)
: ExpressionFixedArity<ExpressionSetIsSubset, 2>(expCtx) {}
boost::intrusive_ptr<Expression> optimize() override;
Value evaluate(const Document& root, Variables* variables) const override;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
private:
class Optimized;
};
class ExpressionSetUnion final : public ExpressionVariadic<ExpressionSetUnion> {
public:
explicit ExpressionSetUnion(ExpressionContext* const expCtx)
: ExpressionVariadic<ExpressionSetUnion>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
bool isAssociative() const final {
return true;
}
bool isCommutative() const final {
return true;
}
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionSize final : public ExpressionFixedArity<ExpressionSize, 1> {
public:
explicit ExpressionSize(ExpressionContext* const expCtx)
: ExpressionFixedArity<ExpressionSize, 1>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionReverseArray final : public ExpressionFixedArity<ExpressionReverseArray, 1> {
public:
explicit ExpressionReverseArray(ExpressionContext* const expCtx)
: ExpressionFixedArity<ExpressionReverseArray, 1>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionSlice final : public ExpressionRangedArity<ExpressionSlice, 2, 3> {
public:
explicit ExpressionSlice(ExpressionContext* const expCtx)
: ExpressionRangedArity<ExpressionSlice, 2, 3>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionIsArray final : public ExpressionFixedArity<ExpressionIsArray, 1> {
public:
explicit ExpressionIsArray(ExpressionContext* const expCtx)
: ExpressionFixedArity<ExpressionIsArray, 1>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionRound final : public ExpressionRangedArity<ExpressionRound, 1, 2> {
public:
explicit ExpressionRound(ExpressionContext* const expCtx)
: ExpressionRangedArity<ExpressionRound, 1, 2>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionSplit final : public ExpressionFixedArity<ExpressionSplit, 2> {
public:
explicit ExpressionSplit(ExpressionContext* const expCtx)
: ExpressionFixedArity<ExpressionSplit, 2>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionSqrt final : public ExpressionSingleNumericArg<ExpressionSqrt> {
public:
explicit ExpressionSqrt(ExpressionContext* const expCtx)
: ExpressionSingleNumericArg<ExpressionSqrt>(expCtx) {}
Value evaluateNumericArg(const Value& numericArg) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionStrcasecmp final : public ExpressionFixedArity<ExpressionStrcasecmp, 2> {
public:
explicit ExpressionStrcasecmp(ExpressionContext* const expCtx)
: ExpressionFixedArity<ExpressionStrcasecmp, 2>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionSubstrBytes final : public ExpressionFixedArity<ExpressionSubstrBytes, 3> {
public:
explicit ExpressionSubstrBytes(ExpressionContext* const expCtx)
: ExpressionFixedArity<ExpressionSubstrBytes, 3>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionSubstrCP final : public ExpressionFixedArity<ExpressionSubstrCP, 3> {
public:
explicit ExpressionSubstrCP(ExpressionContext* const expCtx)
: ExpressionFixedArity<ExpressionSubstrCP, 3>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionStrLenBytes final : public ExpressionFixedArity<ExpressionStrLenBytes, 1> {
public:
explicit ExpressionStrLenBytes(ExpressionContext* const expCtx)
: ExpressionFixedArity<ExpressionStrLenBytes, 1>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionBinarySize final : public ExpressionFixedArity<ExpressionBinarySize, 1> {
public:
ExpressionBinarySize(ExpressionContext* const expCtx)
: ExpressionFixedArity<ExpressionBinarySize, 1>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionStrLenCP final : public ExpressionFixedArity<ExpressionStrLenCP, 1> {
public:
explicit ExpressionStrLenCP(ExpressionContext* const expCtx)
: ExpressionFixedArity<ExpressionStrLenCP, 1>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionSubtract final : public ExpressionFixedArity<ExpressionSubtract, 2> {
public:
explicit ExpressionSubtract(ExpressionContext* const expCtx)
: ExpressionFixedArity<ExpressionSubtract, 2>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionSwitch final : public Expression {
public:
using ExpressionPair =
std::pair<boost::intrusive_ptr<Expression>&, boost::intrusive_ptr<Expression>&>;
ExpressionSwitch(ExpressionContext* const expCtx,
std::vector<boost::intrusive_ptr<Expression>> children,
std::vector<ExpressionPair> branches)
: Expression(expCtx, std::move(children)),
_default(_children.back()),
_branches(std::move(branches)) {}
Value evaluate(const Document& root, Variables* variables) const final;
boost::intrusive_ptr<Expression> optimize() final;
static boost::intrusive_ptr<Expression> parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vpsIn);
Value serialize(bool explain) const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
protected:
void _doAddDependencies(DepsTracker* deps) const final;
private:
boost::intrusive_ptr<Expression>& _default;
std::vector<ExpressionPair> _branches;
};
class ExpressionToLower final : public ExpressionFixedArity<ExpressionToLower, 1> {
public:
explicit ExpressionToLower(ExpressionContext* const expCtx)
: ExpressionFixedArity<ExpressionToLower, 1>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionToUpper final : public ExpressionFixedArity<ExpressionToUpper, 1> {
public:
explicit ExpressionToUpper(ExpressionContext* const expCtx)
: ExpressionFixedArity<ExpressionToUpper, 1>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
/**
* This class is used to implement all three trim expressions: $trim, $ltrim, and $rtrim.
*/
class ExpressionTrim final : public Expression {
private:
enum class TrimType {
kBoth,
kLeft,
kRight,
};
public:
ExpressionTrim(ExpressionContext* const expCtx,
TrimType trimType,
StringData name,
boost::intrusive_ptr<Expression> input,
boost::intrusive_ptr<Expression> charactersToTrim)
: Expression(expCtx, {std::move(input), std::move(charactersToTrim)}),
_trimType(trimType),
_name(name.toString()),
_input(_children[0]),
_characters(_children[1]) {}
Value evaluate(const Document& root, Variables* variables) const final;
boost::intrusive_ptr<Expression> optimize() final;
static boost::intrusive_ptr<Expression> parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vpsIn);
Value serialize(bool explain) const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
protected:
void _doAddDependencies(DepsTracker* deps) const final;
private:
/**
* Returns true if the unicode character found at index 'indexIntoInput' of 'input' is equal to
* 'testCP'.
*/
static bool codePointMatchesAtIndex(const StringData& input,
std::size_t indexIntoInput,
const StringData& testCP);
/**
* Given the input string and the code points to trim from that string, returns a substring of
* 'input' with any code point from 'trimCPs' trimmed from the left.
*/
static StringData trimFromLeft(StringData input, const std::vector<StringData>& trimCPs);
/**
* Given the input string and the code points to trim from that string, returns a substring of
* 'input' with any code point from 'trimCPs' trimmed from the right.
*/
static StringData trimFromRight(StringData input, const std::vector<StringData>& trimCPs);
/**
* Returns the trimmed version of 'input', with all code points in 'trimCPs' removed from the
* front, back, or both - depending on _trimType.
*/
StringData doTrim(StringData input, const std::vector<StringData>& trimCPs) const;
TrimType _trimType;
std::string _name; // "$trim", "$ltrim", or "$rtrim".
boost::intrusive_ptr<Expression>& _input;
boost::intrusive_ptr<Expression>& _characters; // Optional, null if not specified.
};
class ExpressionTrunc final : public ExpressionRangedArity<ExpressionTrunc, 1, 2> {
public:
explicit ExpressionTrunc(ExpressionContext* const expCtx)
: ExpressionRangedArity<ExpressionTrunc, 1, 2>(expCtx) {}
static boost::intrusive_ptr<Expression> parse(ExpressionContext* const expCtx,
BSONElement elem,
const VariablesParseState& vps);
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionType final : public ExpressionFixedArity<ExpressionType, 1> {
public:
explicit ExpressionType(ExpressionContext* const expCtx)
: ExpressionFixedArity<ExpressionType, 1>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionIsNumber final : public ExpressionFixedArity<ExpressionIsNumber, 1> {
public:
explicit ExpressionIsNumber(ExpressionContext* const expCtx)
: ExpressionFixedArity<ExpressionIsNumber, 1>(expCtx) {}
Value evaluate(const Document& root, Variables* variables) const final;
const char* getOpName() const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionWeek final : public DateExpressionAcceptingTimeZone<ExpressionWeek> {
public:
ExpressionWeek(ExpressionContext* const expCtx,
boost::intrusive_ptr<Expression> date,
boost::intrusive_ptr<Expression> timeZone = nullptr)
: DateExpressionAcceptingTimeZone<ExpressionWeek>(
expCtx, "$week", std::move(date), std::move(timeZone)) {}
Value evaluateDate(Date_t date, const TimeZone& timeZone) const final {
return Value(timeZone.week(date));
}
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionIsoWeekYear final : public DateExpressionAcceptingTimeZone<ExpressionIsoWeekYear> {
public:
explicit ExpressionIsoWeekYear(ExpressionContext* const expCtx,
boost::intrusive_ptr<Expression> date,
boost::intrusive_ptr<Expression> timeZone = nullptr)
: DateExpressionAcceptingTimeZone<ExpressionIsoWeekYear>(
expCtx, "$isoWeekYear", std::move(date), std::move(timeZone)) {}
Value evaluateDate(Date_t date, const TimeZone& timeZone) const final {
return Value(timeZone.isoYear(date));
}
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionIsoDayOfWeek final
: public DateExpressionAcceptingTimeZone<ExpressionIsoDayOfWeek> {
public:
ExpressionIsoDayOfWeek(ExpressionContext* const expCtx,
boost::intrusive_ptr<Expression> date,
boost::intrusive_ptr<Expression> timeZone = nullptr)
: DateExpressionAcceptingTimeZone<ExpressionIsoDayOfWeek>(
expCtx, "$isoDayOfWeek", std::move(date), std::move(timeZone)) {}
Value evaluateDate(Date_t date, const TimeZone& timeZone) const final {
return Value(timeZone.isoDayOfWeek(date));
}
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionIsoWeek final : public DateExpressionAcceptingTimeZone<ExpressionIsoWeek> {
public:
ExpressionIsoWeek(ExpressionContext* const expCtx,
boost::intrusive_ptr<Expression> date,
boost::intrusive_ptr<Expression> timeZone = nullptr)
: DateExpressionAcceptingTimeZone<ExpressionIsoWeek>(
expCtx, "$isoWeek", std::move(date), std::move(timeZone)) {}
Value evaluateDate(Date_t date, const TimeZone& timeZone) const final {
return Value(timeZone.isoWeek(date));
}
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionYear final : public DateExpressionAcceptingTimeZone<ExpressionYear> {
public:
ExpressionYear(ExpressionContext* const expCtx,
boost::intrusive_ptr<Expression> date,
boost::intrusive_ptr<Expression> timeZone = nullptr)
: DateExpressionAcceptingTimeZone<ExpressionYear>(
expCtx, "$year", std::move(date), std::move(timeZone)) {}
Value evaluateDate(Date_t date, const TimeZone& timeZone) const final {
return Value(timeZone.dateParts(date).year);
}
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
};
class ExpressionZip final : public Expression {
public:
ExpressionZip(ExpressionContext* const expCtx,
bool useLongestLength,
std::vector<boost::intrusive_ptr<Expression>> children,
std::vector<std::reference_wrapper<boost::intrusive_ptr<Expression>>> inputs,
std::vector<std::reference_wrapper<boost::intrusive_ptr<Expression>>> defaults)
: Expression(expCtx, std::move(children)),
_useLongestLength(useLongestLength),
_inputs(std::move(inputs)),
_defaults(std::move(defaults)) {}
Value evaluate(const Document& root, Variables* variables) const final;
boost::intrusive_ptr<Expression> optimize() final;
static boost::intrusive_ptr<Expression> parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vpsIn);
Value serialize(bool explain) const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
protected:
void _doAddDependencies(DepsTracker* deps) const final;
private:
bool _useLongestLength;
std::vector<std::reference_wrapper<boost::intrusive_ptr<Expression>>> _inputs;
std::vector<std::reference_wrapper<boost::intrusive_ptr<Expression>>> _defaults;
};
class ExpressionConvert final : public Expression {
public:
/**
* Creates a $convert expression converting from 'input' to the type given by 'toType'. Leaves
* 'onNull' and 'onError' unspecified.
*/
static boost::intrusive_ptr<Expression> create(ExpressionContext* const,
boost::intrusive_ptr<Expression> input,
BSONType toType);
static boost::intrusive_ptr<Expression> parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vpsIn);
Value evaluate(const Document& root, Variables* variables) const final;
boost::intrusive_ptr<Expression> optimize() final;
Value serialize(bool explain) const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
protected:
void _doAddDependencies(DepsTracker* deps) const final;
private:
ExpressionConvert(ExpressionContext* const,
boost::intrusive_ptr<Expression> input,
boost::intrusive_ptr<Expression> to,
boost::intrusive_ptr<Expression> onError,
boost::intrusive_ptr<Expression> onNull);
BSONType computeTargetType(Value typeName) const;
Value performConversion(BSONType targetType, Value inputValue) const;
boost::intrusive_ptr<Expression>& _input;
boost::intrusive_ptr<Expression>& _to;
boost::intrusive_ptr<Expression>& _onError;
boost::intrusive_ptr<Expression>& _onNull;
};
class ExpressionRegex : public Expression {
public:
/**
* Object to hold data that is required when calling 'execute()' or 'nextMatch()'.
*/
struct RegexExecutionState {
/**
* The regex pattern, options, and captures buffer for the current execution context.
*/
boost::optional<std::string> pattern;
boost::optional<std::string> options;
std::vector<int> capturesBuffer;
int numCaptures = 0;
/**
* If 'regex' is constant, 'pcrePtr' will be shared between the active RegexExecutionState
* and '_initialExecStateForConstantRegex'. If not, then the active RegexExecutionState is
* the sole owner.
*/
std::shared_ptr<pcre> pcrePtr;
/**
* The input text and starting position for the current execution context.
*/
boost::optional<std::string> input;
int startCodePointPos = 0;
int startBytePos = 0;
/**
* If either the text input or regex pattern is nullish, then we consider the operation as a
* whole nullish.
*/
bool nullish() {
return !input || !pattern;
}
};
/**
* Validates the structure of input passed in 'inputExpr'. If valid, generates an initial
* execution state. This returned object can later be used for calling execute() or nextMatch().
*/
RegexExecutionState buildInitialState(const Document& root, Variables* variables) const;
/**
* Checks if there is a match for the given input and pattern that are part of 'executionState'.
* The method will return a positive number if there is a match and '-1' if there is no match.
* Throws 'uassert()' for any errors.
*/
int execute(RegexExecutionState* executionState) const;
/**
* Finds the next possible match for the given input and pattern that are part of
* 'executionState'. If there is a match, the function will return a 'Value' object
* encapsulating the matched string, the code point index of the matched string and a vector
* representing all the captured substrings. The function will also update the parameters
* 'startBytePos' and 'startCodePointPos' to the corresponding new indices. If there is no
* match, the function will return null 'Value' object.
*/
Value nextMatch(RegexExecutionState* executionState) const;
/**
* Optimizes '$regex*' expressions. If the expression has constant 'regex' and 'options' fields,
* then it can be optimized. Stores the optimized regex in '_initialExecStateForConstantRegex'
* so that it can be reused during expression evaluation.
*/
boost::intrusive_ptr<Expression> optimize();
bool hasConstantRegex() const {
return _initialExecStateForConstantRegex.has_value();
}
Value serialize(bool explain) const;
const std::string& getOpName() const {
return _opName;
}
ExpressionRegex(ExpressionContext* const expCtx,
boost::intrusive_ptr<Expression> input,
boost::intrusive_ptr<Expression> regex,
boost::intrusive_ptr<Expression> options,
const StringData opName)
: Expression(expCtx, {std::move(input), std::move(regex), std::move(options)}),
_input(_children[0]),
_regex(_children[1]),
_options(_children[2]),
_opName(opName) {}
private:
void _extractInputField(RegexExecutionState* executionState, const Value& textInput) const;
void _extractRegexAndOptions(RegexExecutionState* executionState,
const Value& regexPattern,
const Value& regexOptions) const;
void _compile(RegexExecutionState* executionState) const;
void _doAddDependencies(DepsTracker* deps) const final;
/**
* Expressions which, when evaluated for a given document, produce the the regex pattern, the
* regex option flags, and the input text to which the regex should be applied.
*/
boost::intrusive_ptr<Expression>& _input;
boost::intrusive_ptr<Expression>& _regex;
boost::intrusive_ptr<Expression>& _options;
/**
* This variable will be set when the $regex* expressions have constant values for their 'regex'
* and 'options' fields, allowing us to pre-compile the regex and re-use it across the
* Expression's lifetime.
*/
boost::optional<RegexExecutionState> _initialExecStateForConstantRegex;
/**
* Name of the regex expression.
*/
std::string _opName;
};
class ExpressionRegexFind final : public ExpressionRegex {
public:
static boost::intrusive_ptr<Expression> parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vpsIn);
Value evaluate(const Document& root, Variables* variables) const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
using ExpressionRegex::ExpressionRegex;
};
class ExpressionRegexFindAll final : public ExpressionRegex {
public:
static boost::intrusive_ptr<Expression> parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vpsIn);
Value evaluate(const Document& root, Variables* variables) const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
using ExpressionRegex::ExpressionRegex;
};
class ExpressionRegexMatch final : public ExpressionRegex {
public:
static boost::intrusive_ptr<Expression> parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vpsIn);
Value evaluate(const Document& root, Variables* variables) const final;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
using ExpressionRegex::ExpressionRegex;
};
/**
* Returns a double-valued random number from 0.0 to 1.0.
*/
class ExpressionRandom final : public Expression {
static constexpr double kMinValue = 0.0;
static constexpr double kMaxValue = 1.0;
public:
static boost::intrusive_ptr<Expression> parse(ExpressionContext* const expCtx,
BSONElement exprElement,
const VariablesParseState& vps);
Value serialize(const bool explain) const final;
Value evaluate(const Document& root, Variables* variables) const final;
boost::intrusive_ptr<Expression> optimize() final;
const char* getOpName() const;
void acceptVisitor(ExpressionVisitor* visitor) final {
return visitor->visit(this);
}
protected:
void _doAddDependencies(DepsTracker* deps) const final override;
private:
explicit ExpressionRandom(ExpressionContext* const expCtx);
double getRandomValue() const;
};
} // namespace mongo
|