Press n or j to go to the next uncovered block, b, p or k for the previous block.
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 | 143x 143x 143x 143x 143x 143x 143x 143x 143x 143x 143x 88636x 88636x 88636x 88636x 88636x 88636x 88636x 143x 341254x 341254x 13862122x 341254x 170627x 170627x 170627x 170627x 170627x 170627x 170627x 170627x 170627x 170627x 2611x 857x 1754x 95770x 18x 491x 371x 459x 88x 164054x 164054x 143x 143x 2039x 2039x 96759x 3751x 62x 459x 143x 86998x 86998x 86998x 86998x 86998x 86998x 79969x 86998x 1160x 86998x 86998x 840x 840x 947x 86158x 86998x 4237x 4237x 4237x 4237x 4212x 25x 86998x 1712x 2039x 2039x 86998x 84486x 84486x 88125x 88125x 87941x 88125x 184x 88125x 88125x 88125x 87410x 4984x 25914x 87410x 1528x 2003x 88125x 88125x 88125x 88125x 88125x 1127x 88125x 1127x 1127x 86998x 86998x 86998x 82502x 82502x 82502x 81691x 143x 2795x 2795x 2795x 2795x 1668x 1668x 1668x 2795x 2795x 2028x 338x 250x 250x 250x 250x 30x 250x 143x 19518x 571x 571x 597x 597x 597x 18080x 18080x 18080x 124x 124x 146x 146x 606x 606x 606x 220x 220x 220x 88x 88x 88x 180x 180x 180x 143x 84486x 84486x 84486x 84486x 1593x 84486x 143x 85416x 85416x 85416x 85328x 85328x 85328x 85328x 85328x 85328x 85328x 85328x 85328x 85328x 85328x 85328x 85328x 85328x 85328x 184x 306992x 306992x 19556x 38x 19518x 19518x 5767879x 220x 5767659x 5758259x 5758259x 5758259x 5758259x 9400x 7551x 1016x 1016x 1016x 44x 972x 6535x 5416x 44x 5372x 5372x 44x 5328x 1119x 1119x 1119x 1119x 44x 1075x 1849x 1159x 1159x 690x 690x 690x 18x 88125x 21996x 88x 88x 44x 44x 44x 44x 88x 84813x 44x 84769x 84769x 64358x 84769x 81480x 3289x 3289x 3289x 84769x 283x 84486x 84486x 84486x 84486x 165722x 1668x 1668x 164054x 164054x 6065251x 175123x 180920x 175936x 19518x 19518x 19518x 19518x | import { type BSONSerializeOptions, type Document, EJSON, resolveBSONOptions } from '../bson'; import type { Collection } from '../collection'; import { type AnyError, MongoBatchReExecutionError, MONGODB_ERROR_CODES, MongoInvalidArgumentError, MongoRuntimeError, MongoServerError, MongoWriteConcernError } from '../error'; import type { Filter, OneOrMore, OptionalId, UpdateFilter, WithoutId } from '../mongo_types'; import type { CollationOptions, CommandOperationOptions } from '../operations/command'; import { DeleteOperation, type DeleteStatement, makeDeleteStatement } from '../operations/delete'; import { executeOperation } from '../operations/execute_operation'; import { InsertOperation } from '../operations/insert'; import { AbstractOperation, type Hint } from '../operations/operation'; import { makeUpdateStatement, UpdateOperation, type UpdateStatement } from '../operations/update'; import type { Server } from '../sdam/server'; import type { Topology } from '../sdam/topology'; import type { ClientSession } from '../sessions'; import { type TimeoutContext } from '../timeout'; import { applyRetryableWrites, getTopology, hasAtomicOperators, maybeAddIdToDocuments, type MongoDBNamespace, resolveOptions } from '../utils'; import { WriteConcern } from '../write_concern'; /** @public */ export const BatchType = Object.freeze({ INSERT: 1, UPDATE: 2, DELETE: 3 } as const); /** @public */ export type BatchType = (typeof BatchType)[keyof typeof BatchType]; /** @public */ export interface InsertOneModel<TSchema extends Document = Document> { /** The document to insert. */ document: OptionalId<TSchema>; } /** @public */ export interface DeleteOneModel<TSchema extends Document = Document> { /** The filter to limit the deleted documents. */ filter: Filter<TSchema>; /** Specifies a collation. */ collation?: CollationOptions; /** The index to use. If specified, then the query system will only consider plans using the hinted index. */ hint?: Hint; } /** @public */ export interface DeleteManyModel<TSchema extends Document = Document> { /** The filter to limit the deleted documents. */ filter: Filter<TSchema>; /** Specifies a collation. */ collation?: CollationOptions; /** The index to use. If specified, then the query system will only consider plans using the hinted index. */ hint?: Hint; } /** @public */ export interface ReplaceOneModel<TSchema extends Document = Document> { /** The filter to limit the replaced document. */ filter: Filter<TSchema>; /** The document with which to replace the matched document. */ replacement: WithoutId<TSchema>; /** Specifies a collation. */ collation?: CollationOptions; /** The index to use. If specified, then the query system will only consider plans using the hinted index. */ hint?: Hint; /** When true, creates a new document if no document matches the query. */ upsert?: boolean; } /** @public */ export interface UpdateOneModel<TSchema extends Document = Document> { /** The filter to limit the updated documents. */ filter: Filter<TSchema>; /** * The modifications to apply. The value can be either: * UpdateFilter<TSchema> - A document that contains update operator expressions, * Document[] - an aggregation pipeline. */ update: UpdateFilter<TSchema> | Document[]; /** A set of filters specifying to which array elements an update should apply. */ arrayFilters?: Document[]; /** Specifies a collation. */ collation?: CollationOptions; /** The index to use. If specified, then the query system will only consider plans using the hinted index. */ hint?: Hint; /** When true, creates a new document if no document matches the query. */ upsert?: boolean; } /** @public */ export interface UpdateManyModel<TSchema extends Document = Document> { /** The filter to limit the updated documents. */ filter: Filter<TSchema>; /** * The modifications to apply. The value can be either: * UpdateFilter<TSchema> - A document that contains update operator expressions, * Document[] - an aggregation pipeline. */ update: UpdateFilter<TSchema> | Document[]; /** A set of filters specifying to which array elements an update should apply. */ arrayFilters?: Document[]; /** Specifies a collation. */ collation?: CollationOptions; /** The index to use. If specified, then the query system will only consider plans using the hinted index. */ hint?: Hint; /** When true, creates a new document if no document matches the query. */ upsert?: boolean; } /** @public */ export type AnyBulkWriteOperation<TSchema extends Document = Document> = | { insertOne: InsertOneModel<TSchema> } | { replaceOne: ReplaceOneModel<TSchema> } | { updateOne: UpdateOneModel<TSchema> } | { updateMany: UpdateManyModel<TSchema> } | { deleteOne: DeleteOneModel<TSchema> } | { deleteMany: DeleteManyModel<TSchema> }; /** @internal */ export interface BulkResult { ok: number; writeErrors: WriteError[]; writeConcernErrors: WriteConcernError[]; insertedIds: Document[]; nInserted: number; nUpserted: number; nMatched: number; nModified: number; nRemoved: number; upserted: Document[]; } /** * Keeps the state of a unordered batch so we can rewrite the results * correctly after command execution * * @public */ export class Batch<T = Document> { originalZeroIndex: number; currentIndex: number; originalIndexes: number[]; batchType: BatchType; operations: T[]; size: number; sizeBytes: number; constructor(batchType: BatchType, originalZeroIndex: number) { this.originalZeroIndex = originalZeroIndex; this.currentIndex = 0; this.originalIndexes = []; this.batchType = batchType; this.operations = []; this.size = 0; this.sizeBytes = 0; } } /** * @public * The result of a bulk write. */ export class BulkWriteResult { private readonly result: BulkResult; /** Number of documents inserted. */ readonly insertedCount: number; /** Number of documents matched for update. */ readonly matchedCount: number; /** Number of documents modified. */ readonly modifiedCount: number; /** Number of documents deleted. */ readonly deletedCount: number; /** Number of documents upserted. */ readonly upsertedCount: number; /** Upserted document generated Id's, hash key is the index of the originating operation */ readonly upsertedIds: { [key: number]: any }; /** Inserted document generated Id's, hash key is the index of the originating operation */ readonly insertedIds: { [key: number]: any }; private static generateIdMap(ids: Document[]): { [key: number]: any } { const idMap: { [index: number]: any } = {}; for (const doc of ids) { idMap[doc.index] = doc._id; } return idMap; } /** * Create a new BulkWriteResult instance * @internal */ constructor(bulkResult: BulkResult, isOrdered: boolean) { this.result = bulkResult; this.insertedCount = this.result.nInserted ?? 0; this.matchedCount = this.result.nMatched ?? 0; this.modifiedCount = this.result.nModified ?? 0; this.deletedCount = this.result.nRemoved ?? 0; this.upsertedCount = this.result.upserted.length ?? 0; this.upsertedIds = BulkWriteResult.generateIdMap(this.result.upserted); this.insertedIds = BulkWriteResult.generateIdMap( this.getSuccessfullyInsertedIds(bulkResult, isOrdered) ); Object.defineProperty(this, 'result', { value: this.result, enumerable: false }); } /** Evaluates to true if the bulk operation correctly executes */ get ok(): number { return this.result.ok; } /** * Returns document_ids that were actually inserted * @internal */ private getSuccessfullyInsertedIds(bulkResult: BulkResult, isOrdered: boolean): Document[] { if (bulkResult.writeErrors.length === 0) return bulkResult.insertedIds; if (isOrdered) { return bulkResult.insertedIds.slice(0, bulkResult.writeErrors[0].index); } return bulkResult.insertedIds.filter( ({ index }) => !bulkResult.writeErrors.some(writeError => index === writeError.index) ); } /** Returns the upserted id at the given index */ getUpsertedIdAt(index: number): Document | undefined { return this.result.upserted[index]; } /** Returns raw internal result */ getRawResponse(): Document { return this.result; } /** Returns true if the bulk operation contains a write error */ hasWriteErrors(): boolean { return this.result.writeErrors.length > 0; } /** Returns the number of write errors off the bulk operation */ getWriteErrorCount(): number { return this.result.writeErrors.length; } /** Returns a specific write error object */ getWriteErrorAt(index: number): WriteError | undefined { return index < this.result.writeErrors.length ? this.result.writeErrors[index] : undefined; } /** Retrieve all write errors */ getWriteErrors(): WriteError[] { return this.result.writeErrors; } /** Retrieve the write concern error if one exists */ getWriteConcernError(): WriteConcernError | undefined { Eif (this.result.writeConcernErrors.length === 0) { return; } else if (this.result.writeConcernErrors.length === 1) { // Return the error return this.result.writeConcernErrors[0]; } else { // Combine the errors let errmsg = ''; for (let i = 0; i < this.result.writeConcernErrors.length; i++) { const err = this.result.writeConcernErrors[i]; errmsg = errmsg + err.errmsg; // TODO: Something better if (i === 0) errmsg = errmsg + ' and '; } return new WriteConcernError({ errmsg, code: MONGODB_ERROR_CODES.WriteConcernTimeout }); } } toString(): string { return `BulkWriteResult(${EJSON.stringify(this.result)})`; } isOk(): boolean { return this.result.ok === 1; } } /** @public */ export interface WriteConcernErrorData { code: number; errmsg: string; errInfo?: Document; } /** * An error representing a failure by the server to apply the requested write concern to the bulk operation. * @public * @category Error */ export class WriteConcernError { /** @internal */ private serverError: WriteConcernErrorData; constructor(error: WriteConcernErrorData) { this.serverError = error; } /** Write concern error code. */ get code(): number | undefined { return this.serverError.code; } /** Write concern error message. */ get errmsg(): string | undefined { return this.serverError.errmsg; } /** Write concern error info. */ get errInfo(): Document | undefined { return this.serverError.errInfo; } toJSON(): WriteConcernErrorData { return this.serverError; } toString(): string { return `WriteConcernError(${this.errmsg})`; } } /** @public */ export interface BulkWriteOperationError { index: number; code: number; errmsg: string; errInfo: Document; op: Document | UpdateStatement | DeleteStatement; } /** * An error that occurred during a BulkWrite on the server. * @public * @category Error */ export class WriteError { err: BulkWriteOperationError; constructor(err: BulkWriteOperationError) { this.err = err; } /** WriteError code. */ get code(): number { return this.err.code; } /** WriteError original bulk operation index. */ get index(): number { return this.err.index; } /** WriteError message. */ get errmsg(): string | undefined { return this.err.errmsg; } /** WriteError details. */ get errInfo(): Document | undefined { return this.err.errInfo; } /** Returns the underlying operation that caused the error */ getOperation(): Document { return this.err.op; } toJSON(): { code: number; index: number; errmsg?: string; op: Document } { return { code: this.err.code, index: this.err.index, errmsg: this.err.errmsg, op: this.err.op }; } toString(): string { return `WriteError(${JSON.stringify(this.toJSON())})`; } } /** Merges results into shared data structure */ export function mergeBatchResults( batch: Batch, bulkResult: BulkResult, err?: AnyError, result?: Document ): void { // If we have an error set the result to be the err object Iif (err) { result = err; } else Iif (result && result.result) { result = result.result; } Iif (result == null) { return; } // Do we have a top level error stop processing and return Iif (result.ok === 0 && bulkResult.ok === 1) { bulkResult.ok = 0; const writeError = { index: 0, code: result.code || 0, errmsg: result.message, errInfo: result.errInfo, op: batch.operations[0] }; bulkResult.writeErrors.push(new WriteError(writeError)); return; } else Iif (result.ok === 0 && bulkResult.ok === 0) { return; } // If we have an insert Batch type if (isInsertBatch(batch) && result.n) { bulkResult.nInserted = bulkResult.nInserted + result.n; } // If we have an insert Batch type if (isDeleteBatch(batch) && result.n) { bulkResult.nRemoved = bulkResult.nRemoved + result.n; } let nUpserted = 0; // We have an array of upserted values, we need to rewrite the indexes if (Array.isArray(result.upserted)) { nUpserted = result.upserted.length; for (let i = 0; i < result.upserted.length; i++) { bulkResult.upserted.push({ index: result.upserted[i].index + batch.originalZeroIndex, _id: result.upserted[i]._id }); } } else Iif (result.upserted) { nUpserted = 1; bulkResult.upserted.push({ index: batch.originalZeroIndex, _id: result.upserted }); } // If we have an update Batch type if (isUpdateBatch(batch) && result.n) { const nModified = result.nModified; bulkResult.nUpserted = bulkResult.nUpserted + nUpserted; bulkResult.nMatched = bulkResult.nMatched + (result.n - nUpserted); if (typeof nModified === 'number') { bulkResult.nModified = bulkResult.nModified + nModified; } else { bulkResult.nModified = 0; } } if (Array.isArray(result.writeErrors)) { for (let i = 0; i < result.writeErrors.length; i++) { const writeError = { index: batch.originalIndexes[result.writeErrors[i].index], code: result.writeErrors[i].code, errmsg: result.writeErrors[i].errmsg, errInfo: result.writeErrors[i].errInfo, op: batch.operations[result.writeErrors[i].index] }; bulkResult.writeErrors.push(new WriteError(writeError)); } } Iif (result.writeConcernError) { bulkResult.writeConcernErrors.push(new WriteConcernError(result.writeConcernError)); } } async function executeCommands( bulkOperation: BulkOperationBase, options: BulkWriteOptions & { timeoutContext?: TimeoutContext | null } ): Promise<BulkWriteResult> { Iif (bulkOperation.s.batches.length === 0) { return new BulkWriteResult(bulkOperation.s.bulkResult, bulkOperation.isOrdered); } for (const batch of bulkOperation.s.batches) { const finalOptions = resolveOptions(bulkOperation, { ...options, ordered: bulkOperation.isOrdered }); if (finalOptions.bypassDocumentValidation !== true) { delete finalOptions.bypassDocumentValidation; } // Is the bypassDocumentValidation options specific if (bulkOperation.s.bypassDocumentValidation === true) { finalOptions.bypassDocumentValidation = true; } // Is the checkKeys option disabled Eif (bulkOperation.s.checkKeys === false) { finalOptions.checkKeys = false; } if (finalOptions.retryWrites) { if (isUpdateBatch(batch)) { finalOptions.retryWrites = finalOptions.retryWrites && !batch.operations.some(op => op.multi); } if (isDeleteBatch(batch)) { finalOptions.retryWrites = finalOptions.retryWrites && !batch.operations.some(op => op.limit === 0); } } const operation = isInsertBatch(batch) ? new InsertOperation(bulkOperation.s.namespace, batch.operations, finalOptions) : isUpdateBatch(batch) ? new UpdateOperation(bulkOperation.s.namespace, batch.operations, finalOptions) : isDeleteBatch(batch) ? new DeleteOperation(bulkOperation.s.namespace, batch.operations, finalOptions) : null; Iif (operation == null) throw new MongoRuntimeError(`Unknown batchType: ${batch.batchType}`); let thrownError = null; let result; try { result = await executeOperation( bulkOperation.s.collection.client, operation, finalOptions.timeoutContext ); } catch (error) { thrownError = error; } if (thrownError != null) { Iif (thrownError instanceof MongoWriteConcernError) { mergeBatchResults(batch, bulkOperation.s.bulkResult, thrownError, result); const writeResult = new BulkWriteResult( bulkOperation.s.bulkResult, bulkOperation.isOrdered ); throw new MongoBulkWriteError( { message: thrownError.result.writeConcernError.errmsg, code: thrownError.result.writeConcernError.code }, writeResult ); } else { // Error is a driver related error not a bulk op error, return early throw new MongoBulkWriteError( thrownError, new BulkWriteResult(bulkOperation.s.bulkResult, bulkOperation.isOrdered) ); } } mergeBatchResults(batch, bulkOperation.s.bulkResult, thrownError, result); const writeResult = new BulkWriteResult(bulkOperation.s.bulkResult, bulkOperation.isOrdered); bulkOperation.handleWriteError(writeResult); } bulkOperation.s.batches.length = 0; const writeResult = new BulkWriteResult(bulkOperation.s.bulkResult, bulkOperation.isOrdered); bulkOperation.handleWriteError(writeResult); return writeResult; } /** * An error indicating an unsuccessful Bulk Write * @public * @category Error */ export class MongoBulkWriteError extends MongoServerError { result: BulkWriteResult; writeErrors: OneOrMore<WriteError> = []; err?: WriteConcernError; /** * **Do not use this constructor!** * * Meant for internal use only. * * @remarks * This class is only meant to be constructed within the driver. This constructor is * not subject to semantic versioning compatibility guarantees and may change at any time. * * @public **/ constructor( error: | { message: string; code: number; writeErrors?: WriteError[] } | WriteConcernError | AnyError, result: BulkWriteResult ) { super(error); Iif (error instanceof WriteConcernError) this.err = error; else if (!(error instanceof Error)) { this.message = error.message; this.code = error.code; this.writeErrors = error.writeErrors ?? []; } this.result = result; Object.assign(this, error); } override get name(): string { return 'MongoBulkWriteError'; } /** Number of documents inserted. */ get insertedCount(): number { return this.result.insertedCount; } /** Number of documents matched for update. */ get matchedCount(): number { return this.result.matchedCount; } /** Number of documents modified. */ get modifiedCount(): number { return this.result.modifiedCount; } /** Number of documents deleted. */ get deletedCount(): number { return this.result.deletedCount; } /** Number of documents upserted. */ get upsertedCount(): number { return this.result.upsertedCount; } /** Inserted document generated Id's, hash key is the index of the originating operation */ get insertedIds(): { [key: number]: any } { return this.result.insertedIds; } /** Upserted document generated Id's, hash key is the index of the originating operation */ get upsertedIds(): { [key: number]: any } { return this.result.upsertedIds; } } /** * A builder object that is returned from {@link BulkOperationBase#find}. * Is used to build a write operation that involves a query filter. * * @public */ export class FindOperators { bulkOperation: BulkOperationBase; /** * Creates a new FindOperators object. * @internal */ constructor(bulkOperation: BulkOperationBase) { this.bulkOperation = bulkOperation; } /** Add a multiple update operation to the bulk operation */ update(updateDocument: Document | Document[]): BulkOperationBase { const currentOp = buildCurrentOp(this.bulkOperation); return this.bulkOperation.addToOperationsList( BatchType.UPDATE, makeUpdateStatement(currentOp.selector, updateDocument, { ...currentOp, multi: true }) ); } /** Add a single update operation to the bulk operation */ updateOne(updateDocument: Document | Document[]): BulkOperationBase { Iif (!hasAtomicOperators(updateDocument)) { throw new MongoInvalidArgumentError('Update document requires atomic operators'); } const currentOp = buildCurrentOp(this.bulkOperation); return this.bulkOperation.addToOperationsList( BatchType.UPDATE, makeUpdateStatement(currentOp.selector, updateDocument, { ...currentOp, multi: false }) ); } /** Add a replace one operation to the bulk operation */ replaceOne(replacement: Document): BulkOperationBase { Iif (hasAtomicOperators(replacement)) { throw new MongoInvalidArgumentError('Replacement document must not use atomic operators'); } const currentOp = buildCurrentOp(this.bulkOperation); return this.bulkOperation.addToOperationsList( BatchType.UPDATE, makeUpdateStatement(currentOp.selector, replacement, { ...currentOp, multi: false }) ); } /** Add a delete one operation to the bulk operation */ deleteOne(): BulkOperationBase { const currentOp = buildCurrentOp(this.bulkOperation); return this.bulkOperation.addToOperationsList( BatchType.DELETE, makeDeleteStatement(currentOp.selector, { ...currentOp, limit: 1 }) ); } /** Add a delete many operation to the bulk operation */ delete(): BulkOperationBase { const currentOp = buildCurrentOp(this.bulkOperation); return this.bulkOperation.addToOperationsList( BatchType.DELETE, makeDeleteStatement(currentOp.selector, { ...currentOp, limit: 0 }) ); } /** Upsert modifier for update bulk operation, noting that this operation is an upsert. */ upsert(): this { Iif (!this.bulkOperation.s.currentOp) { this.bulkOperation.s.currentOp = {}; } this.bulkOperation.s.currentOp.upsert = true; return this; } /** Specifies the collation for the query condition. */ collation(collation: CollationOptions): this { Iif (!this.bulkOperation.s.currentOp) { this.bulkOperation.s.currentOp = {}; } this.bulkOperation.s.currentOp.collation = collation; return this; } /** Specifies arrayFilters for UpdateOne or UpdateMany bulk operations. */ arrayFilters(arrayFilters: Document[]): this { Iif (!this.bulkOperation.s.currentOp) { this.bulkOperation.s.currentOp = {}; } this.bulkOperation.s.currentOp.arrayFilters = arrayFilters; return this; } /** Specifies hint for the bulk operation. */ hint(hint: Hint): this { Iif (!this.bulkOperation.s.currentOp) { this.bulkOperation.s.currentOp = {}; } this.bulkOperation.s.currentOp.hint = hint; return this; } } /** @internal */ export interface BulkOperationPrivate { bulkResult: BulkResult; currentBatch?: Batch; currentIndex: number; // ordered specific currentBatchSize: number; currentBatchSizeBytes: number; // unordered specific currentInsertBatch?: Batch; currentUpdateBatch?: Batch; currentRemoveBatch?: Batch; batches: Batch[]; // Write concern writeConcern?: WriteConcern; // Max batch size options maxBsonObjectSize: number; maxBatchSizeBytes: number; maxWriteBatchSize: number; maxKeySize: number; // Namespace namespace: MongoDBNamespace; // Topology topology: Topology; // Options options: BulkWriteOptions; // BSON options bsonOptions: BSONSerializeOptions; // Document used to build a bulk operation currentOp?: Document; // Executed executed: boolean; // Collection collection: Collection; // Fundamental error err?: AnyError; // check keys checkKeys: boolean; bypassDocumentValidation?: boolean; } /** @public */ export interface BulkWriteOptions extends CommandOperationOptions { /** * Allow driver to bypass schema validation. * @defaultValue `false` - documents will be validated by default **/ bypassDocumentValidation?: boolean; /** * If true, when an insert fails, don't execute the remaining writes. * If false, continue with remaining inserts when one fails. * @defaultValue `true` - inserts are ordered by default */ ordered?: boolean; /** * Force server to assign _id values instead of driver. * @defaultValue `false` - the driver generates `_id` fields by default **/ forceServerObjectId?: boolean; /** Map of parameter names and values that can be accessed using $$var (requires MongoDB 5.0). */ let?: Document; /** @internal */ timeoutContext?: TimeoutContext; } /** * TODO(NODE-4063) * BulkWrites merge complexity is implemented in executeCommands * This provides a vehicle to treat bulkOperations like any other operation (hence "shim") * We would like this logic to simply live inside the BulkWriteOperation class * @internal */ export class BulkWriteShimOperation extends AbstractOperation { bulkOperation: BulkOperationBase; constructor(bulkOperation: BulkOperationBase, options: BulkWriteOptions) { super(options); this.bulkOperation = bulkOperation; } get commandName(): string { return 'bulkWrite' as const; } async execute( _server: Server, session: ClientSession | undefined, timeoutContext: TimeoutContext ): Promise<any> { if (this.options.session == null) { // An implicit session could have been created by 'executeOperation' // So if we stick it on finalOptions here, each bulk operation // will use this same session, it'll be passed in the same way // an explicit session would be this.options.session = session; } return await executeCommands(this.bulkOperation, { ...this.options, timeoutContext }); } } /** @public */ export abstract class BulkOperationBase { isOrdered: boolean; /** @internal */ s: BulkOperationPrivate; operationId?: number; /** * Create a new OrderedBulkOperation or UnorderedBulkOperation instance * @internal */ constructor( private collection: Collection, options: BulkWriteOptions, isOrdered: boolean ) { // determine whether bulkOperation is ordered or unordered this.isOrdered = isOrdered; const topology = getTopology(collection); options = options == null ? {} : options; // TODO Bring from driver information in hello // Get the namespace for the write operations const namespace = collection.s.namespace; // Used to mark operation as executed const executed = false; // Current item const currentOp = undefined; // Set max byte size const hello = topology.lastHello(); // If we have autoEncryption on, batch-splitting must be done on 2mb chunks, but single documents // over 2mb are still allowed const usingAutoEncryption = !!(topology.s.options && topology.s.options.autoEncrypter); const maxBsonObjectSize = hello && hello.maxBsonObjectSize ? hello.maxBsonObjectSize : 1024 * 1024 * 16; const maxBatchSizeBytes = usingAutoEncryption ? 1024 * 1024 * 2 : maxBsonObjectSize; const maxWriteBatchSize = hello && hello.maxWriteBatchSize ? hello.maxWriteBatchSize : 1000; // Calculates the largest possible size of an Array key, represented as a BSON string // element. This calculation: // 1 byte for BSON type // # of bytes = length of (string representation of (maxWriteBatchSize - 1)) // + 1 bytes for null terminator const maxKeySize = (maxWriteBatchSize - 1).toString(10).length + 2; // Final options for retryable writes let finalOptions = Object.assign({}, options); finalOptions = applyRetryableWrites(finalOptions, collection.s.db); // Final results const bulkResult: BulkResult = { ok: 1, writeErrors: [], writeConcernErrors: [], insertedIds: [], nInserted: 0, nUpserted: 0, nMatched: 0, nModified: 0, nRemoved: 0, upserted: [] }; // Internal state this.s = { // Final result bulkResult, // Current batch state currentBatch: undefined, currentIndex: 0, // ordered specific currentBatchSize: 0, currentBatchSizeBytes: 0, // unordered specific currentInsertBatch: undefined, currentUpdateBatch: undefined, currentRemoveBatch: undefined, batches: [], // Write concern writeConcern: WriteConcern.fromOptions(options), // Max batch size options maxBsonObjectSize, maxBatchSizeBytes, maxWriteBatchSize, maxKeySize, // Namespace namespace, // Topology topology, // Options options: finalOptions, // BSON options bsonOptions: resolveBSONOptions(options), // Current operation currentOp, // Executed executed, // Collection collection, // Fundamental error err: undefined, // check keys checkKeys: typeof options.checkKeys === 'boolean' ? options.checkKeys : false }; // bypass Validation if (options.bypassDocumentValidation === true) { this.s.bypassDocumentValidation = true; } } /** * Add a single insert document to the bulk operation * * @example * ```ts * const bulkOp = collection.initializeOrderedBulkOp(); * * // Adds three inserts to the bulkOp. * bulkOp * .insert({ a: 1 }) * .insert({ b: 2 }) * .insert({ c: 3 }); * await bulkOp.execute(); * ``` */ insert(document: Document): BulkOperationBase { maybeAddIdToDocuments(this.collection, document, { forceServerObjectId: this.shouldForceServerObjectId() }); return this.addToOperationsList(BatchType.INSERT, document); } /** * Builds a find operation for an update/updateOne/delete/deleteOne/replaceOne. * Returns a builder object used to complete the definition of the operation. * * @example * ```ts * const bulkOp = collection.initializeOrderedBulkOp(); * * // Add an updateOne to the bulkOp * bulkOp.find({ a: 1 }).updateOne({ $set: { b: 2 } }); * * // Add an updateMany to the bulkOp * bulkOp.find({ c: 3 }).update({ $set: { d: 4 } }); * * // Add an upsert * bulkOp.find({ e: 5 }).upsert().updateOne({ $set: { f: 6 } }); * * // Add a deletion * bulkOp.find({ g: 7 }).deleteOne(); * * // Add a multi deletion * bulkOp.find({ h: 8 }).delete(); * * // Add a replaceOne * bulkOp.find({ i: 9 }).replaceOne({writeConcern: { j: 10 }}); * * // Update using a pipeline (requires Mongodb 4.2 or higher) * bulk.find({ k: 11, y: { $exists: true }, z: { $exists: true } }).updateOne([ * { $set: { total: { $sum: [ '$y', '$z' ] } } } * ]); * * // All of the ops will now be executed * await bulkOp.execute(); * ``` */ find(selector: Document): FindOperators { if (!selector) { throw new MongoInvalidArgumentError('Bulk find operation must specify a selector'); } // Save a current selector this.s.currentOp = { selector: selector }; return new FindOperators(this); } /** Specifies a raw operation to perform in the bulk write. */ raw(op: AnyBulkWriteOperation): this { if (op == null || typeof op !== 'object') { throw new MongoInvalidArgumentError('Operation must be an object with an operation key'); } if ('insertOne' in op) { const forceServerObjectId = this.shouldForceServerObjectId(); const document = op.insertOne && op.insertOne.document == null ? // TODO(NODE-6003): remove support for omitting the `documents` subdocument in bulk inserts (op.insertOne as Document) : op.insertOne.document; maybeAddIdToDocuments(this.collection, document, { forceServerObjectId }); return this.addToOperationsList(BatchType.INSERT, document); } if ('replaceOne' in op || 'updateOne' in op || 'updateMany' in op) { if ('replaceOne' in op) { Iif ('q' in op.replaceOne) { throw new MongoInvalidArgumentError('Raw operations are not allowed'); } const updateStatement = makeUpdateStatement( op.replaceOne.filter, op.replaceOne.replacement, { ...op.replaceOne, multi: false } ); if (hasAtomicOperators(updateStatement.u)) { throw new MongoInvalidArgumentError('Replacement document must not use atomic operators'); } return this.addToOperationsList(BatchType.UPDATE, updateStatement); } if ('updateOne' in op) { if ('q' in op.updateOne) { throw new MongoInvalidArgumentError('Raw operations are not allowed'); } const updateStatement = makeUpdateStatement(op.updateOne.filter, op.updateOne.update, { ...op.updateOne, multi: false }); if (!hasAtomicOperators(updateStatement.u)) { throw new MongoInvalidArgumentError('Update document requires atomic operators'); } return this.addToOperationsList(BatchType.UPDATE, updateStatement); } Eif ('updateMany' in op) { Iif ('q' in op.updateMany) { throw new MongoInvalidArgumentError('Raw operations are not allowed'); } const updateStatement = makeUpdateStatement(op.updateMany.filter, op.updateMany.update, { ...op.updateMany, multi: true }); if (!hasAtomicOperators(updateStatement.u)) { throw new MongoInvalidArgumentError('Update document requires atomic operators'); } return this.addToOperationsList(BatchType.UPDATE, updateStatement); } } if ('deleteOne' in op) { Iif ('q' in op.deleteOne) { throw new MongoInvalidArgumentError('Raw operations are not allowed'); } return this.addToOperationsList( BatchType.DELETE, makeDeleteStatement(op.deleteOne.filter, { ...op.deleteOne, limit: 1 }) ); } Eif ('deleteMany' in op) { Iif ('q' in op.deleteMany) { throw new MongoInvalidArgumentError('Raw operations are not allowed'); } return this.addToOperationsList( BatchType.DELETE, makeDeleteStatement(op.deleteMany.filter, { ...op.deleteMany, limit: 0 }) ); } // otherwise an unknown operation was provided throw new MongoInvalidArgumentError( 'bulkWrite only supports insertOne, updateOne, updateMany, deleteOne, deleteMany' ); } get length(): number { return this.s.currentIndex; } get bsonOptions(): BSONSerializeOptions { return this.s.bsonOptions; } get writeConcern(): WriteConcern | undefined { return this.s.writeConcern; } get batches(): Batch[] { const batches = [...this.s.batches]; if (this.isOrdered) { Eif (this.s.currentBatch) batches.push(this.s.currentBatch); } else { Eif (this.s.currentInsertBatch) batches.push(this.s.currentInsertBatch); Eif (this.s.currentUpdateBatch) batches.push(this.s.currentUpdateBatch); Iif (this.s.currentRemoveBatch) batches.push(this.s.currentRemoveBatch); } return batches; } async execute(options: BulkWriteOptions = {}): Promise<BulkWriteResult> { if (this.s.executed) { throw new MongoBatchReExecutionError(); } const writeConcern = WriteConcern.fromOptions(options); if (writeConcern) { this.s.writeConcern = writeConcern; } // If we have current batch if (this.isOrdered) { if (this.s.currentBatch) this.s.batches.push(this.s.currentBatch); } else { if (this.s.currentInsertBatch) this.s.batches.push(this.s.currentInsertBatch); if (this.s.currentUpdateBatch) this.s.batches.push(this.s.currentUpdateBatch); if (this.s.currentRemoveBatch) this.s.batches.push(this.s.currentRemoveBatch); } // If we have no operations in the bulk raise an error if (this.s.batches.length === 0) { throw new MongoInvalidArgumentError('Invalid BulkOperation, Batch cannot be empty'); } this.s.executed = true; const finalOptions = { ...this.s.options, ...options }; const operation = new BulkWriteShimOperation(this, finalOptions); return await executeOperation(this.s.collection.client, operation, finalOptions.timeoutContext); } /** * Handles the write error before executing commands * @internal */ handleWriteError(writeResult: BulkWriteResult): void { if (this.s.bulkResult.writeErrors.length > 0) { const msg = this.s.bulkResult.writeErrors[0].errmsg ? this.s.bulkResult.writeErrors[0].errmsg : 'write operation failed'; throw new MongoBulkWriteError( { message: msg, code: this.s.bulkResult.writeErrors[0].code, writeErrors: this.s.bulkResult.writeErrors }, writeResult ); } const writeConcernError = writeResult.getWriteConcernError(); Iif (writeConcernError) { throw new MongoBulkWriteError(writeConcernError, writeResult); } } abstract addToOperationsList( batchType: BatchType, document: Document | UpdateStatement | DeleteStatement ): this; private shouldForceServerObjectId(): boolean { return ( this.s.options.forceServerObjectId === true || this.s.collection.s.db.options?.forceServerObjectId === true ); } } function isInsertBatch(batch: Batch): boolean { return batch.batchType === BatchType.INSERT; } function isUpdateBatch(batch: Batch): batch is Batch<UpdateStatement> { return batch.batchType === BatchType.UPDATE; } function isDeleteBatch(batch: Batch): batch is Batch<DeleteStatement> { return batch.batchType === BatchType.DELETE; } function buildCurrentOp(bulkOp: BulkOperationBase): Document { let { currentOp } = bulkOp.s; bulkOp.s.currentOp = undefined; Iif (!currentOp) currentOp = {}; return currentOp; } |