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
|
/**
* 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.
*/
#include "mongo/platform/basic.h"
#include "mongo/db/catalog/index_catalog_impl.h"
#include <vector>
#include "mongo/base/init.h"
#include "mongo/bson/simple_bsonelement_comparator.h"
#include "mongo/bson/simple_bsonobj_comparator.h"
#include "mongo/db/audit.h"
#include "mongo/db/catalog/clustered_collection_util.h"
#include "mongo/db/catalog/collection.h"
#include "mongo/db/catalog/index_build_block.h"
#include "mongo/db/catalog/index_catalog_entry_impl.h"
#include "mongo/db/catalog/index_key_validate.h"
#include "mongo/db/catalog/uncommitted_catalog_updates.h"
#include "mongo/db/client.h"
#include "mongo/db/clientcursor.h"
#include "mongo/db/curop.h"
#include "mongo/db/field_ref.h"
#include "mongo/db/fts/fts_spec.h"
#include "mongo/db/index/index_access_method.h"
#include "mongo/db/index/index_descriptor.h"
#include "mongo/db/index/s2_access_method.h"
#include "mongo/db/index/s2_bucket_access_method.h"
#include "mongo/db/index_names.h"
#include "mongo/db/jsobj.h"
#include "mongo/db/keypattern.h"
#include "mongo/db/matcher/expression.h"
#include "mongo/db/multi_key_path_tracker.h"
#include "mongo/db/operation_context.h"
#include "mongo/db/ops/delete.h"
#include "mongo/db/query/collation/collation_spec.h"
#include "mongo/db/query/collation/collator_factory_interface.h"
#include "mongo/db/query/collection_index_usage_tracker_decoration.h"
#include "mongo/db/query/collection_query_info.h"
#include "mongo/db/query/internal_plans.h"
#include "mongo/db/query/query_feature_flags_gen.h"
#include "mongo/db/query/query_knobs_gen.h"
#include "mongo/db/repl/replication_coordinator.h"
#include "mongo/db/repl_set_member_in_standalone_mode.h"
#include "mongo/db/server_options.h"
#include "mongo/db/service_context.h"
#include "mongo/db/storage/durable_catalog.h"
#include "mongo/db/storage/execution_context.h"
#include "mongo/db/storage/historical_ident_tracker.h"
#include "mongo/db/storage/kv/kv_engine.h"
#include "mongo/db/storage/storage_engine_init.h"
#include "mongo/db/storage/storage_parameters_gen.h"
#include "mongo/db/storage/storage_util.h"
#include "mongo/db/ttl_collection_cache.h"
#include "mongo/db/vector_clock.h"
#include "mongo/logv2/log.h"
#include "mongo/util/assert_util.h"
#include "mongo/util/fail_point.h"
#include "mongo/util/represent_as.h"
#include "mongo/util/str.h"
#define MONGO_LOGV2_DEFAULT_COMPONENT ::mongo::logv2::LogComponent::kIndex
namespace mongo {
MONGO_FAIL_POINT_DEFINE(skipUnindexingDocumentWhenDeleted);
MONGO_FAIL_POINT_DEFINE(skipIndexNewRecords);
// This failpoint causes the check for TTL indexes on capped collections to be ignored.
MONGO_FAIL_POINT_DEFINE(ignoreTTLIndexCappedCollectionCheck);
using std::string;
using std::unique_ptr;
using std::vector;
using IndexVersion = IndexDescriptor::IndexVersion;
const BSONObj IndexCatalogImpl::_idObj = BSON("_id" << 1);
namespace {
/**
* Similar to _isSpecOK(), checks if the indexSpec is valid, conflicts, or already exists as a
* clustered index.
*
* Returns Status::OK() if no clustered index exists or the 'indexSpec' does not conflict with it.
* Returns ErrorCodes::IndexAlreadyExists if the 'indexSpec' already exists as the clustered index.
* Returns an error if the indexSpec fields conflict with the clustered index.
*/
Status isSpecOKClusteredIndexCheck(const BSONObj& indexSpec,
const boost::optional<ClusteredCollectionInfo>& collInfo) {
auto key = indexSpec.getObjectField("key");
bool keysMatch = clustered_util::matchesClusterKey(key, collInfo);
bool clusteredOptionPresent =
indexSpec.hasField("clustered") && indexSpec["clustered"].trueValue();
if (clusteredOptionPresent && !keysMatch) {
// The 'clustered' option implies the indexSpec must match the clustered index.
return Status(ErrorCodes::Error(6243700),
"Cannot create index with option 'clustered' that does not match an existing "
"clustered index");
}
auto name = indexSpec.getStringField("name");
bool namesMatch =
!collInfo.is_initialized() || collInfo->getIndexSpec().getName().get() == name;
if (!keysMatch && !namesMatch) {
// The indexes don't conflict at all.
return Status::OK();
}
if (!collInfo) {
return Status(ErrorCodes::Error(6479600),
str::stream() << "Cannot create an index with 'clustered' in the spec on a "
<< "collection that is not clustered");
}
// The collection is guaranteed to be clustered since at least the name or key matches a
// clustered index.
auto clusteredIndexSpec = collInfo->getIndexSpec();
if (namesMatch && !keysMatch) {
// Prohibit creating an index with the same 'name' as the cluster key but different key
// pattern.
return Status(ErrorCodes::Error(6100906),
str::stream() << "Cannot create an index where the name matches the "
"clusteredIndex but the key does not -"
<< " indexSpec: " << indexSpec
<< ", clusteredIndex: " << collInfo->getIndexSpec().toBSON());
}
// Users should be able to call createIndexes on the cluster key. If a name isn't specified, a
// default one is generated. Silently ignore mismatched names.
BSONElement vElt = indexSpec["v"];
auto version = representAs<int>(vElt.number());
if (clusteredIndexSpec.getV() != version) {
return Status(ErrorCodes::Error(6100908),
"Cannot create an index with the same key pattern as the collection's "
"clusteredIndex but a different 'v' field");
}
if (indexSpec.hasField("unique") && indexSpec.getBoolField("unique") == false) {
return Status(ErrorCodes::Error(6100909),
"Cannot create an index with the same key pattern as the collection's "
"clusteredIndex but a different 'unique' field");
}
// The indexSpec matches the clustered index, which already exists implicitly.
return Status(ErrorCodes::IndexAlreadyExists,
"The index already exists implicitly as the collection's clustered index");
};
} // namespace
// -------------
std::unique_ptr<IndexCatalog> IndexCatalogImpl::clone() const {
return std::make_unique<IndexCatalogImpl>(*this);
}
Status IndexCatalogImpl::init(OperationContext* opCtx, Collection* collection) {
vector<string> indexNames;
collection->getAllIndexes(&indexNames);
const bool replSetMemberInStandaloneMode =
getReplSetMemberInStandaloneMode(opCtx->getServiceContext());
boost::optional<Timestamp> recoveryTs = boost::none;
if (auto storageEngine = opCtx->getServiceContext()->getStorageEngine();
storageEngine->supportsRecoveryTimestamp()) {
recoveryTs = storageEngine->getRecoveryTimestamp();
}
for (size_t i = 0; i < indexNames.size(); i++) {
const string& indexName = indexNames[i];
BSONObj spec = collection->getIndexSpec(indexName).getOwned();
BSONObj keyPattern = spec.getObjectField("key");
auto descriptor = std::make_unique<IndexDescriptor>(_getAccessMethodName(keyPattern), spec);
// TTL indexes are not compatible with capped collections.
// Note that TTL deletion is supported on capped clustered collections via bounded
// collection scan, which does not use an index.
if (spec.hasField(IndexDescriptor::kExpireAfterSecondsFieldName) &&
!collection->isCapped()) {
TTLCollectionCache::get(opCtx->getServiceContext())
.registerTTLInfo(collection->uuid(), indexName);
}
bool ready = collection->isIndexReady(indexName);
if (!ready) {
auto buildUUID = collection->getIndexBuildUUID(indexName);
invariant(buildUUID,
str::stream() << "collection: " << collection->ns() << "index:" << indexName);
// We intentionally do not drop or rebuild unfinished two-phase index builds before
// initializing the IndexCatalog when starting a replica set member in standalone mode.
// This is because the index build cannot complete until it receives a replicated commit
// or abort oplog entry.
if (replSetMemberInStandaloneMode) {
// Indicate that this index is "frozen". It is not ready but is not currently in
// progress either. These indexes may be dropped.
auto flags = CreateIndexEntryFlags::kInitFromDisk | CreateIndexEntryFlags::kFrozen;
IndexCatalogEntry* entry =
createIndexEntry(opCtx, collection, std::move(descriptor), flags);
fassert(31433, !entry->isReady(opCtx));
} else {
// Initializing with unfinished indexes may occur during rollback or startup.
auto flags = CreateIndexEntryFlags::kInitFromDisk;
IndexCatalogEntry* entry =
createIndexEntry(opCtx, collection, std::move(descriptor), flags);
fassert(4505500, !entry->isReady(opCtx));
}
} else {
auto flags = CreateIndexEntryFlags::kInitFromDisk | CreateIndexEntryFlags::kIsReady;
IndexCatalogEntry* entry =
createIndexEntry(opCtx, collection, std::move(descriptor), flags);
fassert(17340, entry->isReady(opCtx));
// When initializing indexes from disk, we conservatively set the minimumVisibleSnapshot
// to non _id indexes to the recovery timestamp. The _id index is left visible. It's
// assumed if the collection is visible, it's _id is valid to be used.
if (recoveryTs && !entry->descriptor()->isIdIndex()) {
entry->setMinimumVisibleSnapshot(recoveryTs.get());
}
}
}
CollectionQueryInfo::get(collection).init(opCtx, collection);
return Status::OK();
}
std::unique_ptr<IndexCatalog::IndexIterator> IndexCatalogImpl::getIndexIterator(
OperationContext* const opCtx, InclusionPolicy inclusionPolicy) const {
if (inclusionPolicy == InclusionPolicy::kReady) {
// If the caller only wants the ready indexes, we return an iterator over the catalog's
// ready indexes vector. When the user advances this iterator, it will filter out any
// indexes that were not ready at the OperationContext's read timestamp.
return std::make_unique<ReadyIndexesIterator>(
opCtx, _readyIndexes.begin(), _readyIndexes.end());
}
// If the caller doesn't only want the ready indexes, for simplicity of implementation, we copy
// the pointers to a new vector. The vector's ownership is passed to the iterator. The query
// code path from an external client is not expected to hit this case so the cost isn't paid by
// the important code path.
auto allIndexes = std::make_unique<std::vector<IndexCatalogEntry*>>();
if (inclusionPolicy & InclusionPolicy::kReady) {
for (auto it = _readyIndexes.begin(); it != _readyIndexes.end(); ++it) {
allIndexes->push_back(it->get());
}
}
if (inclusionPolicy & InclusionPolicy::kUnfinished) {
for (auto it = _buildingIndexes.begin(); it != _buildingIndexes.end(); ++it) {
allIndexes->push_back(it->get());
}
}
if (inclusionPolicy & InclusionPolicy::kFrozen) {
for (auto it = _frozenIndexes.begin(); it != _frozenIndexes.end(); ++it) {
allIndexes->push_back(it->get());
}
}
return std::make_unique<AllIndexesIterator>(opCtx, std::move(allIndexes));
}
string IndexCatalogImpl::_getAccessMethodName(const BSONObj& keyPattern) const {
string pluginName = IndexNames::findPluginName(keyPattern);
// This assert will be triggered when downgrading from a future version that
// supports an index plugin unsupported by this version.
uassert(17197,
str::stream() << "Invalid index type '" << pluginName << "' "
<< "in index " << keyPattern,
IndexNames::isKnownName(pluginName));
return pluginName;
}
// ---------------------------
StatusWith<BSONObj> IndexCatalogImpl::_validateAndFixIndexSpec(OperationContext* opCtx,
const CollectionPtr& collection,
const BSONObj& original) const {
Status status = _isSpecOk(opCtx, collection, original);
if (!status.isOK()) {
return status;
}
auto swFixed = _fixIndexSpec(opCtx, collection, original);
if (!swFixed.isOK()) {
return swFixed;
}
// we double check with new index spec
status = _isSpecOk(opCtx, collection, swFixed.getValue());
if (!status.isOK()) {
return status;
}
return swFixed;
}
Status IndexCatalogImpl::_isNonIDIndexAndNotAllowedToBuild(OperationContext* opCtx,
const BSONObj& spec) const {
const BSONObj key = spec.getObjectField("key");
invariant(!key.isEmpty());
if (!IndexDescriptor::isIdIndexPattern(key)) {
// Check whether the replica set member's config has {buildIndexes:false} set, which means
// we are not allowed to build non-_id indexes on this server.
if (!repl::ReplicationCoordinator::get(opCtx)->buildsIndexes()) {
// We return an IndexAlreadyExists error so that the caller can catch it and silently
// skip building it.
return Status(ErrorCodes::IndexAlreadyExists,
"this replica set member's 'buildIndexes' setting is set to false");
}
}
return Status::OK();
}
void IndexCatalogImpl::_logInternalState(OperationContext* opCtx,
const CollectionPtr& collection,
long long numIndexesInCollectionCatalogEntry,
const std::vector<std::string>& indexNamesToDrop) {
invariant(opCtx->lockState()->isCollectionLockedForMode(collection->ns(), MODE_X));
LOGV2_ERROR(20365,
"Internal Index Catalog state",
"numIndexesTotal"_attr = numIndexesTotal(opCtx),
"numIndexesInCollectionCatalogEntry"_attr = numIndexesInCollectionCatalogEntry,
"numReadyIndexes"_attr = _readyIndexes.size(),
"numBuildingIndexes"_attr = _buildingIndexes.size(),
"numFrozenIndexes"_attr = _frozenIndexes.size(),
"indexNamesToDrop"_attr = indexNamesToDrop);
// Report the ready indexes.
for (const auto& entry : _readyIndexes) {
const IndexDescriptor* desc = entry->descriptor();
LOGV2_ERROR(20367,
"readyIndex",
"index"_attr = desc->indexName(),
"indexInfo"_attr = redact(desc->infoObj()));
}
// Report the in-progress indexes.
for (const auto& entry : _buildingIndexes) {
const IndexDescriptor* desc = entry->descriptor();
LOGV2_ERROR(20369,
"buildingIndex",
"index"_attr = desc->indexName(),
"indexInfo"_attr = redact(desc->infoObj()));
}
LOGV2_ERROR(20370, "Internal Collection Catalog Entry state:");
std::vector<std::string> allIndexes;
std::vector<std::string> readyIndexes;
collection->getAllIndexes(&allIndexes);
collection->getReadyIndexes(&readyIndexes);
for (const auto& index : allIndexes) {
LOGV2_ERROR(20372,
"allIndexes",
"index"_attr = index,
"spec"_attr = redact(collection->getIndexSpec(index)));
}
for (const auto& index : readyIndexes) {
LOGV2_ERROR(20374,
"readyIndexes",
"index"_attr = index,
"spec"_attr = redact(collection->getIndexSpec(index)));
}
}
StatusWith<BSONObj> IndexCatalogImpl::prepareSpecForCreate(
OperationContext* opCtx,
const CollectionPtr& collection,
const BSONObj& original,
const boost::optional<ResumeIndexInfo>& resumeInfo) const {
auto swValidatedAndFixed = _validateAndFixIndexSpec(opCtx, collection, original);
if (!swValidatedAndFixed.isOK()) {
return swValidatedAndFixed.getStatus().withContext(
str::stream() << "Error in specification " << original.toString());
}
auto validatedSpec = swValidatedAndFixed.getValue();
// Check whether this is a TTL index being created on a capped collection.
// TODO SERVER-61545 The feature compatibility version check in this if statement can be removed
// once 6.0 is LTS.
if (collection && collection->isCapped() &&
validatedSpec.hasField(IndexDescriptor::kExpireAfterSecondsFieldName) &&
((!serverGlobalParams.featureCompatibility.isVersionInitialized()) ||
serverGlobalParams.featureCompatibility.isGreaterThanOrEqualTo(
multiversion::FeatureCompatibilityVersion::kVersion_5_2)) &&
MONGO_likely(!ignoreTTLIndexCappedCollectionCheck.shouldFail())) {
return {ErrorCodes::CannotCreateIndex, "Cannot create TTL index on a capped collection"};
}
// Check whether this is a non-_id index and there are any settings disallowing this server
// from building non-_id indexes.
Status status = _isNonIDIndexAndNotAllowedToBuild(opCtx, validatedSpec);
if (!status.isOK()) {
return status;
}
// First check against only the ready indexes for conflicts.
status =
_doesSpecConflictWithExisting(opCtx, collection, validatedSpec, InclusionPolicy::kReady);
if (!status.isOK()) {
return status;
}
if (resumeInfo) {
// Don't check against unfinished indexes if this index is being resumed, since it will
// conflict with itself.
return validatedSpec;
}
// Now we will check against all indexes, in-progress included.
//
// The index catalog cannot currently iterate over only in-progress indexes. So by previously
// checking against only ready indexes without error, we know that any errors encountered
// checking against all indexes occurred due to an in-progress index.
status = _doesSpecConflictWithExisting(opCtx,
collection,
validatedSpec,
IndexCatalog::InclusionPolicy::kReady |
IndexCatalog::InclusionPolicy::kUnfinished |
IndexCatalog::InclusionPolicy::kFrozen);
if (!status.isOK()) {
if (ErrorCodes::IndexAlreadyExists == status.code()) {
// Callers need to be able to distinguish conflicts against ready indexes versus
// in-progress indexes.
return {ErrorCodes::IndexBuildAlreadyInProgress, status.reason()};
}
return status;
}
return validatedSpec;
}
std::vector<BSONObj> IndexCatalogImpl::removeExistingIndexesNoChecks(
OperationContext* const opCtx,
const CollectionPtr& collection,
const std::vector<BSONObj>& indexSpecsToBuild) const {
std::vector<BSONObj> result;
// Filter out ready and in-progress index builds, and any non-_id indexes if 'buildIndexes' is
// set to false in the replica set's config.
for (const auto& spec : indexSpecsToBuild) {
// returned to be built by the caller.
if (ErrorCodes::OK != _isNonIDIndexAndNotAllowedToBuild(opCtx, spec)) {
continue;
}
// _doesSpecConflictWithExisting currently does more work than we require here: we are only
// interested in the index already exists error.
if (ErrorCodes::IndexAlreadyExists ==
_doesSpecConflictWithExisting(opCtx,
collection,
spec,
IndexCatalog::InclusionPolicy::kReady |
IndexCatalog::InclusionPolicy::kUnfinished)) {
continue;
}
result.push_back(spec);
}
return result;
}
std::vector<BSONObj> IndexCatalogImpl::removeExistingIndexes(
OperationContext* const opCtx,
const CollectionPtr& collection,
const std::vector<BSONObj>& indexSpecsToBuild,
const bool removeIndexBuildsToo) const {
std::vector<BSONObj> result;
for (const auto& spec : indexSpecsToBuild) {
auto prepareResult = prepareSpecForCreate(opCtx, collection, spec);
if (prepareResult == ErrorCodes::IndexAlreadyExists ||
(removeIndexBuildsToo && prepareResult == ErrorCodes::IndexBuildAlreadyInProgress)) {
continue;
}
uassertStatusOK(prepareResult);
result.push_back(prepareResult.getValue());
}
return result;
}
IndexCatalogEntry* IndexCatalogImpl::createIndexEntry(OperationContext* opCtx,
Collection* collection,
std::unique_ptr<IndexDescriptor> descriptor,
CreateIndexEntryFlags flags) {
Status status = _isSpecOk(opCtx, collection, descriptor->infoObj());
if (!status.isOK()) {
LOGV2_FATAL_NOTRACE(28782,
"Found an invalid index",
"descriptor"_attr = descriptor->infoObj(),
"namespace"_attr = collection->ns(),
"error"_attr = redact(status));
}
auto engine = opCtx->getServiceContext()->getStorageEngine();
std::string ident = engine->getCatalog()->getIndexIdent(
opCtx, collection->getCatalogId(), descriptor->indexName());
bool isReadyIndex = CreateIndexEntryFlags::kIsReady & flags;
bool frozen = CreateIndexEntryFlags::kFrozen & flags;
invariant(!frozen || !isReadyIndex);
auto* const descriptorPtr = descriptor.get();
auto entry = std::make_shared<IndexCatalogEntryImpl>(
opCtx, collection, ident, std::move(descriptor), frozen);
IndexDescriptor* desc = entry->descriptor();
// In some cases, it may be necessary to update the index metadata in the storage engine in
// order to obtain the correct SortedDataInterface. One such scenario is found in converting an
// index to be unique.
bool isUpdateMetadata = CreateIndexEntryFlags::kUpdateMetadata & flags;
if (isUpdateMetadata) {
bool isForceUpdateMetadata = CreateIndexEntryFlags::kForceUpdateMetadata & flags;
engine->getEngine()->alterIdentMetadata(opCtx, ident, desc, isForceUpdateMetadata);
}
if (!frozen) {
entry->setAccessMethod(IndexAccessMethodFactory::get(opCtx)->make(
opCtx, collection->ns(), collection->getCollectionOptions(), entry.get(), ident));
}
IndexCatalogEntry* save = entry.get();
if (isReadyIndex) {
_readyIndexes.add(std::move(entry));
} else if (frozen) {
_frozenIndexes.add(std::move(entry));
} else {
_buildingIndexes.add(std::move(entry));
}
bool initFromDisk = CreateIndexEntryFlags::kInitFromDisk & flags;
if (!initFromDisk && !UncommittedCatalogUpdates::isCreatedCollection(opCtx, collection->ns())) {
const std::string indexName = descriptorPtr->indexName();
opCtx->recoveryUnit()->onRollback(
[collectionDecorations = collection->getSharedDecorations(),
indexName = std::move(indexName)] {
CollectionIndexUsageTrackerDecoration::get(collectionDecorations)
.unregisterIndex(indexName);
});
}
return save;
}
StatusWith<BSONObj> IndexCatalogImpl::createIndexOnEmptyCollection(OperationContext* opCtx,
Collection* collection,
BSONObj spec) {
invariant(collection->uuid() == collection->uuid());
CollectionCatalog::get(opCtx)->invariantHasExclusiveAccessToCollection(opCtx, collection->ns());
invariant(collection->isEmpty(opCtx),
str::stream() << "Collection must be empty. Collection: " << collection->ns()
<< " UUID: " << collection->uuid()
<< " Count (from size storer): " << collection->numRecords(opCtx));
StatusWith<BSONObj> statusWithSpec = prepareSpecForCreate(opCtx, collection, spec);
Status status = statusWithSpec.getStatus();
if (!status.isOK())
return status;
spec = statusWithSpec.getValue();
// now going to touch disk
boost::optional<UUID> buildUUID = boost::none;
IndexBuildBlock indexBuildBlock(
collection->ns(), spec, IndexBuildMethod::kForeground, buildUUID);
status = indexBuildBlock.init(opCtx, collection);
if (!status.isOK())
return status;
// sanity checks, etc...
IndexCatalogEntry* entry = indexBuildBlock.getEntry(opCtx, collection);
invariant(entry);
IndexDescriptor* descriptor = entry->descriptor();
invariant(descriptor);
status = entry->accessMethod()->initializeAsEmpty(opCtx);
if (!status.isOK())
return status;
indexBuildBlock.success(opCtx, collection);
// sanity check
invariant(collection->isIndexReady(descriptor->indexName()));
return spec;
}
namespace {
constexpr int kMaxNumIndexesAllowed = 64;
/**
* Recursive function which confirms whether 'expression' is valid for use in partial indexes.
* Recursion is restricted to 'internalPartialFilterExpressionMaxDepth' levels.
*/
Status _checkValidFilterExpressions(const MatchExpression* expression,
bool timeseriesMetricIndexesFeatureFlagEnabled,
int level = 0) {
if (!expression)
return Status::OK();
const auto kMaxDepth = internalPartialFilterExpressionMaxDepth.load();
if (timeseriesMetricIndexesFeatureFlagEnabled && (level + 1) > kMaxDepth) {
return Status(ErrorCodes::CannotCreateIndex,
str::stream()
<< "partialFilterExpression depth may not exceed " << kMaxDepth);
}
switch (expression->matchType()) {
case MatchExpression::AND:
if (!timeseriesMetricIndexesFeatureFlagEnabled) {
if (level > 0)
return Status(ErrorCodes::CannotCreateIndex,
"$and only supported in partialFilterExpression at top level");
}
for (size_t i = 0; i < expression->numChildren(); i++) {
Status status = _checkValidFilterExpressions(
expression->getChild(i), timeseriesMetricIndexesFeatureFlagEnabled, level + 1);
if (!status.isOK())
return status;
}
return Status::OK();
case MatchExpression::OR:
if (!timeseriesMetricIndexesFeatureFlagEnabled) {
return Status(ErrorCodes::CannotCreateIndex,
str::stream() << "Expression not supported in partial index: "
<< expression->debugString());
}
for (size_t i = 0; i < expression->numChildren(); i++) {
Status status = _checkValidFilterExpressions(
expression->getChild(i), timeseriesMetricIndexesFeatureFlagEnabled, level + 1);
if (!status.isOK()) {
return status;
}
}
return Status::OK();
case MatchExpression::GEO:
case MatchExpression::INTERNAL_BUCKET_GEO_WITHIN:
case MatchExpression::INTERNAL_EXPR_EQ:
case MatchExpression::INTERNAL_EXPR_LT:
case MatchExpression::INTERNAL_EXPR_LTE:
case MatchExpression::INTERNAL_EXPR_GT:
case MatchExpression::INTERNAL_EXPR_GTE:
case MatchExpression::MATCH_IN:
if (timeseriesMetricIndexesFeatureFlagEnabled) {
return Status::OK();
}
return Status(ErrorCodes::CannotCreateIndex,
str::stream() << "Expression not supported in partial index: "
<< expression->debugString());
case MatchExpression::EQ:
case MatchExpression::LT:
case MatchExpression::LTE:
case MatchExpression::GT:
case MatchExpression::GTE:
case MatchExpression::EXISTS:
case MatchExpression::TYPE_OPERATOR:
return Status::OK();
default:
return Status(ErrorCodes::CannotCreateIndex,
str::stream() << "Expression not supported in partial index: "
<< expression->debugString());
}
}
/**
* Adjust the provided index spec BSONObj depending on the type of index obj describes.
*
* This is a no-op unless the object describes a TEXT or a GEO_2DSPHERE index. TEXT and
* GEO_2DSPHERE provide additional validation on the index spec, and tweak the index spec
* object to conform to their expected format.
*/
StatusWith<BSONObj> adjustIndexSpecObject(const BSONObj& obj) {
std::string pluginName = IndexNames::findPluginName(obj.getObjectField("key"));
if (IndexNames::TEXT == pluginName) {
return fts::FTSSpec::fixSpec(obj);
}
if (IndexNames::GEO_2DSPHERE == pluginName) {
return S2AccessMethod::fixSpec(obj);
}
if (IndexNames::GEO_2DSPHERE_BUCKET == pluginName) {
return S2BucketAccessMethod::fixSpec(obj);
}
return obj;
}
Status reportInvalidOption(StringData optionName, StringData pluginName) {
return Status(ErrorCodes::CannotCreateIndex,
str::stream() << "Index type '" << pluginName << "' does not support the '"
<< optionName << "' option");
}
Status reportInvalidVersion(StringData pluginName, IndexVersion indexVersion) {
return Status(ErrorCodes::CannotCreateIndex,
str::stream() << "Index type '" << pluginName
<< "' is not allowed with index version v: "
<< static_cast<int>(indexVersion));
}
Status validateWildcardSpec(const BSONObj& spec, IndexVersion indexVersion) {
if (spec["sparse"].trueValue())
return reportInvalidOption("sparse", IndexNames::WILDCARD);
if (spec["unique"].trueValue()) {
return reportInvalidOption("unique", IndexNames::WILDCARD);
}
if (spec.getField("expireAfterSeconds")) {
return reportInvalidOption("expireAfterSeconds", IndexNames::WILDCARD)
.withContext("cannot make a TTL index");
}
if (indexVersion < IndexVersion::kV2) {
return reportInvalidVersion(IndexNames::WILDCARD, indexVersion);
}
return Status::OK();
} // namespace
Status validateColumnStoreSpec(const CollectionPtr& collection,
const BSONObj& spec,
IndexVersion indexVersion) {
if (collection->isClustered()) {
return {ErrorCodes::InvalidOptions,
"unsupported configuation. Cannot create a columnstore index on a clustered "
"collection"};
}
// TODO SERVER-63123 support 'columnstoreProjection'.
for (auto&& notToBeSpecified : {"sparse"_sd,
"unique"_sd,
"expireAfterSeconds"_sd,
"partialFilterExpression"_sd,
"columnstoreProjection"_sd}) {
if (spec.hasField(notToBeSpecified)) {
return reportInvalidOption(notToBeSpecified, IndexNames::COLUMN);
}
}
if (indexVersion < IndexVersion::kV2) {
return reportInvalidVersion(IndexNames::COLUMN, indexVersion);
}
return Status::OK();
}
} // namespace
Status IndexCatalogImpl::checkValidFilterExpressions(
const MatchExpression* expression, bool timeseriesMetricIndexesFeatureFlagEnabled) {
return _checkValidFilterExpressions(expression, timeseriesMetricIndexesFeatureFlagEnabled);
}
Status IndexCatalogImpl::_isSpecOk(OperationContext* opCtx,
const CollectionPtr& collection,
const BSONObj& spec) const {
const NamespaceString& nss = collection->ns();
BSONElement vElt = spec["v"];
if (!vElt) {
return {ErrorCodes::InternalError,
str::stream()
<< "An internal operation failed to specify the 'v' field, which is a required "
"property of an index specification: "
<< spec};
}
if (!vElt.isNumber()) {
return Status(ErrorCodes::CannotCreateIndex,
str::stream() << "non-numeric value for \"v\" field: " << vElt);
}
auto vEltAsInt = representAs<int>(vElt.number());
if (!vEltAsInt) {
return {ErrorCodes::CannotCreateIndex,
str::stream() << "Index version must be representable as a 32-bit integer, but got "
<< vElt.toString(false, false)};
}
auto indexVersion = static_cast<IndexVersion>(*vEltAsInt);
if (indexVersion >= IndexVersion::kV2) {
auto status = index_key_validate::validateIndexSpecFieldNames(spec);
if (!status.isOK()) {
return status;
}
}
if (!IndexDescriptor::isIndexVersionSupported(indexVersion)) {
return Status(ErrorCodes::CannotCreateIndex,
str::stream() << "this version of mongod cannot build new indexes "
<< "of version number " << static_cast<int>(indexVersion));
}
if (nss.isOplog())
return Status(ErrorCodes::CannotCreateIndex, "cannot have an index on the oplog");
// logical name of the index
const BSONElement nameElem = spec["name"];
if (nameElem.type() != String)
return Status(ErrorCodes::CannotCreateIndex, "index name must be specified as a string");
const StringData name = nameElem.valueStringData();
if (name.find('\0') != std::string::npos)
return Status(ErrorCodes::CannotCreateIndex, "index name cannot contain NUL bytes");
if (name.empty())
return Status(ErrorCodes::CannotCreateIndex, "index name cannot be empty");
const BSONObj key = spec.getObjectField("key");
const Status keyStatus = index_key_validate::validateKeyPattern(key, indexVersion);
if (!keyStatus.isOK()) {
return Status(ErrorCodes::CannotCreateIndex,
str::stream()
<< "bad index key pattern " << key << ": " << keyStatus.reason());
}
const string pluginName = IndexNames::findPluginName(key);
std::unique_ptr<CollatorInterface> collator;
BSONElement collationElement = spec.getField("collation");
if (collationElement) {
if (collationElement.type() != BSONType::Object) {
return Status(ErrorCodes::CannotCreateIndex,
"\"collation\" for an index must be a document");
}
auto statusWithCollator = CollatorFactoryInterface::get(opCtx->getServiceContext())
->makeFromBSON(collationElement.Obj());
if (!statusWithCollator.isOK()) {
return statusWithCollator.getStatus();
}
collator = std::move(statusWithCollator.getValue());
if (!collator) {
return {ErrorCodes::InternalError,
str::stream() << "An internal operation specified the collation "
<< CollationSpec::kSimpleSpec
<< " explicitly, which should instead be implied by omitting the "
"'collation' field from the index specification"};
}
if (static_cast<IndexVersion>(vElt.numberInt()) < IndexVersion::kV2) {
return {ErrorCodes::CannotCreateIndex,
str::stream() << "Index version " << vElt.fieldNameStringData() << "="
<< vElt.numberInt() << " does not support the '"
<< collationElement.fieldNameStringData() << "' option"};
}
if ((pluginName != IndexNames::BTREE) && (pluginName != IndexNames::GEO_2DSPHERE) &&
(pluginName != IndexNames::HASHED) && (pluginName != IndexNames::WILDCARD)) {
return Status(ErrorCodes::CannotCreateIndex,
str::stream()
<< "Index type '" << pluginName
<< "' does not support collation: " << collator->getSpec().toBSON());
}
}
const bool isSparse = spec["sparse"].trueValue();
if (pluginName == IndexNames::WILDCARD) {
if (auto wildcardSpecStatus = validateWildcardSpec(spec, indexVersion);
!wildcardSpecStatus.isOK()) {
return wildcardSpecStatus;
}
} else if (pluginName == IndexNames::COLUMN) {
uassert(ErrorCodes::NotImplemented,
str::stream() << pluginName
<< " indexes are under development and cannot be used without "
"enabling the feature flag",
feature_flags::gFeatureFlagColumnstoreIndexes.isEnabled(
serverGlobalParams.featureCompatibility));
if (auto columnSpecStatus = validateColumnStoreSpec(collection, spec, indexVersion);
!columnSpecStatus.isOK()) {
return columnSpecStatus;
}
}
// Create an ExpressionContext, used to parse the match expression and to house the collator for
// the remaining checks.
boost::intrusive_ptr<ExpressionContext> expCtx(
new ExpressionContext(opCtx, std::move(collator), nss));
// Ensure if there is a filter, its valid.
BSONElement filterElement = spec.getField("partialFilterExpression");
if (filterElement) {
if (isSparse) {
return Status(ErrorCodes::CannotCreateIndex,
"cannot mix \"partialFilterExpression\" and \"sparse\" options");
}
if (filterElement.type() != Object) {
return Status(ErrorCodes::CannotCreateIndex,
"\"partialFilterExpression\" for an index must be a document");
}
// Parsing the partial filter expression is not expected to fail here since the
// expression would have been successfully parsed upstream during index creation.
StatusWithMatchExpression statusWithMatcher =
MatchExpressionParser::parse(filterElement.Obj(),
expCtx,
ExtensionsCallbackNoop(),
MatchExpressionParser::kBanAllSpecialFeatures);
if (!statusWithMatcher.isOK()) {
return statusWithMatcher.getStatus();
}
const std::unique_ptr<MatchExpression> filterExpr = std::move(statusWithMatcher.getValue());
Status status =
_checkValidFilterExpressions(filterExpr.get(),
feature_flags::gTimeseriesMetricIndexes.isEnabled(
serverGlobalParams.featureCompatibility));
if (!status.isOK()) {
return status;
}
}
BSONElement clusteredElt = spec["clustered"];
if (collection->isClustered() || (clusteredElt && clusteredElt.trueValue())) {
// Clustered collections require checks to ensure the spec does not conflict with the
// implicit clustered index that exists on the clustered collection.
auto status = isSpecOKClusteredIndexCheck(spec, collection->getClusteredInfo());
if (!status.isOK()) {
return status;
}
}
if (IndexDescriptor::isIdIndexPattern(key)) {
if (collection->isClustered() &&
!clustered_util::matchesClusterKey(key, collection->getClusteredInfo())) {
return Status(
ErrorCodes::CannotCreateIndex,
"cannot create the _id index on a clustered collection not clustered by _id");
}
BSONElement uniqueElt = spec["unique"];
if (uniqueElt && !uniqueElt.trueValue()) {
return Status(ErrorCodes::CannotCreateIndex, "_id index cannot be non-unique");
}
if (filterElement) {
return Status(ErrorCodes::CannotCreateIndex, "_id index cannot be a partial index");
}
if (isSparse) {
return Status(ErrorCodes::CannotCreateIndex, "_id index cannot be sparse");
}
if (collationElement &&
!CollatorInterface::collatorsMatch(expCtx->getCollator(),
collection->getDefaultCollator())) {
return Status(ErrorCodes::CannotCreateIndex,
"_id index must have the collection default collation");
}
}
// --- only storage engine checks allowed below this ----
BSONElement storageEngineElement = spec.getField("storageEngine");
if (storageEngineElement.eoo()) {
return Status::OK();
}
if (storageEngineElement.type() != mongo::Object) {
return Status(ErrorCodes::CannotCreateIndex,
"\"storageEngine\" options must be a document if present");
}
BSONObj storageEngineOptions = storageEngineElement.Obj();
if (storageEngineOptions.isEmpty()) {
return Status(ErrorCodes::CannotCreateIndex,
"Empty \"storageEngine\" options are invalid. "
"Please remove the field or include valid options.");
}
Status storageEngineStatus = validateStorageOptions(
opCtx->getServiceContext(), storageEngineOptions, [](const auto& x, const auto& y) {
return x->validateIndexStorageOptions(y);
});
if (!storageEngineStatus.isOK()) {
return storageEngineStatus;
}
return Status::OK();
}
Status IndexCatalogImpl::_doesSpecConflictWithExisting(OperationContext* opCtx,
const CollectionPtr& collection,
const BSONObj& spec,
InclusionPolicy inclusionPolicy) const {
StringData name = spec.getStringField(IndexDescriptor::kIndexNameFieldName);
invariant(name[0]);
const BSONObj key = spec.getObjectField(IndexDescriptor::kKeyPatternFieldName);
if (spec["clustered"]) {
// Not an error, but the spec is already validated against the collection options by
// _isSpecOK now and we know that if 'clustered' is true, then the index already exists.
return Status(ErrorCodes::IndexAlreadyExists, "The clustered index is implicitly built");
}
{
// Check whether an index with the specified candidate name already exists in the catalog.
const IndexDescriptor* desc = findIndexByName(opCtx, name, inclusionPolicy);
if (desc) {
// Index already exists with same name. Check whether the options are the same as well.
IndexDescriptor candidate(_getAccessMethodName(key), spec);
auto indexComparison =
candidate.compareIndexOptions(opCtx, collection->ns(), getEntry(desc));
// Key pattern or another uniquely-identifying option differs. We can build this index,
// but not with the specified (duplicate) name. User must specify another index name.
if (indexComparison == IndexDescriptor::Comparison::kDifferent) {
return Status(ErrorCodes::IndexKeySpecsConflict,
str::stream()
<< "An existing index has the same name as the "
"requested index. When index names are not specified, they "
"are auto generated and can cause conflicts. Please refer to "
"our documentation. Requested index: "
<< spec << ", existing index: " << desc->infoObj());
}
// The candidate's key and uniquely-identifying options are equivalent to an existing
// index, but some other options are not identical. Return a message to that effect.
if (indexComparison == IndexDescriptor::Comparison::kEquivalent) {
return Status(ErrorCodes::IndexOptionsConflict,
str::stream() << "An equivalent index already exists with the same "
"name but different options. Requested index: "
<< spec << ", existing index: " << desc->infoObj());
}
// If we've reached this point, the requested index is identical to an existing index.
invariant(indexComparison == IndexDescriptor::Comparison::kIdentical);
// If an identical index exists, but it is frozen, return an error with a different
// error code to the user, forcing the user to drop before recreating the index.
auto entry = getEntry(desc);
if (entry->isFrozen()) {
return Status(ErrorCodes::CannotCreateIndex,
str::stream()
<< "An identical, unfinished index '" << name
<< "' already exists. Must drop before recreating. Spec: "
<< desc->infoObj());
}
// Index already exists with the same options, so there is no need to build a new one.
// This is not an error condition.
return Status(ErrorCodes::IndexAlreadyExists,
str::stream() << "Identical index already exists: " << name);
}
}
{
// No index with the candidate name exists. Check for an index with conflicting options.
const IndexDescriptor* desc =
findIndexByKeyPatternAndOptions(opCtx, key, spec, inclusionPolicy);
if (desc) {
LOGV2_DEBUG(20353,
2,
"Index already exists with a different name: {name}, spec: {spec}",
"Index already exists with a different name",
"name"_attr = desc->indexName(),
"spec"_attr = desc->infoObj());
// Index already exists with a different name. Check whether the options are identical.
// We will return an error in either case, but this check allows us to generate a more
// informative error message.
IndexDescriptor candidate(_getAccessMethodName(key), spec);
auto indexComparison =
candidate.compareIndexOptions(opCtx, collection->ns(), getEntry(desc));
// The candidate's key and uniquely-identifying options are equivalent to an existing
// index, but some other options are not identical. Return a message to that effect.
if (indexComparison == IndexDescriptor::Comparison::kEquivalent)
return Status(ErrorCodes::IndexOptionsConflict,
str::stream() << "An equivalent index already exists with a "
"different name and options. Requested index: "
<< spec << ", existing index: " << desc->infoObj());
// If we've reached this point, the requested index is identical to an existing index.
invariant(indexComparison == IndexDescriptor::Comparison::kIdentical);
// An identical index already exists with a different name. We cannot build this index.
return Status(ErrorCodes::IndexOptionsConflict,
str::stream() << "Index already exists with a different name: "
<< desc->indexName());
}
}
if (numIndexesTotal(opCtx) >= kMaxNumIndexesAllowed) {
string s = str::stream() << "add index fails, too many indexes for " << collection->ns()
<< " key:" << key;
LOGV2(20354,
"Exceeded maximum number of indexes",
"namespace"_attr = collection->ns(),
"key"_attr = key,
"maxNumIndexes"_attr = kMaxNumIndexesAllowed);
return Status(ErrorCodes::CannotCreateIndex, s);
}
// Refuse to build text index if another text index exists or is in progress.
// Collections should only have one text index.
string pluginName = IndexNames::findPluginName(key);
if (pluginName == IndexNames::TEXT) {
vector<const IndexDescriptor*> textIndexes;
findIndexByType(opCtx, IndexNames::TEXT, textIndexes, inclusionPolicy);
if (textIndexes.size() > 0) {
return Status(ErrorCodes::CannotCreateIndex,
str::stream() << "only one text index per collection allowed, "
<< "found existing text index \""
<< textIndexes[0]->indexName() << "\"");
}
}
return Status::OK();
}
BSONObj IndexCatalogImpl::getDefaultIdIndexSpec(const CollectionPtr& collection) const {
dassert(_idObj["_id"].type() == NumberInt);
const auto indexVersion = IndexDescriptor::getDefaultIndexVersion();
BSONObjBuilder b;
b.append("v", static_cast<int>(indexVersion));
b.append("name", "_id_");
b.append("key", _idObj);
if (collection->getDefaultCollator() && indexVersion >= IndexVersion::kV2) {
// Creating an index with the "collation" option requires a v=2 index.
b.append("collation", collection->getDefaultCollator()->getSpec().toBSON());
}
return b.obj();
}
void IndexCatalogImpl::dropIndexes(OperationContext* opCtx,
Collection* collection,
std::function<bool(const IndexDescriptor*)> matchFn,
std::function<void(const IndexDescriptor*)> onDropFn) {
uassert(ErrorCodes::BackgroundOperationInProgressForNamespace,
str::stream() << "cannot perform operation: an index build is currently running",
!haveAnyIndexesInProgress());
bool didExclude = false;
invariant(_buildingIndexes.size() == 0);
vector<string> indexNamesToDrop;
{
int seen = 0;
auto ii = getIndexIterator(opCtx,
IndexCatalog::InclusionPolicy::kReady |
IndexCatalog::InclusionPolicy::kUnfinished |
IndexCatalog::InclusionPolicy::kFrozen);
while (ii->more()) {
seen++;
const IndexDescriptor* desc = ii->next()->descriptor();
if (matchFn(desc)) {
indexNamesToDrop.push_back(desc->indexName());
} else {
didExclude = true;
}
}
invariant(seen == numIndexesTotal(opCtx));
}
for (size_t i = 0; i < indexNamesToDrop.size(); i++) {
string indexName = indexNamesToDrop[i];
const IndexDescriptor* desc = findIndexByName(
opCtx,
indexName,
IndexCatalog::InclusionPolicy::kReady | IndexCatalog::InclusionPolicy::kUnfinished |
IndexCatalog::InclusionPolicy::kFrozen);
invariant(desc);
LOGV2_DEBUG(20355, 1, "\t dropAllIndexes dropping: {desc}", "desc"_attr = *desc);
IndexCatalogEntry* entry = desc->getEntry();
invariant(entry);
// If the onDrop function creates an oplog entry, it should run first so that the drop is
// timestamped at the same optime.
if (onDropFn) {
onDropFn(desc);
}
invariant(dropIndexEntry(opCtx, collection, entry).isOK());
}
// verify state is sane post cleaning
long long numIndexesInCollectionCatalogEntry = collection->getTotalIndexCount();
if (!didExclude) {
if (numIndexesTotal(opCtx) || numIndexesInCollectionCatalogEntry || _readyIndexes.size()) {
_logInternalState(
opCtx, collection, numIndexesInCollectionCatalogEntry, indexNamesToDrop);
}
fassert(17327, numIndexesTotal(opCtx) == 0);
fassert(17328, numIndexesInCollectionCatalogEntry == 0);
fassert(17337, _readyIndexes.size() == 0);
}
}
void IndexCatalogImpl::dropAllIndexes(OperationContext* opCtx,
Collection* collection,
bool includingIdIndex,
std::function<void(const IndexDescriptor*)> onDropFn) {
dropIndexes(opCtx,
collection,
[includingIdIndex](const IndexDescriptor* indexDescriptor) {
if (includingIdIndex) {
return true;
}
return !indexDescriptor->isIdIndex();
},
onDropFn);
}
Status IndexCatalogImpl::dropIndex(OperationContext* opCtx,
Collection* collection,
const IndexDescriptor* desc) {
IndexCatalogEntry* entry = desc->getEntry();
if (!entry)
return Status(ErrorCodes::InternalError, "cannot find index to delete");
if (!entry->isReady(opCtx))
return Status(ErrorCodes::InternalError, "cannot delete not ready index");
return dropIndexEntry(opCtx, collection, entry);
}
Status IndexCatalogImpl::dropUnfinishedIndex(OperationContext* opCtx,
Collection* collection,
const IndexDescriptor* desc) {
IndexCatalogEntry* entry = desc->getEntry();
if (!entry)
return Status(ErrorCodes::InternalError, "cannot find index to delete");
if (entry->isReady(opCtx))
return Status(ErrorCodes::InternalError, "expected unfinished index, but it is ready");
return dropIndexEntry(opCtx, collection, entry);
}
namespace {
class IndexRemoveChange final : public RecoveryUnit::Change {
public:
IndexRemoveChange(OperationContext* opCtx,
const NamespaceString& nss,
const UUID& uuid,
std::shared_ptr<IndexCatalogEntry> entry,
SharedCollectionDecorations* collectionDecorations)
: _opCtx(opCtx),
_nss(nss),
_uuid(uuid),
_entry(std::move(entry)),
_collectionDecorations(collectionDecorations) {}
void commit(boost::optional<Timestamp> commitTime) final {
if (commitTime) {
HistoricalIdentTracker::get(_opCtx).recordDrop(
_entry->getIdent(), _nss, _uuid, commitTime.get());
}
_entry->setDropped();
}
void rollback() final {
auto indexDescriptor = _entry->descriptor();
// Refresh the CollectionIndexUsageTrackerDecoration's knowledge of what indices are
// present as it is shared state across Collection copies.
CollectionIndexUsageTrackerDecoration::get(_collectionDecorations)
.registerIndex(indexDescriptor->indexName(),
indexDescriptor->keyPattern(),
IndexFeatures::make(indexDescriptor, _nss.isOnInternalDb()));
}
private:
OperationContext* _opCtx;
const NamespaceString _nss;
const UUID _uuid;
std::shared_ptr<IndexCatalogEntry> _entry;
SharedCollectionDecorations* _collectionDecorations;
};
} // namespace
Status IndexCatalogImpl::dropIndexEntry(OperationContext* opCtx,
Collection* collection,
IndexCatalogEntry* entry) {
invariant(entry);
// Pulling indexName out as it is needed post descriptor release.
string indexName = entry->descriptor()->indexName();
audit::logDropIndex(opCtx->getClient(), indexName, collection->ns());
auto released = [&] {
if (auto released = _readyIndexes.release(entry->descriptor())) {
return released;
}
if (auto released = _buildingIndexes.release(entry->descriptor())) {
return released;
}
if (auto released = _frozenIndexes.release(entry->descriptor())) {
return released;
}
MONGO_UNREACHABLE;
}();
invariant(released.get() == entry);
opCtx->recoveryUnit()->registerChange(
std::make_unique<IndexRemoveChange>(opCtx,
collection->ns(),
collection->uuid(),
std::move(released),
collection->getSharedDecorations()));
CollectionQueryInfo::get(collection).rebuildIndexData(opCtx, collection);
CollectionIndexUsageTrackerDecoration::get(collection->getSharedDecorations())
.unregisterIndex(indexName);
_deleteIndexFromDisk(opCtx, collection, indexName, entry->getSharedIdent());
return Status::OK();
}
void IndexCatalogImpl::deleteIndexFromDisk(OperationContext* opCtx,
Collection* collection,
const string& indexName) {
_deleteIndexFromDisk(opCtx, collection, indexName, nullptr);
}
void IndexCatalogImpl::_deleteIndexFromDisk(OperationContext* opCtx,
Collection* collection,
const string& indexName,
std::shared_ptr<Ident> ident) {
invariant(!findIndexByName(opCtx,
indexName,
IndexCatalog::InclusionPolicy::kReady |
IndexCatalog::InclusionPolicy::kUnfinished |
IndexCatalog::InclusionPolicy::kFrozen));
catalog::removeIndex(opCtx, indexName, collection, std::move(ident));
}
void IndexCatalogImpl::setMultikeyPaths(OperationContext* const opCtx,
const CollectionPtr& coll,
const IndexDescriptor* desc,
const KeyStringSet& multikeyMetadataKeys,
const MultikeyPaths& multikeyPaths) const {
IndexCatalogEntry* entry = desc->getEntry();
invariant(entry);
entry->setMultikey(opCtx, coll, multikeyMetadataKeys, multikeyPaths);
};
// ---------------------------
bool IndexCatalogImpl::haveAnyIndexes() const {
return _readyIndexes.size() > 0 || _buildingIndexes.size() > 0;
}
bool IndexCatalogImpl::haveAnyIndexesInProgress() const {
return _buildingIndexes.size() > 0;
}
int IndexCatalogImpl::numIndexesTotal(OperationContext* opCtx) const {
return _readyIndexes.size() + _buildingIndexes.size();
}
int IndexCatalogImpl::numIndexesReady(OperationContext* opCtx) const {
std::vector<const IndexDescriptor*> itIndexes;
auto ii = getIndexIterator(opCtx, InclusionPolicy::kReady);
while (ii->more()) {
itIndexes.push_back(ii->next()->descriptor());
}
return itIndexes.size();
}
bool IndexCatalogImpl::haveIdIndex(OperationContext* opCtx) const {
return findIdIndex(opCtx) != nullptr;
}
const IndexDescriptor* IndexCatalogImpl::findIdIndex(OperationContext* opCtx) const {
auto ii = getIndexIterator(opCtx, InclusionPolicy::kReady);
while (ii->more()) {
const IndexDescriptor* desc = ii->next()->descriptor();
if (desc->isIdIndex())
return desc;
}
return nullptr;
}
const IndexDescriptor* IndexCatalogImpl::findIndexByName(OperationContext* opCtx,
StringData name,
InclusionPolicy inclusionPolicy) const {
auto ii = getIndexIterator(opCtx, inclusionPolicy);
while (ii->more()) {
const IndexDescriptor* desc = ii->next()->descriptor();
if (desc->indexName() == name)
return desc;
}
return nullptr;
}
const IndexDescriptor* IndexCatalogImpl::findIndexByKeyPatternAndOptions(
OperationContext* opCtx,
const BSONObj& key,
const BSONObj& indexSpec,
InclusionPolicy inclusionPolicy) const {
auto ii = getIndexIterator(opCtx, inclusionPolicy);
IndexDescriptor needle(_getAccessMethodName(key), indexSpec);
while (ii->more()) {
const auto* entry = ii->next();
if (needle.compareIndexOptions(opCtx, {}, entry) !=
IndexDescriptor::Comparison::kDifferent) {
return entry->descriptor();
}
}
return nullptr;
} // namespace mongo
void IndexCatalogImpl::findIndexesByKeyPattern(OperationContext* opCtx,
const BSONObj& key,
InclusionPolicy inclusionPolicy,
std::vector<const IndexDescriptor*>* matches) const {
invariant(matches);
auto ii = getIndexIterator(opCtx, inclusionPolicy);
while (ii->more()) {
const IndexDescriptor* desc = ii->next()->descriptor();
if (SimpleBSONObjComparator::kInstance.evaluate(desc->keyPattern() == key)) {
matches->push_back(desc);
}
}
}
void IndexCatalogImpl::findIndexByType(OperationContext* opCtx,
const string& type,
vector<const IndexDescriptor*>& matches,
InclusionPolicy inclusionPolicy) const {
auto ii = getIndexIterator(opCtx, inclusionPolicy);
while (ii->more()) {
const IndexDescriptor* desc = ii->next()->descriptor();
if (IndexNames::findPluginName(desc->keyPattern()) == type) {
matches.push_back(desc);
}
}
}
const IndexCatalogEntry* IndexCatalogImpl::getEntry(const IndexDescriptor* desc) const {
const IndexCatalogEntry* entry = desc->getEntry();
massert(17357, "cannot find index entry", entry);
return entry;
}
std::shared_ptr<const IndexCatalogEntry> IndexCatalogImpl::getEntryShared(
const IndexDescriptor* indexDescriptor) const {
return indexDescriptor->getEntry()->shared_from_this();
}
std::vector<std::shared_ptr<const IndexCatalogEntry>> IndexCatalogImpl::getAllReadyEntriesShared()
const {
return _readyIndexes.getAllEntries();
}
const IndexDescriptor* IndexCatalogImpl::refreshEntry(OperationContext* opCtx,
Collection* collection,
const IndexDescriptor* oldDesc,
CreateIndexEntryFlags flags) {
invariant(_buildingIndexes.size() == 0);
const std::string indexName = oldDesc->indexName();
invariant(collection->isIndexReady(indexName));
// Delete the IndexCatalogEntry that owns this descriptor. After deletion, 'oldDesc' is
// invalid and should not be dereferenced. Also, invalidate the index from the
// CollectionIndexUsageTrackerDecoration (shared state among Collection instances).
auto oldEntry = _readyIndexes.release(oldDesc);
invariant(oldEntry);
opCtx->recoveryUnit()->registerChange(
std::make_unique<IndexRemoveChange>(opCtx,
collection->ns(),
collection->uuid(),
std::move(oldEntry),
collection->getSharedDecorations()));
CollectionIndexUsageTrackerDecoration::get(collection->getSharedDecorations())
.unregisterIndex(indexName);
// Ask the CollectionCatalogEntry for the new index spec.
BSONObj spec = collection->getIndexSpec(indexName).getOwned();
BSONObj keyPattern = spec.getObjectField("key");
// Re-register this index in the index catalog with the new spec. Also, add the new index
// to the CollectionIndexUsageTrackerDecoration (shared state among Collection instances).
auto newDesc = std::make_unique<IndexDescriptor>(_getAccessMethodName(keyPattern), spec);
auto newEntry = createIndexEntry(opCtx, collection, std::move(newDesc), flags);
invariant(newEntry->isReady(opCtx));
auto desc = newEntry->descriptor();
CollectionIndexUsageTrackerDecoration::get(collection->getSharedDecorations())
.registerIndex(desc->indexName(),
desc->keyPattern(),
IndexFeatures::make(desc, collection->ns().isOnInternalDb()));
// Last rebuild index data for CollectionQueryInfo for this Collection.
CollectionQueryInfo::get(collection).rebuildIndexData(opCtx, collection);
opCtx->recoveryUnit()->onCommit([newEntry](auto commitTime) {
if (commitTime) {
newEntry->setMinimumVisibleSnapshot(*commitTime);
}
});
// Return the new descriptor.
return newEntry->descriptor();
}
// ---------------------------
Status IndexCatalogImpl::_indexFilteredRecords(OperationContext* opCtx,
const CollectionPtr& coll,
const IndexCatalogEntry* index,
const std::vector<BsonRecord>& bsonRecords,
int64_t* keysInsertedOut) const {
SharedBufferFragmentBuilder pooledBuilder(KeyString::HeapBuilder::kHeapAllocatorDefaultBytes);
InsertDeleteOptions options;
prepareInsertDeleteOptions(opCtx, coll->ns(), index->descriptor(), &options);
return index->accessMethod()->insert(
opCtx, pooledBuilder, coll, bsonRecords, options, keysInsertedOut);
}
Status IndexCatalogImpl::_indexRecords(OperationContext* opCtx,
const CollectionPtr& coll,
const IndexCatalogEntry* index,
const std::vector<BsonRecord>& bsonRecords,
int64_t* keysInsertedOut) const {
if (MONGO_unlikely(skipIndexNewRecords.shouldFail())) {
return Status::OK();
}
const MatchExpression* filter = index->getFilterExpression();
if (!filter)
return _indexFilteredRecords(opCtx, coll, index, bsonRecords, keysInsertedOut);
std::vector<BsonRecord> filteredBsonRecords;
for (auto bsonRecord : bsonRecords) {
if (filter->matchesBSON(*(bsonRecord.docPtr)))
filteredBsonRecords.push_back(bsonRecord);
}
return _indexFilteredRecords(opCtx, coll, index, filteredBsonRecords, keysInsertedOut);
}
Status IndexCatalogImpl::_updateRecord(OperationContext* const opCtx,
const CollectionPtr& coll,
const IndexCatalogEntry* index,
const BSONObj& oldDoc,
const BSONObj& newDoc,
const RecordId& recordId,
int64_t* const keysInsertedOut,
int64_t* const keysDeletedOut) const {
SharedBufferFragmentBuilder pooledBuilder(KeyString::HeapBuilder::kHeapAllocatorDefaultBytes);
InsertDeleteOptions options;
prepareInsertDeleteOptions(opCtx, coll->ns(), index->descriptor(), &options);
int64_t keysInserted = 0;
int64_t keysDeleted = 0;
auto status = index->accessMethod()->update(
opCtx, pooledBuilder, oldDoc, newDoc, recordId, coll, options, &keysInserted, &keysDeleted);
if (!status.isOK())
return status;
*keysInsertedOut += keysInserted;
*keysDeletedOut += keysDeleted;
return Status::OK();
}
void IndexCatalogImpl::_unindexRecord(OperationContext* opCtx,
const CollectionPtr& collection,
const IndexCatalogEntry* entry,
const BSONObj& obj,
const RecordId& loc,
bool logIfError,
int64_t* keysDeletedOut,
CheckRecordId checkRecordId) const {
// Tests can enable this failpoint to produce index corruption scenarios where an index has
// extra keys.
if (auto failpoint = skipUnindexingDocumentWhenDeleted.scoped();
MONGO_unlikely(failpoint.isActive())) {
auto indexName = failpoint.getData()["indexName"].valueStringDataSafe();
if (indexName == entry->descriptor()->indexName()) {
return;
}
}
SharedBufferFragmentBuilder pooledBuilder(KeyString::HeapBuilder::kHeapAllocatorDefaultBytes);
InsertDeleteOptions options;
prepareInsertDeleteOptions(opCtx, collection->ns(), entry->descriptor(), &options);
entry->accessMethod()->remove(opCtx,
pooledBuilder,
collection,
obj,
loc,
logIfError,
options,
keysDeletedOut,
checkRecordId);
}
Status IndexCatalogImpl::indexRecords(OperationContext* opCtx,
const CollectionPtr& coll,
const std::vector<BsonRecord>& bsonRecords,
int64_t* keysInsertedOut) const {
if (keysInsertedOut) {
*keysInsertedOut = 0;
}
// For vectored inserts, we insert index keys and flip multikey in "index order". However
// because multikey state for different indexes both live on the same _mdb_catalog document,
// index order isn't necessarily timestamp order. We track multikey paths here to ensure we make
// changes to the _mdb_catalog document with in timestamp order updates.
MultikeyPathTracker& tracker = MultikeyPathTracker::get(opCtx);
// Take care when choosing to aggregate multikey writes. This code will only* track multikey
// when:
// * No parent is tracking multikey and*
// * There are timestamps associated with the input `bsonRecords`.
//
// If we are not responsible for tracking multikey:
// * Leave the multikey tracker in its original "tracking" state.
// * Not write any accumulated multikey paths to the _mdb_catalog document.
const bool manageMultikeyWrite =
!tracker.isTrackingMultikeyPathInfo() && !bsonRecords[0].ts.isNull();
ON_BLOCK_EXIT([&] {
if (manageMultikeyWrite) {
tracker.clear();
}
});
{
ScopeGuard stopTrackingMultikeyChanges(
[&tracker] { tracker.stopTrackingMultikeyPathInfo(); });
if (manageMultikeyWrite) {
invariant(tracker.isEmpty());
tracker.startTrackingMultikeyPathInfo();
} else {
stopTrackingMultikeyChanges.dismiss();
}
for (auto&& it : _readyIndexes) {
Status s = _indexRecords(opCtx, coll, it.get(), bsonRecords, keysInsertedOut);
if (!s.isOK())
return s;
}
for (auto&& it : _buildingIndexes) {
Status s = _indexRecords(opCtx, coll, it.get(), bsonRecords, keysInsertedOut);
if (!s.isOK())
return s;
}
}
const WorkerMultikeyPathInfo& newPaths = tracker.getMultikeyPathInfo();
if (newPaths.size() == 0 || !manageMultikeyWrite) {
return Status::OK();
}
if (Status status = opCtx->recoveryUnit()->setTimestamp(bsonRecords[0].ts); !status.isOK()) {
return status;
}
for (const MultikeyPathInfo& newPath : newPaths) {
invariant(newPath.nss == coll->ns());
auto idx = findIndexByName(opCtx,
newPath.indexName,
IndexCatalog::InclusionPolicy::kReady |
IndexCatalog::InclusionPolicy::kUnfinished);
if (!idx) {
return Status(ErrorCodes::IndexNotFound,
str::stream()
<< "Could not find index " << newPath.indexName << " in "
<< coll->ns() << " (" << coll->uuid() << ") to set to multikey.");
}
setMultikeyPaths(opCtx, coll, idx, newPath.multikeyMetadataKeys, newPath.multikeyPaths);
}
return Status::OK();
}
Status IndexCatalogImpl::updateRecord(OperationContext* const opCtx,
const CollectionPtr& coll,
const BSONObj& oldDoc,
const BSONObj& newDoc,
const RecordId& recordId,
int64_t* const keysInsertedOut,
int64_t* const keysDeletedOut) const {
*keysInsertedOut = 0;
*keysDeletedOut = 0;
// Ready indexes go directly through the IndexAccessMethod.
for (IndexCatalogEntryContainer::const_iterator it = _readyIndexes.begin();
it != _readyIndexes.end();
++it) {
IndexCatalogEntry* entry = it->get();
auto status = _updateRecord(
opCtx, coll, entry, oldDoc, newDoc, recordId, keysInsertedOut, keysDeletedOut);
if (!status.isOK())
return status;
}
// Building indexes go through the interceptor.
for (IndexCatalogEntryContainer::const_iterator it = _buildingIndexes.begin();
it != _buildingIndexes.end();
++it) {
IndexCatalogEntry* entry = it->get();
auto status = _updateRecord(
opCtx, coll, entry, oldDoc, newDoc, recordId, keysInsertedOut, keysDeletedOut);
if (!status.isOK())
return status;
}
return Status::OK();
}
void IndexCatalogImpl::unindexRecord(OperationContext* opCtx,
const CollectionPtr& collection,
const BSONObj& obj,
const RecordId& loc,
bool noWarn,
int64_t* keysDeletedOut,
CheckRecordId checkRecordId) const {
if (keysDeletedOut) {
*keysDeletedOut = 0;
}
for (IndexCatalogEntryContainer::const_iterator it = _readyIndexes.begin();
it != _readyIndexes.end();
++it) {
IndexCatalogEntry* entry = it->get();
bool logIfError = !noWarn;
_unindexRecord(
opCtx, collection, entry, obj, loc, logIfError, keysDeletedOut, checkRecordId);
}
for (IndexCatalogEntryContainer::const_iterator it = _buildingIndexes.begin();
it != _buildingIndexes.end();
++it) {
IndexCatalogEntry* entry = it->get();
// If it's a background index, we DO NOT want to log anything.
bool logIfError = entry->isReady(opCtx) ? !noWarn : false;
_unindexRecord(
opCtx, collection, entry, obj, loc, logIfError, keysDeletedOut, checkRecordId);
}
}
Status IndexCatalogImpl::compactIndexes(OperationContext* opCtx) const {
for (IndexCatalogEntryContainer::const_iterator it = _readyIndexes.begin();
it != _readyIndexes.end();
++it) {
IndexCatalogEntry* entry = it->get();
LOGV2_DEBUG(20363,
1,
"compacting index: {entry_descriptor}",
"entry_descriptor"_attr = *(entry->descriptor()));
Status status = entry->accessMethod()->compact(opCtx);
if (!status.isOK()) {
LOGV2_ERROR(20377,
"Failed to compact index",
"index"_attr = *(entry->descriptor()),
"error"_attr = redact(status));
return status;
}
}
return Status::OK();
}
std::string::size_type IndexCatalogImpl::getLongestIndexNameLength(OperationContext* opCtx) const {
auto it = getIndexIterator(opCtx,
IndexCatalog::InclusionPolicy::kReady |
IndexCatalog::InclusionPolicy::kUnfinished |
IndexCatalog::InclusionPolicy::kFrozen);
std::string::size_type longestIndexNameLength = 0;
while (it->more()) {
auto thisLength = it->next()->descriptor()->indexName().length();
if (thisLength > longestIndexNameLength)
longestIndexNameLength = thisLength;
}
return longestIndexNameLength;
}
BSONObj IndexCatalogImpl::fixIndexKey(const BSONObj& key) const {
if (IndexDescriptor::isIdIndexPattern(key)) {
return _idObj;
}
if (key["_id"].type() == Bool && key.nFields() == 1) {
return _idObj;
}
return key;
}
void IndexCatalogImpl::prepareInsertDeleteOptions(OperationContext* opCtx,
const NamespaceString& ns,
const IndexDescriptor* desc,
InsertDeleteOptions* options) const {
auto replCoord = repl::ReplicationCoordinator::get(opCtx);
if (replCoord->shouldRelaxIndexConstraints(opCtx, ns)) {
options->getKeysMode = InsertDeleteOptions::ConstraintEnforcementMode::kRelaxConstraints;
} else {
options->getKeysMode = InsertDeleteOptions::ConstraintEnforcementMode::kEnforceConstraints;
}
// Don't allow dups for Id key. Allow dups for non-unique keys or when constraints relaxed.
if (desc->isIdIndex()) {
options->dupsAllowed = false;
} else {
options->dupsAllowed = !desc->unique() ||
options->getKeysMode ==
InsertDeleteOptions::ConstraintEnforcementMode::kRelaxConstraints;
}
}
void IndexCatalogImpl::indexBuildSuccess(OperationContext* opCtx,
Collection* coll,
IndexCatalogEntry* index) {
auto releasedEntry = _buildingIndexes.release(index->descriptor());
invariant(releasedEntry.get() == index);
_readyIndexes.add(std::move(releasedEntry));
// Wait to unset the interceptor until the index actually commits. If a write conflict is
// encountered and the index commit process is restated, the multikey information from the
// interceptor may still be needed.
opCtx->recoveryUnit()->onCommit(
[index](boost::optional<Timestamp>) { index->setIndexBuildInterceptor(nullptr); });
index->setIsReady(true);
}
StatusWith<BSONObj> IndexCatalogImpl::_fixIndexSpec(OperationContext* opCtx,
const CollectionPtr& collection,
const BSONObj& spec) const {
auto statusWithSpec = adjustIndexSpecObject(spec);
if (!statusWithSpec.isOK()) {
return statusWithSpec;
}
BSONObj o = statusWithSpec.getValue();
BSONObjBuilder b;
// We've already verified in IndexCatalog::_isSpecOk() that the index version is present and
// that it is representable as a 32-bit integer.
auto vElt = o["v"];
invariant(vElt);
b.append("v", vElt.numberInt());
if (o["unique"].trueValue())
b.appendBool("unique", true); // normalize to bool true in case was int 1 or something...
if (o["hidden"].trueValue())
b.appendBool("hidden", true); // normalize to bool true in case was int 1 or something...
if (o["prepareUnique"].trueValue())
b.appendBool("prepareUnique",
true); // normalize to bool true in case was int 1 or something...
BSONObj key = fixIndexKey(o["key"].Obj());
b.append("key", key);
string name = o["name"].String();
if (IndexDescriptor::isIdIndexPattern(key)) {
name = "_id_";
}
b.append("name", name);
// During repair, if the 'ns' field exists in the index spec, do not remove it as repair can be
// running on old data files from other mongod versions. Removing the 'ns' field during repair
// would prevent the data files from starting up on the original mongod version as the 'ns'
// field is required to be present in 3.6 and 4.0.
if (storageGlobalParams.repair && o.hasField("ns")) {
b.append("ns", o.getField("ns").String());
}
{
BSONObjIterator i(o);
while (i.more()) {
BSONElement e = i.next();
string s = e.fieldName();
if (s == "_id") {
// skip
} else if (s == "dropDups" || s == "ns") {
// dropDups is silently ignored and removed from the spec as of SERVER-14710.
// ns is removed from the spec as of 4.4.
} else if (s == "v" || s == "unique" || s == "key" || s == "name" || s == "hidden" ||
s == "prepareUnique") {
// covered above
} else {
b.append(e);
}
}
}
return b.obj();
}
} // namespace mongo
|