@salesforce/plugin-data 4.0.21 → 4.0.22

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -441,83 +441,6 @@
441
441
  "search:data"
442
442
  ]
443
443
  },
444
- "data:bulk:results": {
445
- "aliases": [],
446
- "args": {},
447
- "description": "Use this command to get the complete results after running one of the CLI commands that uses Bulk API 2.0 to ingest (import, update, upsert, or delete) large datasets to your org, such as \"data import bulk\". The previously-run bulk command must have completed; if it's still processing, run the corresponding resume command first, such as \"data import resume.\" Make note of the job ID of the previous bulk command because you use it to run this command. \n\nYou can also use this command to get results from running a bulk ingest job with a different tool, such as Data Loader, as long as you have the job ID. For information on Data Loader, see https://developer.salesforce.com/docs/atlas.en-us.dataLoader.meta/dataLoader/data_loader_intro.htm. \n\nThis command first displays the status of the previous bulk job, the operation that was executed in the org (such as insert or hard delete), and the updated Salesforce object. The command then displays how many records were processed in total, and how many were successful or failed. Finally, the output displays the names of the generated CSV-formatted files that contain the specific results for each ingested record. Depending on the success or failure of the bulk command, the results files can include the IDs of inserted records or the specific errors. When possible, if the ingest job failed or was aborted, you also get a CSV file with the unprocessed results.",
448
- "examples": [
449
- "Get results from a bulk ingest job; use the org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --job-id 7507i000fake341G --target-org my-scratch"
450
- ],
451
- "flags": {
452
- "json": {
453
- "description": "Format output as json.",
454
- "helpGroup": "GLOBAL",
455
- "name": "json",
456
- "allowNo": false,
457
- "type": "boolean"
458
- },
459
- "flags-dir": {
460
- "helpGroup": "GLOBAL",
461
- "name": "flags-dir",
462
- "summary": "Import flag values from a directory.",
463
- "hasDynamicHelp": false,
464
- "multiple": false,
465
- "type": "option"
466
- },
467
- "job-id": {
468
- "char": "i",
469
- "name": "job-id",
470
- "required": true,
471
- "summary": "Job ID of the bulk job.",
472
- "hasDynamicHelp": false,
473
- "multiple": false,
474
- "type": "option"
475
- },
476
- "target-org": {
477
- "char": "o",
478
- "name": "target-org",
479
- "noCacheDefault": true,
480
- "required": true,
481
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
482
- "hasDynamicHelp": true,
483
- "multiple": false,
484
- "type": "option"
485
- },
486
- "api-version": {
487
- "description": "Override the api version used for api requests made by this command",
488
- "name": "api-version",
489
- "hasDynamicHelp": false,
490
- "multiple": false,
491
- "type": "option"
492
- }
493
- },
494
- "hasDynamicHelp": true,
495
- "hiddenAliases": [],
496
- "id": "data:bulk:results",
497
- "pluginAlias": "@salesforce/plugin-data",
498
- "pluginName": "@salesforce/plugin-data",
499
- "pluginType": "core",
500
- "strict": true,
501
- "summary": "Get the results of a bulk ingest job that you previously ran.",
502
- "enableJsonFlag": true,
503
- "isESM": true,
504
- "relativePath": [
505
- "lib",
506
- "commands",
507
- "data",
508
- "bulk",
509
- "results.js"
510
- ],
511
- "aliasPermutations": [],
512
- "permutations": [
513
- "data:bulk:results",
514
- "bulk:data:results",
515
- "bulk:results:data",
516
- "data:results:bulk",
517
- "results:data:bulk",
518
- "results:bulk:data"
519
- ]
520
- },
521
444
  "data:create:file": {
522
445
  "aliases": [],
523
446
  "args": {},
@@ -775,6 +698,83 @@
775
698
  "record:create:data"
776
699
  ]
777
700
  },
701
+ "data:bulk:results": {
702
+ "aliases": [],
703
+ "args": {},
704
+ "description": "Use this command to get the complete results after running one of the CLI commands that uses Bulk API 2.0 to ingest (import, update, upsert, or delete) large datasets to your org, such as \"data import bulk\". The previously-run bulk command must have completed; if it's still processing, run the corresponding resume command first, such as \"data import resume.\" Make note of the job ID of the previous bulk command because you use it to run this command. \n\nYou can also use this command to get results from running a bulk ingest job with a different tool, such as Data Loader, as long as you have the job ID. For information on Data Loader, see https://developer.salesforce.com/docs/atlas.en-us.dataLoader.meta/dataLoader/data_loader_intro.htm. \n\nThis command first displays the status of the previous bulk job, the operation that was executed in the org (such as insert or hard delete), and the updated Salesforce object. The command then displays how many records were processed in total, and how many were successful or failed. Finally, the output displays the names of the generated CSV-formatted files that contain the specific results for each ingested record. Depending on the success or failure of the bulk command, the results files can include the IDs of inserted records or the specific errors. When possible, if the ingest job failed or was aborted, you also get a CSV file with the unprocessed results.",
705
+ "examples": [
706
+ "Get results from a bulk ingest job; use the org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --job-id 7507i000fake341G --target-org my-scratch"
707
+ ],
708
+ "flags": {
709
+ "json": {
710
+ "description": "Format output as json.",
711
+ "helpGroup": "GLOBAL",
712
+ "name": "json",
713
+ "allowNo": false,
714
+ "type": "boolean"
715
+ },
716
+ "flags-dir": {
717
+ "helpGroup": "GLOBAL",
718
+ "name": "flags-dir",
719
+ "summary": "Import flag values from a directory.",
720
+ "hasDynamicHelp": false,
721
+ "multiple": false,
722
+ "type": "option"
723
+ },
724
+ "job-id": {
725
+ "char": "i",
726
+ "name": "job-id",
727
+ "required": true,
728
+ "summary": "Job ID of the bulk job.",
729
+ "hasDynamicHelp": false,
730
+ "multiple": false,
731
+ "type": "option"
732
+ },
733
+ "target-org": {
734
+ "char": "o",
735
+ "name": "target-org",
736
+ "noCacheDefault": true,
737
+ "required": true,
738
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
739
+ "hasDynamicHelp": true,
740
+ "multiple": false,
741
+ "type": "option"
742
+ },
743
+ "api-version": {
744
+ "description": "Override the api version used for api requests made by this command",
745
+ "name": "api-version",
746
+ "hasDynamicHelp": false,
747
+ "multiple": false,
748
+ "type": "option"
749
+ }
750
+ },
751
+ "hasDynamicHelp": true,
752
+ "hiddenAliases": [],
753
+ "id": "data:bulk:results",
754
+ "pluginAlias": "@salesforce/plugin-data",
755
+ "pluginName": "@salesforce/plugin-data",
756
+ "pluginType": "core",
757
+ "strict": true,
758
+ "summary": "Get the results of a bulk ingest job that you previously ran.",
759
+ "enableJsonFlag": true,
760
+ "isESM": true,
761
+ "relativePath": [
762
+ "lib",
763
+ "commands",
764
+ "data",
765
+ "bulk",
766
+ "results.js"
767
+ ],
768
+ "aliasPermutations": [],
769
+ "permutations": [
770
+ "data:bulk:results",
771
+ "bulk:data:results",
772
+ "bulk:results:data",
773
+ "data:results:bulk",
774
+ "results:data:bulk",
775
+ "results:bulk:data"
776
+ ]
777
+ },
778
778
  "data:delete:bulk": {
779
779
  "aliases": [],
780
780
  "args": {},
@@ -2403,13 +2403,13 @@
2403
2403
  "resume:query:data"
2404
2404
  ]
2405
2405
  },
2406
- "data:upsert:bulk": {
2406
+ "data:update:bulk": {
2407
2407
  "aliases": [],
2408
2408
  "args": {},
2409
- "description": "An upsert refers to inserting a record into a Salesforce object if the record doesn't already exist, or updating it if it does exist.\n\nWhen you execute this command, it starts a job, displays the ID, and then immediately returns control of the terminal to you by default. If you prefer to wait, set the --wait flag to the number of minutes; if it times out, the command outputs the IDs. Use the job and batch IDs to check the status of the job with the \"<%= config.bin %> data upsert resume\" command.\n\nSee \"Prepare CSV Files\" in the Bulk API Developer Guide for details on formatting your CSV file. (https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/datafiles_prepare_csv.htm)",
2409
+ "description": "You can use this command to update millions of Salesforce object records based on a file in comma-separated values (CSV) format.\n\nAll the records in the CSV file must be for the same Salesforce object. Specify the object with the `--sobject` flag. The first column of every line in the CSV file must be an ID of the record you want to update. The CSV file can contain only existing records; if a record in the file doesn't currently exist in the Salesforce object, the command fails. Consider using \"sf data upsert bulk\" if you also want to insert new records.\n\nBulk updates can take a while, depending on how many records are in the CSV file. If the command times out, or you specified the --async flag, the command displays the job ID. To see the status and get the results of the job, run \"sf data update resume\" and pass the job ID to the --job-id flag.\n\nFor information and examples about how to prepare your CSV files, see \"Prepare Data to Ingest\" in the \"Bulk API 2.0 and Bulk API Developer Guide\" (https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/datafiles_prepare_data.htm).",
2410
2410
  "examples": [
2411
- "Bulk upsert records to the Contact object in your default org:\n<%= config.bin %> <%= command.id %> --sobject Contact --file files/contacts.csv --external-id Id",
2412
- "Bulk upsert records to a custom object in an org with alias my-scratch and wait 5 minutes for the command to complete:\n<%= config.bin %> <%= command.id %> --sobject MyObject__c --file files/file.csv --external-id MyField__c --wait 5 --target-org my-scratch"
2411
+ "Update Account records from a CSV-formatted file into an org with alias \"my-scratch\"; if the update doesn't complete in 10 minutes, the command ends and displays a job ID:\n<%= config.bin %> <%= command.id %> --file accounts.csv --sobject Account --wait 10 --target-org my-scratch",
2412
+ "Update asynchronously and use the default org; the command immediately returns a job ID that you then pass to the \"sf data update resume\" command:\n<%= config.bin %> <%= command.id %> --file accounts.csv --sobject Account --async"
2413
2413
  ],
2414
2414
  "flags": {
2415
2415
  "json": {
@@ -2427,345 +2427,55 @@
2427
2427
  "multiple": false,
2428
2428
  "type": "option"
2429
2429
  },
2430
- "target-org": {
2431
- "aliases": [
2432
- "targetusername",
2433
- "u"
2434
- ],
2435
- "char": "o",
2436
- "deprecateAliases": true,
2437
- "name": "target-org",
2438
- "noCacheDefault": true,
2439
- "required": true,
2440
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
2441
- "hasDynamicHelp": true,
2442
- "multiple": false,
2443
- "type": "option"
2444
- },
2445
- "api-version": {
2446
- "aliases": [
2447
- "apiversion"
2448
- ],
2449
- "deprecateAliases": true,
2450
- "description": "Override the api version used for api requests made by this command",
2451
- "name": "api-version",
2452
- "hasDynamicHelp": false,
2453
- "multiple": false,
2454
- "type": "option"
2430
+ "async": {
2431
+ "char": "a",
2432
+ "name": "async",
2433
+ "summary": "Don't wait for the command to complete.",
2434
+ "allowNo": false,
2435
+ "type": "boolean"
2455
2436
  },
2456
- "loglevel": {
2457
- "deprecated": {
2458
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
2459
- },
2460
- "hidden": true,
2461
- "name": "loglevel",
2462
- "hasDynamicHelp": false,
2437
+ "wait": {
2438
+ "char": "w",
2439
+ "name": "wait",
2440
+ "summary": "Time to wait for the command to finish, in minutes.",
2441
+ "hasDynamicHelp": true,
2463
2442
  "multiple": false,
2464
2443
  "type": "option"
2465
2444
  },
2466
2445
  "file": {
2467
- "aliases": [
2468
- "csvfile"
2469
- ],
2470
2446
  "char": "f",
2471
- "deprecateAliases": true,
2472
2447
  "name": "file",
2473
2448
  "required": true,
2474
- "summary": "CSV file that contains the IDs of the records to update or delete.",
2449
+ "summary": "CSV file that contains the Salesforce object records you want to update.",
2475
2450
  "hasDynamicHelp": false,
2476
2451
  "multiple": false,
2477
2452
  "type": "option"
2478
2453
  },
2479
2454
  "sobject": {
2480
- "aliases": [
2481
- "sobjecttype"
2482
- ],
2483
2455
  "char": "s",
2484
- "deprecateAliases": true,
2485
2456
  "name": "sobject",
2486
2457
  "required": true,
2487
- "summary": "API name of the Salesforce object, either standard or custom, that you want to update or delete records from.",
2458
+ "summary": "API name of the Salesforce object, either standard or custom, which you are updating.",
2488
2459
  "hasDynamicHelp": false,
2489
2460
  "multiple": false,
2490
2461
  "type": "option"
2491
2462
  },
2492
- "wait": {
2493
- "char": "w",
2494
- "exclusive": [
2495
- "async"
2496
- ],
2497
- "name": "wait",
2498
- "summary": "Number of minutes to wait for the command to complete before displaying the results.",
2499
- "default": "0 minutes",
2500
- "hasDynamicHelp": true,
2463
+ "api-version": {
2464
+ "description": "Override the api version used for api requests made by this command",
2465
+ "name": "api-version",
2466
+ "hasDynamicHelp": false,
2501
2467
  "multiple": false,
2502
2468
  "type": "option"
2503
2469
  },
2504
- "async": {
2505
- "char": "a",
2506
- "exclusive": [
2507
- "wait"
2508
- ],
2509
- "name": "async",
2510
- "summary": "Run the command asynchronously.",
2511
- "allowNo": false,
2512
- "type": "boolean"
2513
- },
2514
- "line-ending": {
2515
- "dependsOn": [
2516
- "file"
2517
- ],
2518
- "name": "line-ending",
2519
- "summary": "Line ending used in the CSV file. Default value on Windows is `CRLF`; on macOS and Linux it's `LF`.",
2520
- "hasDynamicHelp": false,
2521
- "multiple": false,
2522
- "options": [
2523
- "CRLF",
2524
- "LF"
2525
- ],
2526
- "type": "option"
2527
- },
2528
- "column-delimiter": {
2529
- "name": "column-delimiter",
2530
- "summary": "Column delimiter used in the CSV file.",
2531
- "hasDynamicHelp": false,
2532
- "multiple": false,
2533
- "options": [
2534
- "BACKQUOTE",
2535
- "CARET",
2536
- "COMMA",
2537
- "PIPE",
2538
- "SEMICOLON",
2539
- "TAB"
2540
- ],
2541
- "type": "option"
2542
- },
2543
- "external-id": {
2544
- "aliases": [
2545
- "externalid"
2546
- ],
2547
- "char": "i",
2548
- "deprecateAliases": true,
2549
- "name": "external-id",
2550
- "required": true,
2551
- "summary": "Name of the external ID field, or the Id field.",
2552
- "hasDynamicHelp": false,
2553
- "multiple": false,
2554
- "type": "option"
2555
- }
2556
- },
2557
- "hasDynamicHelp": true,
2558
- "hiddenAliases": [],
2559
- "id": "data:upsert:bulk",
2560
- "pluginAlias": "@salesforce/plugin-data",
2561
- "pluginName": "@salesforce/plugin-data",
2562
- "pluginType": "core",
2563
- "strict": true,
2564
- "summary": "Bulk upsert records to an org from a CSV file. Uses Bulk API 2.0.",
2565
- "enableJsonFlag": true,
2566
- "isESM": true,
2567
- "relativePath": [
2568
- "lib",
2569
- "commands",
2570
- "data",
2571
- "upsert",
2572
- "bulk.js"
2573
- ],
2574
- "aliasPermutations": [],
2575
- "permutations": [
2576
- "data:upsert:bulk",
2577
- "upsert:data:bulk",
2578
- "upsert:bulk:data",
2579
- "data:bulk:upsert",
2580
- "bulk:data:upsert",
2581
- "bulk:upsert:data"
2582
- ]
2583
- },
2584
- "data:upsert:resume": {
2585
- "aliases": [],
2586
- "args": {},
2587
- "description": "The command uses the job ID returned from the \"<%= config.bin %> data upsert bulk\" command or the most recently-run bulk upsert job.",
2588
- "examples": [
2589
- "Resume a bulk upsert job from your default org using an ID:\n<%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA",
2590
- "Resume the most recently run bulk upsert job for an org with alias my-scratch:\n<%= config.bin %> <%= command.id %> --use-most-recent --target-org my-scratch"
2591
- ],
2592
- "flags": {
2593
- "json": {
2594
- "description": "Format output as json.",
2595
- "helpGroup": "GLOBAL",
2596
- "name": "json",
2597
- "allowNo": false,
2598
- "type": "boolean"
2599
- },
2600
- "flags-dir": {
2601
- "helpGroup": "GLOBAL",
2602
- "name": "flags-dir",
2603
- "summary": "Import flag values from a directory.",
2604
- "hasDynamicHelp": false,
2605
- "multiple": false,
2606
- "type": "option"
2607
- },
2608
- "target-org": {
2609
- "aliases": [
2610
- "targetusername",
2611
- "u"
2612
- ],
2613
- "char": "o",
2614
- "deprecateAliases": true,
2615
- "name": "target-org",
2616
- "noCacheDefault": true,
2617
- "summary": "Username or alias of the target org. Not required if the \"target-org\" configuration variable is already set.",
2618
- "hasDynamicHelp": true,
2619
- "multiple": false,
2620
- "type": "option"
2621
- },
2622
- "job-id": {
2623
- "aliases": [
2624
- "jobid"
2625
- ],
2626
- "char": "i",
2627
- "deprecateAliases": true,
2628
- "name": "job-id",
2629
- "summary": "ID of the job you want to resume.",
2630
- "hasDynamicHelp": false,
2631
- "multiple": false,
2632
- "type": "option"
2633
- },
2634
- "use-most-recent": {
2635
- "exclusive": [
2636
- "job-id"
2637
- ],
2638
- "name": "use-most-recent",
2639
- "summary": "Use the ID of the most recently-run bulk job.",
2640
- "allowNo": false,
2641
- "type": "boolean"
2642
- },
2643
- "wait": {
2644
- "name": "wait",
2645
- "summary": "Number of minutes to wait for the command to complete before displaying the results.",
2646
- "default": "5 minutes",
2647
- "hasDynamicHelp": true,
2648
- "multiple": false,
2649
- "type": "option"
2650
- },
2651
- "api-version": {
2652
- "description": "Override the api version used for api requests made by this command",
2653
- "name": "api-version",
2654
- "hasDynamicHelp": false,
2655
- "multiple": false,
2656
- "type": "option"
2657
- },
2658
- "loglevel": {
2659
- "deprecated": {
2660
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
2661
- },
2662
- "hidden": true,
2663
- "name": "loglevel",
2664
- "hasDynamicHelp": false,
2665
- "multiple": false,
2666
- "type": "option"
2667
- }
2668
- },
2669
- "hasDynamicHelp": true,
2670
- "hiddenAliases": [],
2671
- "id": "data:upsert:resume",
2672
- "pluginAlias": "@salesforce/plugin-data",
2673
- "pluginName": "@salesforce/plugin-data",
2674
- "pluginType": "core",
2675
- "strict": true,
2676
- "summary": "Resume a bulk upsert job that you previously started. Uses Bulk API 2.0.",
2677
- "enableJsonFlag": true,
2678
- "isESM": true,
2679
- "relativePath": [
2680
- "lib",
2681
- "commands",
2682
- "data",
2683
- "upsert",
2684
- "resume.js"
2685
- ],
2686
- "aliasPermutations": [],
2687
- "permutations": [
2688
- "data:upsert:resume",
2689
- "upsert:data:resume",
2690
- "upsert:resume:data",
2691
- "data:resume:upsert",
2692
- "resume:data:upsert",
2693
- "resume:upsert:data"
2694
- ]
2695
- },
2696
- "data:update:bulk": {
2697
- "aliases": [],
2698
- "args": {},
2699
- "description": "You can use this command to update millions of Salesforce object records based on a file in comma-separated values (CSV) format.\n\nAll the records in the CSV file must be for the same Salesforce object. Specify the object with the `--sobject` flag. The first column of every line in the CSV file must be an ID of the record you want to update. The CSV file can contain only existing records; if a record in the file doesn't currently exist in the Salesforce object, the command fails. Consider using \"sf data upsert bulk\" if you also want to insert new records.\n\nBulk updates can take a while, depending on how many records are in the CSV file. If the command times out, or you specified the --async flag, the command displays the job ID. To see the status and get the results of the job, run \"sf data update resume\" and pass the job ID to the --job-id flag.\n\nFor information and examples about how to prepare your CSV files, see \"Prepare Data to Ingest\" in the \"Bulk API 2.0 and Bulk API Developer Guide\" (https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/datafiles_prepare_data.htm).",
2700
- "examples": [
2701
- "Update Account records from a CSV-formatted file into an org with alias \"my-scratch\"; if the update doesn't complete in 10 minutes, the command ends and displays a job ID:\n<%= config.bin %> <%= command.id %> --file accounts.csv --sobject Account --wait 10 --target-org my-scratch",
2702
- "Update asynchronously and use the default org; the command immediately returns a job ID that you then pass to the \"sf data update resume\" command:\n<%= config.bin %> <%= command.id %> --file accounts.csv --sobject Account --async"
2703
- ],
2704
- "flags": {
2705
- "json": {
2706
- "description": "Format output as json.",
2707
- "helpGroup": "GLOBAL",
2708
- "name": "json",
2709
- "allowNo": false,
2710
- "type": "boolean"
2711
- },
2712
- "flags-dir": {
2713
- "helpGroup": "GLOBAL",
2714
- "name": "flags-dir",
2715
- "summary": "Import flag values from a directory.",
2716
- "hasDynamicHelp": false,
2717
- "multiple": false,
2718
- "type": "option"
2719
- },
2720
- "async": {
2721
- "char": "a",
2722
- "name": "async",
2723
- "summary": "Don't wait for the command to complete.",
2724
- "allowNo": false,
2725
- "type": "boolean"
2726
- },
2727
- "wait": {
2728
- "char": "w",
2729
- "name": "wait",
2730
- "summary": "Time to wait for the command to finish, in minutes.",
2731
- "hasDynamicHelp": true,
2732
- "multiple": false,
2733
- "type": "option"
2734
- },
2735
- "file": {
2736
- "char": "f",
2737
- "name": "file",
2738
- "required": true,
2739
- "summary": "CSV file that contains the Salesforce object records you want to update.",
2740
- "hasDynamicHelp": false,
2741
- "multiple": false,
2742
- "type": "option"
2743
- },
2744
- "sobject": {
2745
- "char": "s",
2746
- "name": "sobject",
2747
- "required": true,
2748
- "summary": "API name of the Salesforce object, either standard or custom, which you are updating.",
2749
- "hasDynamicHelp": false,
2750
- "multiple": false,
2751
- "type": "option"
2752
- },
2753
- "api-version": {
2754
- "description": "Override the api version used for api requests made by this command",
2755
- "name": "api-version",
2756
- "hasDynamicHelp": false,
2757
- "multiple": false,
2758
- "type": "option"
2759
- },
2760
- "target-org": {
2761
- "char": "o",
2762
- "name": "target-org",
2763
- "noCacheDefault": true,
2764
- "required": true,
2765
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
2766
- "hasDynamicHelp": true,
2767
- "multiple": false,
2768
- "type": "option"
2470
+ "target-org": {
2471
+ "char": "o",
2472
+ "name": "target-org",
2473
+ "noCacheDefault": true,
2474
+ "required": true,
2475
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
2476
+ "hasDynamicHelp": true,
2477
+ "multiple": false,
2478
+ "type": "option"
2769
2479
  },
2770
2480
  "line-ending": {
2771
2481
  "dependsOn": [
@@ -3080,6 +2790,296 @@
3080
2790
  "resume:update:data"
3081
2791
  ]
3082
2792
  },
2793
+ "data:upsert:bulk": {
2794
+ "aliases": [],
2795
+ "args": {},
2796
+ "description": "An upsert refers to inserting a record into a Salesforce object if the record doesn't already exist, or updating it if it does exist.\n\nWhen you execute this command, it starts a job, displays the ID, and then immediately returns control of the terminal to you by default. If you prefer to wait, set the --wait flag to the number of minutes; if it times out, the command outputs the IDs. Use the job and batch IDs to check the status of the job with the \"<%= config.bin %> data upsert resume\" command.\n\nSee \"Prepare CSV Files\" in the Bulk API Developer Guide for details on formatting your CSV file. (https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/datafiles_prepare_csv.htm)",
2797
+ "examples": [
2798
+ "Bulk upsert records to the Contact object in your default org:\n<%= config.bin %> <%= command.id %> --sobject Contact --file files/contacts.csv --external-id Id",
2799
+ "Bulk upsert records to a custom object in an org with alias my-scratch and wait 5 minutes for the command to complete:\n<%= config.bin %> <%= command.id %> --sobject MyObject__c --file files/file.csv --external-id MyField__c --wait 5 --target-org my-scratch"
2800
+ ],
2801
+ "flags": {
2802
+ "json": {
2803
+ "description": "Format output as json.",
2804
+ "helpGroup": "GLOBAL",
2805
+ "name": "json",
2806
+ "allowNo": false,
2807
+ "type": "boolean"
2808
+ },
2809
+ "flags-dir": {
2810
+ "helpGroup": "GLOBAL",
2811
+ "name": "flags-dir",
2812
+ "summary": "Import flag values from a directory.",
2813
+ "hasDynamicHelp": false,
2814
+ "multiple": false,
2815
+ "type": "option"
2816
+ },
2817
+ "target-org": {
2818
+ "aliases": [
2819
+ "targetusername",
2820
+ "u"
2821
+ ],
2822
+ "char": "o",
2823
+ "deprecateAliases": true,
2824
+ "name": "target-org",
2825
+ "noCacheDefault": true,
2826
+ "required": true,
2827
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
2828
+ "hasDynamicHelp": true,
2829
+ "multiple": false,
2830
+ "type": "option"
2831
+ },
2832
+ "api-version": {
2833
+ "aliases": [
2834
+ "apiversion"
2835
+ ],
2836
+ "deprecateAliases": true,
2837
+ "description": "Override the api version used for api requests made by this command",
2838
+ "name": "api-version",
2839
+ "hasDynamicHelp": false,
2840
+ "multiple": false,
2841
+ "type": "option"
2842
+ },
2843
+ "loglevel": {
2844
+ "deprecated": {
2845
+ "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
2846
+ },
2847
+ "hidden": true,
2848
+ "name": "loglevel",
2849
+ "hasDynamicHelp": false,
2850
+ "multiple": false,
2851
+ "type": "option"
2852
+ },
2853
+ "file": {
2854
+ "aliases": [
2855
+ "csvfile"
2856
+ ],
2857
+ "char": "f",
2858
+ "deprecateAliases": true,
2859
+ "name": "file",
2860
+ "required": true,
2861
+ "summary": "CSV file that contains the IDs of the records to update or delete.",
2862
+ "hasDynamicHelp": false,
2863
+ "multiple": false,
2864
+ "type": "option"
2865
+ },
2866
+ "sobject": {
2867
+ "aliases": [
2868
+ "sobjecttype"
2869
+ ],
2870
+ "char": "s",
2871
+ "deprecateAliases": true,
2872
+ "name": "sobject",
2873
+ "required": true,
2874
+ "summary": "API name of the Salesforce object, either standard or custom, that you want to update or delete records from.",
2875
+ "hasDynamicHelp": false,
2876
+ "multiple": false,
2877
+ "type": "option"
2878
+ },
2879
+ "wait": {
2880
+ "char": "w",
2881
+ "exclusive": [
2882
+ "async"
2883
+ ],
2884
+ "name": "wait",
2885
+ "summary": "Number of minutes to wait for the command to complete before displaying the results.",
2886
+ "default": "0 minutes",
2887
+ "hasDynamicHelp": true,
2888
+ "multiple": false,
2889
+ "type": "option"
2890
+ },
2891
+ "async": {
2892
+ "char": "a",
2893
+ "exclusive": [
2894
+ "wait"
2895
+ ],
2896
+ "name": "async",
2897
+ "summary": "Run the command asynchronously.",
2898
+ "allowNo": false,
2899
+ "type": "boolean"
2900
+ },
2901
+ "line-ending": {
2902
+ "dependsOn": [
2903
+ "file"
2904
+ ],
2905
+ "name": "line-ending",
2906
+ "summary": "Line ending used in the CSV file. Default value on Windows is `CRLF`; on macOS and Linux it's `LF`.",
2907
+ "hasDynamicHelp": false,
2908
+ "multiple": false,
2909
+ "options": [
2910
+ "CRLF",
2911
+ "LF"
2912
+ ],
2913
+ "type": "option"
2914
+ },
2915
+ "column-delimiter": {
2916
+ "name": "column-delimiter",
2917
+ "summary": "Column delimiter used in the CSV file.",
2918
+ "hasDynamicHelp": false,
2919
+ "multiple": false,
2920
+ "options": [
2921
+ "BACKQUOTE",
2922
+ "CARET",
2923
+ "COMMA",
2924
+ "PIPE",
2925
+ "SEMICOLON",
2926
+ "TAB"
2927
+ ],
2928
+ "type": "option"
2929
+ },
2930
+ "external-id": {
2931
+ "aliases": [
2932
+ "externalid"
2933
+ ],
2934
+ "char": "i",
2935
+ "deprecateAliases": true,
2936
+ "name": "external-id",
2937
+ "required": true,
2938
+ "summary": "Name of the external ID field, or the Id field.",
2939
+ "hasDynamicHelp": false,
2940
+ "multiple": false,
2941
+ "type": "option"
2942
+ }
2943
+ },
2944
+ "hasDynamicHelp": true,
2945
+ "hiddenAliases": [],
2946
+ "id": "data:upsert:bulk",
2947
+ "pluginAlias": "@salesforce/plugin-data",
2948
+ "pluginName": "@salesforce/plugin-data",
2949
+ "pluginType": "core",
2950
+ "strict": true,
2951
+ "summary": "Bulk upsert records to an org from a CSV file. Uses Bulk API 2.0.",
2952
+ "enableJsonFlag": true,
2953
+ "isESM": true,
2954
+ "relativePath": [
2955
+ "lib",
2956
+ "commands",
2957
+ "data",
2958
+ "upsert",
2959
+ "bulk.js"
2960
+ ],
2961
+ "aliasPermutations": [],
2962
+ "permutations": [
2963
+ "data:upsert:bulk",
2964
+ "upsert:data:bulk",
2965
+ "upsert:bulk:data",
2966
+ "data:bulk:upsert",
2967
+ "bulk:data:upsert",
2968
+ "bulk:upsert:data"
2969
+ ]
2970
+ },
2971
+ "data:upsert:resume": {
2972
+ "aliases": [],
2973
+ "args": {},
2974
+ "description": "The command uses the job ID returned from the \"<%= config.bin %> data upsert bulk\" command or the most recently-run bulk upsert job.",
2975
+ "examples": [
2976
+ "Resume a bulk upsert job from your default org using an ID:\n<%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA",
2977
+ "Resume the most recently run bulk upsert job for an org with alias my-scratch:\n<%= config.bin %> <%= command.id %> --use-most-recent --target-org my-scratch"
2978
+ ],
2979
+ "flags": {
2980
+ "json": {
2981
+ "description": "Format output as json.",
2982
+ "helpGroup": "GLOBAL",
2983
+ "name": "json",
2984
+ "allowNo": false,
2985
+ "type": "boolean"
2986
+ },
2987
+ "flags-dir": {
2988
+ "helpGroup": "GLOBAL",
2989
+ "name": "flags-dir",
2990
+ "summary": "Import flag values from a directory.",
2991
+ "hasDynamicHelp": false,
2992
+ "multiple": false,
2993
+ "type": "option"
2994
+ },
2995
+ "target-org": {
2996
+ "aliases": [
2997
+ "targetusername",
2998
+ "u"
2999
+ ],
3000
+ "char": "o",
3001
+ "deprecateAliases": true,
3002
+ "name": "target-org",
3003
+ "noCacheDefault": true,
3004
+ "summary": "Username or alias of the target org. Not required if the \"target-org\" configuration variable is already set.",
3005
+ "hasDynamicHelp": true,
3006
+ "multiple": false,
3007
+ "type": "option"
3008
+ },
3009
+ "job-id": {
3010
+ "aliases": [
3011
+ "jobid"
3012
+ ],
3013
+ "char": "i",
3014
+ "deprecateAliases": true,
3015
+ "name": "job-id",
3016
+ "summary": "ID of the job you want to resume.",
3017
+ "hasDynamicHelp": false,
3018
+ "multiple": false,
3019
+ "type": "option"
3020
+ },
3021
+ "use-most-recent": {
3022
+ "exclusive": [
3023
+ "job-id"
3024
+ ],
3025
+ "name": "use-most-recent",
3026
+ "summary": "Use the ID of the most recently-run bulk job.",
3027
+ "allowNo": false,
3028
+ "type": "boolean"
3029
+ },
3030
+ "wait": {
3031
+ "name": "wait",
3032
+ "summary": "Number of minutes to wait for the command to complete before displaying the results.",
3033
+ "default": "5 minutes",
3034
+ "hasDynamicHelp": true,
3035
+ "multiple": false,
3036
+ "type": "option"
3037
+ },
3038
+ "api-version": {
3039
+ "description": "Override the api version used for api requests made by this command",
3040
+ "name": "api-version",
3041
+ "hasDynamicHelp": false,
3042
+ "multiple": false,
3043
+ "type": "option"
3044
+ },
3045
+ "loglevel": {
3046
+ "deprecated": {
3047
+ "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
3048
+ },
3049
+ "hidden": true,
3050
+ "name": "loglevel",
3051
+ "hasDynamicHelp": false,
3052
+ "multiple": false,
3053
+ "type": "option"
3054
+ }
3055
+ },
3056
+ "hasDynamicHelp": true,
3057
+ "hiddenAliases": [],
3058
+ "id": "data:upsert:resume",
3059
+ "pluginAlias": "@salesforce/plugin-data",
3060
+ "pluginName": "@salesforce/plugin-data",
3061
+ "pluginType": "core",
3062
+ "strict": true,
3063
+ "summary": "Resume a bulk upsert job that you previously started. Uses Bulk API 2.0.",
3064
+ "enableJsonFlag": true,
3065
+ "isESM": true,
3066
+ "relativePath": [
3067
+ "lib",
3068
+ "commands",
3069
+ "data",
3070
+ "upsert",
3071
+ "resume.js"
3072
+ ],
3073
+ "aliasPermutations": [],
3074
+ "permutations": [
3075
+ "data:upsert:resume",
3076
+ "upsert:data:resume",
3077
+ "upsert:resume:data",
3078
+ "data:resume:upsert",
3079
+ "resume:data:upsert",
3080
+ "resume:upsert:data"
3081
+ ]
3082
+ },
3083
3083
  "force:data:bulk:delete": {
3084
3084
  "aliases": [],
3085
3085
  "args": {},
@@ -3517,5 +3517,5 @@
3517
3517
  ]
3518
3518
  }
3519
3519
  },
3520
- "version": "4.0.21"
3520
+ "version": "4.0.22"
3521
3521
  }