@salesforce/plugin-data 2.5.14 → 2.5.16

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.
package/README.md CHANGED
@@ -92,14 +92,6 @@ sf plugins
92
92
  - [`sf force:data:bulk:delete`](#sf-forcedatabulkdelete)
93
93
  - [`sf force:data:bulk:status`](#sf-forcedatabulkstatus)
94
94
  - [`sf force:data:bulk:upsert`](#sf-forcedatabulkupsert)
95
- - [`sf force:data:record:create`](#sf-forcedatarecordcreate)
96
- - [`sf force:data:record:delete`](#sf-forcedatarecorddelete)
97
- - [`sf force:data:record:get`](#sf-forcedatarecordget)
98
- - [`sf force:data:record:update`](#sf-forcedatarecordupdate)
99
- - [`sf force:data:soql:bulk:report`](#sf-forcedatasoqlbulkreport)
100
- - [`sf force:data:soql:query`](#sf-forcedatasoqlquery)
101
- - [`sf force:data:tree:export`](#sf-forcedatatreeexport)
102
- - [`sf force:data:tree:import`](#sf-forcedatatreeimport)
103
95
 
104
96
  ## `sf data:create:record`
105
97
 
@@ -110,7 +102,7 @@ USAGE
110
102
  $ sf data:create:record -o <value> -s <value> -v <value> [--json] [--api-version <value>] [-t]
111
103
 
112
104
  FLAGS
113
- -o, --target-org=<value> (required) Org alias or username to use for the target org.
105
+ -o, --target-org=<value> (required) Username or alias of the target org.
114
106
  -s, --sobject=<value> (required) API name of the Salesforce or Tooling API object that you're inserting a record
115
107
  into.
116
108
  -t, --use-tooling-api Use Tooling API so you can insert a record in a Tooling API object.
@@ -153,7 +145,7 @@ EXAMPLES
153
145
  TracedEntityId=01p17000000R6bLAAS"
154
146
  ```
155
147
 
156
- _See code: [src/commands/data/create/record.ts](https://github.com/salesforcecli/plugin-data/blob/v2.5.4/src/commands/data/create/record.ts)_
148
+ _See code: [src/commands/data/create/record.ts](https://github.com/salesforcecli/plugin-data/blob/2.5.16/src/commands/data/create/record.ts)_
157
149
 
158
150
  ## `sf data:delete:bulk`
159
151
 
@@ -166,7 +158,7 @@ USAGE
166
158
  FLAGS
167
159
  -a, --async Run the command asynchronously.
168
160
  -f, --file=<value> (required) CSV file that contains the IDs of the records to delete.
169
- -o, --target-org=<value> (required) Org alias or username to use for the target org.
161
+ -o, --target-org=<value> (required) Username or alias of the target org.
170
162
  -s, --sobject=<value> (required) API name of the Salesforce object, either standard or custom, that you want to
171
163
  delete records from.
172
164
  -w, --wait=<value> [default: 0 minutes] Number of minutes to wait for the command to complete before displaying
@@ -197,7 +189,7 @@ EXAMPLES
197
189
  $ sf data:delete:bulk --sobject MyObject__c --file files/delete.csv --wait 5 --target-org my-scratch
198
190
  ```
199
191
 
200
- _See code: [src/commands/data/delete/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/v2.5.4/src/commands/data/delete/bulk.ts)_
192
+ _See code: [src/commands/data/delete/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/2.5.16/src/commands/data/delete/bulk.ts)_
201
193
 
202
194
  ## `sf data:delete:record`
203
195
 
@@ -209,7 +201,7 @@ USAGE
209
201
 
210
202
  FLAGS
211
203
  -i, --record-id=<value> ID of the record you’re deleting.
212
- -o, --target-org=<value> (required) Org alias or username to use for the target org.
204
+ -o, --target-org=<value> (required) Username or alias of the target org.
213
205
  -s, --sobject=<value> (required) API name of the Salesforce or Tooling API object that you're deleting a record
214
206
  from.
215
207
  -t, --use-tooling-api Use Tooling API so you can delete a record from a Tooling API object.
@@ -255,7 +247,7 @@ EXAMPLES
255
247
  $ sf data:delete:record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
256
248
  ```
257
249
 
258
- _See code: [src/commands/data/delete/record.ts](https://github.com/salesforcecli/plugin-data/blob/v2.5.4/src/commands/data/delete/record.ts)_
250
+ _See code: [src/commands/data/delete/record.ts](https://github.com/salesforcecli/plugin-data/blob/2.5.16/src/commands/data/delete/record.ts)_
259
251
 
260
252
  ## `sf data:delete:resume`
261
253
 
@@ -292,7 +284,7 @@ EXAMPLES
292
284
  $ sf data:delete:resume --use-most-recent --target-org my-scratch
293
285
  ```
294
286
 
295
- _See code: [src/commands/data/delete/resume.ts](https://github.com/salesforcecli/plugin-data/blob/v2.5.4/src/commands/data/delete/resume.ts)_
287
+ _See code: [src/commands/data/delete/resume.ts](https://github.com/salesforcecli/plugin-data/blob/2.5.16/src/commands/data/delete/resume.ts)_
296
288
 
297
289
  ## `sf data:export:tree`
298
290
 
@@ -304,7 +296,7 @@ USAGE
304
296
 
305
297
  FLAGS
306
298
  -d, --output-dir=<value> Directory in which to generate the JSON files; default is current directory.
307
- -o, --target-org=<value> (required) Org alias or username to use for the target org.
299
+ -o, --target-org=<value> (required) Username or alias of the target org.
308
300
  -p, --plan Generate multiple sObject tree files and a plan definition file for aggregated import.
309
301
  -q, --query=<value> (required) SOQL query, or filepath of a file that contains the query, to retrieve records.
310
302
  -x, --prefix=<value> Prefix of generated files.
@@ -335,7 +327,7 @@ EXAMPLES
335
327
  Export records retrieved with the specified SOQL query into a single JSON file in the current directory; the command
336
328
  uses your default org:
337
329
 
338
- $ sf data:export:tree --query "SELECT Id, Name, (SELECT Name, Address__c FROM Properties**r) FROM Broker__c"
330
+ $ sf data:export:tree --query "SELECT Id, Name, (SELECT Name, Address__c FROM Properties__r) FROM Broker__c"
339
331
 
340
332
  Export data using a SOQL query in the "query.txt" file and generate JSON files for each object and a plan that
341
333
  aggregates them:
@@ -349,7 +341,7 @@ EXAMPLES
349
341
  my-scratch
350
342
  ```
351
343
 
352
- _See code: [src/commands/data/export/tree.ts](https://github.com/salesforcecli/plugin-data/blob/v2.5.4/src/commands/data/export/tree.ts)_
344
+ _See code: [src/commands/data/export/tree.ts](https://github.com/salesforcecli/plugin-data/blob/2.5.16/src/commands/data/export/tree.ts)_
353
345
 
354
346
  ## `sf data:get:record`
355
347
 
@@ -361,7 +353,7 @@ USAGE
361
353
 
362
354
  FLAGS
363
355
  -i, --record-id=<value> ID of the record you’re retrieving.
364
- -o, --target-org=<value> (required) Org alias or username to use for the target org.
356
+ -o, --target-org=<value> (required) Username or alias of the target org.
365
357
  -s, --sobject=<value> (required) API name of the Salesforce or Tooling API object that you're retrieving a record
366
358
  from.
367
359
  -t, --use-tooling-api Use Tooling API so you can retrieve a record from a Tooling API object.
@@ -410,7 +402,7 @@ EXAMPLES
410
402
  $ sf data:get:record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
411
403
  ```
412
404
 
413
- _See code: [src/commands/data/get/record.ts](https://github.com/salesforcecli/plugin-data/blob/v2.5.4/src/commands/data/get/record.ts)_
405
+ _See code: [src/commands/data/get/record.ts](https://github.com/salesforcecli/plugin-data/blob/2.5.16/src/commands/data/get/record.ts)_
414
406
 
415
407
  ## `sf data:import:tree`
416
408
 
@@ -423,7 +415,7 @@ USAGE
423
415
  FLAGS
424
416
  -f, --files=<value>... Comma-separated and in-order JSON files that contain the records, in sObject tree format,
425
417
  that you want to insert.
426
- -o, --target-org=<value> (required) Org alias or username to use for the target org.
418
+ -o, --target-org=<value> (required) Username or alias of the target org.
427
419
  -p, --plan=<value> Plan definition file to insert multiple data files.
428
420
  --api-version=<value> Override the api version used for api requests made by this command
429
421
  --config-help Display schema information for the --plan configuration file to stdout; if you specify this
@@ -460,7 +452,7 @@ EXAMPLES
460
452
  $ sf data:import:tree --plan Account-Contact-plan.json
461
453
  ```
462
454
 
463
- _See code: [src/commands/data/import/tree.ts](https://github.com/salesforcecli/plugin-data/blob/v2.5.4/src/commands/data/import/tree.ts)_
455
+ _See code: [src/commands/data/import/tree.ts](https://github.com/salesforcecli/plugin-data/blob/2.5.16/src/commands/data/import/tree.ts)_
464
456
 
465
457
  ## `sf data:query`
466
458
 
@@ -474,7 +466,7 @@ USAGE
474
466
  FLAGS
475
467
  -b, --bulk Use Bulk API 2.0 to run the query.
476
468
  -f, --file=<value> File that contains the SOQL query.
477
- -o, --target-org=<value> (required) Org alias or username to use for the target org.
469
+ -o, --target-org=<value> (required) Username or alias of the target org.
478
470
  -q, --query=<value> SOQL query to execute.
479
471
  -r, --result-format=<option> [default: human] Format to display the results; the --json flag overrides this flag.
480
472
  <options: human|json|csv>
@@ -522,7 +514,7 @@ EXAMPLES
522
514
  $ sf data:query --query "SELECT Id FROM Contact" --bulk --wait 0
523
515
  ```
524
516
 
525
- _See code: [src/commands/data/query.ts](https://github.com/salesforcecli/plugin-data/blob/v2.5.4/src/commands/data/query.ts)_
517
+ _See code: [src/commands/data/query.ts](https://github.com/salesforcecli/plugin-data/blob/2.5.16/src/commands/data/query.ts)_
526
518
 
527
519
  ## `sf data:query:resume`
528
520
 
@@ -558,7 +550,7 @@ EXAMPLES
558
550
  $ sf data:query:resume --bulk-query-id 7500x000005BdFzXXX
559
551
  ```
560
552
 
561
- _See code: [src/commands/data/query/resume.ts](https://github.com/salesforcecli/plugin-data/blob/v2.5.4/src/commands/data/query/resume.ts)_
553
+ _See code: [src/commands/data/query/resume.ts](https://github.com/salesforcecli/plugin-data/blob/2.5.16/src/commands/data/query/resume.ts)_
562
554
 
563
555
  ## `sf data:resume`
564
556
 
@@ -571,7 +563,7 @@ USAGE
571
563
  FLAGS
572
564
  -b, --batch-id=<value> ID of the batch whose status you want to view; you must also specify the job ID.
573
565
  -i, --job-id=<value> (required) ID of the job whose status you want to view.
574
- -o, --target-org=<value> (required) Org alias or username to use for the target org.
566
+ -o, --target-org=<value> (required) Username or alias of the target org.
575
567
  --api-version=<value> Override the api version used for api requests made by this command
576
568
 
577
569
  GLOBAL FLAGS
@@ -593,7 +585,7 @@ EXAMPLES
593
585
  $ sf data:resume --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA
594
586
  ```
595
587
 
596
- _See code: [src/commands/data/resume.ts](https://github.com/salesforcecli/plugin-data/blob/v2.5.4/src/commands/data/resume.ts)_
588
+ _See code: [src/commands/data/resume.ts](https://github.com/salesforcecli/plugin-data/blob/2.5.16/src/commands/data/resume.ts)_
597
589
 
598
590
  ## `sf data:update:record`
599
591
 
@@ -606,7 +598,7 @@ USAGE
606
598
 
607
599
  FLAGS
608
600
  -i, --record-id=<value> ID of the record you’re updating.
609
- -o, --target-org=<value> (required) Org alias or username to use for the target org.
601
+ -o, --target-org=<value> (required) Username or alias of the target org.
610
602
  -s, --sobject=<value> (required) API name of the Salesforce or Tooling API object that contains the record you're
611
603
  updating.
612
604
  -t, --use-tooling-api Use Tooling API so you can update a record in a Tooling API object.
@@ -653,7 +645,7 @@ EXAMPLES
653
645
  "ExpirationDate=2017-12-01T00:58:04.000+0000"
654
646
  ```
655
647
 
656
- _See code: [src/commands/data/update/record.ts](https://github.com/salesforcecli/plugin-data/blob/v2.5.4/src/commands/data/update/record.ts)_
648
+ _See code: [src/commands/data/update/record.ts](https://github.com/salesforcecli/plugin-data/blob/2.5.16/src/commands/data/update/record.ts)_
657
649
 
658
650
  ## `sf data:upsert:bulk`
659
651
 
@@ -668,7 +660,7 @@ FLAGS
668
660
  -a, --async Run the command asynchronously.
669
661
  -f, --file=<value> (required) CSV file that contains the IDs of the records to delete.
670
662
  -i, --external-id=<value> (required) Name of the external ID field, or the Id field.
671
- -o, --target-org=<value> (required) Org alias or username to use for the target org.
663
+ -o, --target-org=<value> (required) Username or alias of the target org.
672
664
  -s, --sobject=<value> (required) API name of the Salesforce object, either standard or custom, that you want to
673
665
  delete records from.
674
666
  -w, --wait=<value> [default: 0 minutes] Number of minutes to wait for the command to complete before
@@ -704,7 +696,7 @@ EXAMPLES
704
696
  my-scratch
705
697
  ```
706
698
 
707
- _See code: [src/commands/data/upsert/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/v2.5.4/src/commands/data/upsert/bulk.ts)_
699
+ _See code: [src/commands/data/upsert/bulk.ts](https://github.com/salesforcecli/plugin-data/blob/2.5.16/src/commands/data/upsert/bulk.ts)_
708
700
 
709
701
  ## `sf data:upsert:resume`
710
702
 
@@ -741,7 +733,7 @@ EXAMPLES
741
733
  $ sf data:upsert:resume --use-most-recent --target-org my-scratch
742
734
  ```
743
735
 
744
- _See code: [src/commands/data/upsert/resume.ts](https://github.com/salesforcecli/plugin-data/blob/v2.5.4/src/commands/data/upsert/resume.ts)_
736
+ _See code: [src/commands/data/upsert/resume.ts](https://github.com/salesforcecli/plugin-data/blob/2.5.16/src/commands/data/upsert/resume.ts)_
745
737
 
746
738
  ## `sf force:data:bulk:delete`
747
739
 
@@ -753,7 +745,7 @@ USAGE
753
745
 
754
746
  FLAGS
755
747
  -f, --file=<value> (required) CSV file that contains the IDs of the records to delete.
756
- -o, --target-org=<value> (required) Org alias or username to use for the target org.
748
+ -o, --target-org=<value> (required) Username or alias of the target org.
757
749
  -s, --sobject=<value> (required) API name of the Salesforce object, either standard or custom, that you want to
758
750
  delete records from.
759
751
  -w, --wait=<value> [default: 0 minutes] Number of minutes to wait for the command to complete before displaying
@@ -785,7 +777,7 @@ EXAMPLES
785
777
  $ sf force:data:bulk:delete --sobject MyObject__c --file files/delete.csv --wait 5 --target-org my-scratch
786
778
  ```
787
779
 
788
- _See code: [src/commands/force/data/bulk/delete.ts](https://github.com/salesforcecli/plugin-data/blob/v2.5.4/src/commands/force/data/bulk/delete.ts)_
780
+ _See code: [src/commands/force/data/bulk/delete.ts](https://github.com/salesforcecli/plugin-data/blob/2.5.16/src/commands/force/data/bulk/delete.ts)_
789
781
 
790
782
  ## `sf force:data:bulk:status`
791
783
 
@@ -798,7 +790,7 @@ USAGE
798
790
  FLAGS
799
791
  -b, --batch-id=<value> ID of the batch whose status you want to view; you must also specify the job ID.
800
792
  -i, --job-id=<value> (required) ID of the job whose status you want to view.
801
- -o, --target-org=<value> (required) Org alias or username to use for the target org.
793
+ -o, --target-org=<value> (required) Username or alias of the target org.
802
794
  --api-version=<value> Override the api version used for api requests made by this command
803
795
 
804
796
  GLOBAL FLAGS
@@ -820,7 +812,7 @@ EXAMPLES
820
812
  $ sf force:data:bulk:status --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA --target-org my-scratch
821
813
  ```
822
814
 
823
- _See code: [src/commands/force/data/bulk/status.ts](https://github.com/salesforcecli/plugin-data/blob/v2.5.4/src/commands/force/data/bulk/status.ts)_
815
+ _See code: [src/commands/force/data/bulk/status.ts](https://github.com/salesforcecli/plugin-data/blob/2.5.16/src/commands/force/data/bulk/status.ts)_
824
816
 
825
817
  ## `sf force:data:bulk:upsert`
826
818
 
@@ -834,7 +826,7 @@ USAGE
834
826
  FLAGS
835
827
  -f, --file=<value> (required) CSV file that contains the records to upsert.
836
828
  -i, --external-id=<value> (required) Name of the external ID field, or the Id field.
837
- -o, --target-org=<value> (required) Org alias or username to use for the target org.
829
+ -o, --target-org=<value> (required) Username or alias of the target org.
838
830
  -r, --serial Run batches in serial mode.
839
831
  -s, --sobject=<value> (required) API name of the Salesforce object, either standard or custom, that you want to
840
832
  upsert records to.
@@ -876,430 +868,6 @@ EXAMPLES
876
868
  --target-org my-scratch
877
869
  ```
878
870
 
879
- _See code: [src/commands/force/data/bulk/upsert.ts](https://github.com/salesforcecli/plugin-data/blob/v2.5.4/src/commands/force/data/bulk/upsert.ts)_
880
-
881
- ## `sf force:data:record:create`
882
-
883
- Create and insert a record into a Salesforce or Tooling API object.
884
-
885
- ```
886
- USAGE
887
- $ sf force:data:record:create -o <value> -s <value> -v <value> [--json] [--api-version <value>] [-t]
888
-
889
- FLAGS
890
- -o, --target-org=<value> (required) Org alias or username to use for the target org.
891
- -s, --sobject=<value> (required) API name of the Salesforce or Tooling API object that you're inserting a record
892
- into.
893
- -t, --use-tooling-api Use Tooling API so you can insert a record in a Tooling API object.
894
- -v, --values=<value> (required) Values for the flags in the form <fieldName>=<value>, separate multiple pairs
895
- with spaces.
896
- --api-version=<value> Override the api version used for api requests made by this command
897
-
898
- GLOBAL FLAGS
899
- --json Format output as json.
900
-
901
- DESCRIPTION
902
- Create and insert a record into a Salesforce or Tooling API object.
903
-
904
- You must specify a value for all required fields of the object.
905
-
906
- When specifying fields, use the format <fieldName>=<value>. Enclose all field-value pairs in one set of double
907
- quotation marks, delimited by spaces. Enclose values that contain spaces in single quotes.
908
-
909
- This command inserts a record into Salesforce objects by default. Use the --use-tooling-api flag to insert into a
910
- Tooling API object.
911
-
912
- ALIASES
913
- $ sf force:data:record:create
914
-
915
- EXAMPLES
916
- Insert a record into the Account object of your default org; only the required Name field has a value:
917
-
918
- $ sf force:data:record:create --sobject Account --values "Name=Acme"
919
-
920
- Insert an Account record with values for two fields, one value contains a space; the command uses the org with alias
921
- "my-scratch":
922
-
923
- $ sf force:data:record:create --sobject Account --values "Name='Universal Containers' Website=www.example.com" \
924
- --target-org my-scratch
925
-
926
- Insert a record into the Tooling API object TraceFlag:
927
-
928
- $ sf force:data:record:create --use-tooling-api --sobject TraceFlag --values "DebugLevelId=7dl170000008U36AAE \
929
- StartDate=2022-12-15T00:26:04.000+0000 ExpirationDate=2022-12-15T00:56:04.000+0000 LogType=CLASS_TRACING \
930
- TracedEntityId=01p17000000R6bLAAS"
931
- ```
932
-
933
- ## `sf force:data:record:delete`
934
-
935
- Deletes a single record from a Salesforce or Tooling API object.
936
-
937
- ```
938
- USAGE
939
- $ sf force:data:record:delete -o <value> -s <value> [--json] [--api-version <value>] [-i <value>] [-w <value>] [-t]
940
-
941
- FLAGS
942
- -i, --record-id=<value> ID of the record you’re deleting.
943
- -o, --target-org=<value> (required) Org alias or username to use for the target org.
944
- -s, --sobject=<value> (required) API name of the Salesforce or Tooling API object that you're deleting a record
945
- from.
946
- -t, --use-tooling-api Use Tooling API so you can delete a record from a Tooling API object.
947
- -w, --where=<value> List of <fieldName>=<value> pairs that identify the record you want to delete.
948
- --api-version=<value> Override the api version used for api requests made by this command
949
-
950
- GLOBAL FLAGS
951
- --json Format output as json.
952
-
953
- DESCRIPTION
954
- Deletes a single record from a Salesforce or Tooling API object.
955
-
956
- Specify the record you want to delete with either its ID or with a list of field-value pairs that identify the record.
957
- If your list of fields identifies more than one record, the delete fails; the error displays how many records were
958
- found.
959
-
960
- When specifying field-value pairs, use the format <fieldName>=<value>. Enclose all field-value pairs in one set of
961
- double quotation marks, delimited by spaces. Enclose values that contain spaces in single quotes.
962
-
963
- This command deletes a record from Salesforce objects by default. Use the --use-tooling-api flag to delete from a
964
- Tooling API object.
965
-
966
- ALIASES
967
- $ sf force:data:record:delete
968
-
969
- EXAMPLES
970
- Delete a record from Account with the specified (truncated) ID:
971
-
972
- $ sf force:data:record:delete --sobject Account --record-id 00180XX
973
-
974
- Delete a record from Account whose name equals "Acme":
975
-
976
- $ sf force:data:record:delete --sobject Account --where "Name=Acme"
977
-
978
- Delete a record from Account identified with two field values, one that contains a space; the command uses the org
979
- with alias "my-scratch":
980
-
981
- $ sf force:data:record:delete --sobject Account --where "Name='Universal Containers' Phone='(123) 456-7890'" \
982
- --target-org myscratch
983
-
984
- Delete a record from the Tooling API object TraceFlag with the specified (truncated) ID:
985
-
986
- $ sf force:data:record:delete --use-tooling-api --sobject TraceFlag --record-id 7tf8c
987
- ```
988
-
989
- ## `sf force:data:record:get`
990
-
991
- Retrieve and display a single record of a Salesforce or Tooling API object.
992
-
993
- ```
994
- USAGE
995
- $ sf force:data:record:get -o <value> -s <value> [--json] [--api-version <value>] [-i <value>] [-w <value>] [-t]
996
-
997
- FLAGS
998
- -i, --record-id=<value> ID of the record you’re retrieving.
999
- -o, --target-org=<value> (required) Org alias or username to use for the target org.
1000
- -s, --sobject=<value> (required) API name of the Salesforce or Tooling API object that you're retrieving a record
1001
- from.
1002
- -t, --use-tooling-api Use Tooling API so you can retrieve a record from a Tooling API object.
1003
- -w, --where=<value> List of <fieldName>=<value> pairs that identify the record you want to display.
1004
- --api-version=<value> Override the api version used for api requests made by this command
1005
-
1006
- GLOBAL FLAGS
1007
- --json Format output as json.
1008
-
1009
- DESCRIPTION
1010
- Retrieve and display a single record of a Salesforce or Tooling API object.
1011
-
1012
- Specify the record you want to retrieve with either its ID or with a list of field-value pairs that identify the
1013
- record. If your list of fields identifies more than one record, the command fails; the error displays how many records
1014
- were found.
1015
-
1016
- When specifying field-value pairs, use the format <fieldName>=<value>. Enclose all field-value pairs in one set of
1017
- double quotation marks, delimited by spaces. Enclose values that contain spaces in single quotes.
1018
-
1019
- The command displays all the record's fields and their values, one field per terminal line. Fields with no values are
1020
- displayed as "null".
1021
-
1022
- This command retrieves a record from Salesforce objects by default. Use the --use-tooling-api flag to retrieve from a
1023
- Tooling API object.
1024
-
1025
- ALIASES
1026
- $ sf force:data:record:get
1027
-
1028
- EXAMPLES
1029
- Retrieve and display a record from Account with the specified (truncated) ID:
1030
-
1031
- $ sf force:data:record:get --sobject Account --record-id 00180XX
1032
-
1033
- Retrieve a record from Account whose name equals "Acme":
1034
-
1035
- $ sf force:data:record:get --sobject Account --where "Name=Acme"
1036
-
1037
- Retrieve a record from Account identified with two field values, one that contains a space; the command uses the org
1038
- with alias "my-scratch":
1039
-
1040
- $ sf force:data:record:get --sobject Account --where "Name='Universal Containers' Phone='(123) 456-7890'" \
1041
- --target-org myscratch
1042
-
1043
- Retrieve a record from the Tooling API object TraceFlag with the specified (truncated) ID:
1044
-
1045
- $ sf force:data:record:get --use-tooling-api --sobject TraceFlag --record-id 7tf8c
1046
- ```
1047
-
1048
- ## `sf force:data:record:update`
1049
-
1050
- Updates a single record of a Salesforce or Tooling API object.
1051
-
1052
- ```
1053
- USAGE
1054
- $ sf force:data:record:update -o <value> -s <value> -v <value> [--json] [--api-version <value>] [-i <value>] [-w <value>]
1055
- [-t]
1056
-
1057
- FLAGS
1058
- -i, --record-id=<value> ID of the record you’re updating.
1059
- -o, --target-org=<value> (required) Org alias or username to use for the target org.
1060
- -s, --sobject=<value> (required) API name of the Salesforce or Tooling API object that contains the record you're
1061
- updating.
1062
- -t, --use-tooling-api Use Tooling API so you can update a record in a Tooling API object.
1063
- -v, --values=<value> (required) Fields that you're updating, in the format of <fieldName>=<value> pairs.
1064
- -w, --where=<value> List of <fieldName>=<value> pairs that identify the record you want to update.
1065
- --api-version=<value> Override the api version used for api requests made by this command
1066
-
1067
- GLOBAL FLAGS
1068
- --json Format output as json.
1069
-
1070
- DESCRIPTION
1071
- Updates a single record of a Salesforce or Tooling API object.
1072
-
1073
- Specify the record you want to update with either its ID or with a list of field-value pairs that identify the record.
1074
- If your list of fields identifies more than one record, the delete fails; the error displays how many records were
1075
- found.
1076
-
1077
- When using field-value pairs for both identifying the record and specifiyng the new field values, use the format
1078
- <fieldName>=<value>. Enclose all field-value pairs in one set of double quotation marks, delimited by spaces. Enclose
1079
- values that contain spaces in single quotes.
1080
-
1081
- This command updates a record in Salesforce objects by default. Use the --use-tooling-api flag to update a Tooling API
1082
- object.
1083
-
1084
- ALIASES
1085
- $ sf force:data:record:update
1086
-
1087
- EXAMPLES
1088
- Update the Name field of an Account record with the specified (truncated) ID:
1089
-
1090
- $ sf force:data:record:update --sobject Account --record-id 001D0 --values "Name=NewAcme"
1091
-
1092
- Update the Name field of an Account record whose current name is 'Old Acme':
1093
-
1094
- $ sf force:data:record:update --sobject Account --where "Name='Old Acme'" --values "Name='New Acme'"
1095
-
1096
- Update the Name and Website fields of an Account record with the specified (truncated) ID:
1097
-
1098
- $ sf force:data:record:update --sobject Account --record-id 001D0 --values "Name='Acme III' \
1099
- Website=www.example.com"
1100
-
1101
- Update the ExpirationDate field of a record of the Tooling API object TraceFlag using the specified (truncated) ID:
1102
-
1103
- $ sf force:data:record:update -t --sobject TraceFlag --record-id 7tf170000009cUBAAY --values \
1104
- "ExpirationDate=2017-12-01T00:58:04.000+0000"
1105
- ```
1106
-
1107
- ## `sf force:data:soql:bulk:report`
1108
-
1109
- View the status of a bulk query.
1110
-
1111
- ```
1112
- USAGE
1113
- $ sf force:data:soql:bulk:report [--json] [-o <value>] [--api-version <value>] [-r human|json|csv] [--use-most-recent | -i
1114
- <value>]
1115
-
1116
- FLAGS
1117
- -i, --bulk-query-id=<value> Job ID of the bulk query.
1118
- -o, --target-org=<value> Org alias or username to use for the target org.
1119
- -r, --result-format=<option> [default: human] Format to display the results; the --json flag overrides this flag.
1120
- <options: human|json|csv>
1121
- --api-version=<value> Override the api version used for api requests made by this command
1122
- --use-most-recent Use the most recent bulk query ID from cache.
1123
-
1124
- GLOBAL FLAGS
1125
- --json Format output as json.
1126
-
1127
- DESCRIPTION
1128
- View the status of a bulk query.
1129
-
1130
- Run this command using the job ID returned from the "sf data query --bulk" command.
1131
-
1132
- ALIASES
1133
- $ sf force:data:soql:bulk:report
1134
-
1135
- EXAMPLES
1136
- View the status of a bulk query with the specified ID:
1137
-
1138
- $ sf force:data:soql:bulk:report --bulk-query-id 7500x000005BdFzXXX
1139
- ```
1140
-
1141
- ## `sf force:data:soql:query`
1142
-
1143
- Execute a SOQL query.
1144
-
1145
- ```
1146
- USAGE
1147
- $ sf force:data:soql:query -o <value> [--json] [--api-version <value>] [-q <value>] [-f <value>] [-w <value> [-b | -t]]
1148
- [--async ] [--all-rows] [-r human|json|csv]
1149
-
1150
- FLAGS
1151
- -b, --bulk Use Bulk API 2.0 to run the query.
1152
- -f, --file=<value> File that contains the SOQL query.
1153
- -o, --target-org=<value> (required) Org alias or username to use for the target org.
1154
- -q, --query=<value> SOQL query to execute.
1155
- -r, --result-format=<option> [default: human] Format to display the results; the --json flag overrides this flag.
1156
- <options: human|json|csv>
1157
- -t, --use-tooling-api Use Tooling API so you can run queries on Tooling API objects.
1158
- -w, --wait=<value> Time to wait for the command to finish, in minutes.
1159
- --all-rows Include deleted records. By default, deleted records are not returned.
1160
- --api-version=<value> Override the api version used for api requests made by this command
1161
- --async Use Bulk API 2.0, but don't wait for the job to complete.
1162
-
1163
- GLOBAL FLAGS
1164
- --json Format output as json.
1165
-
1166
- DESCRIPTION
1167
- Execute a SOQL query.
1168
-
1169
- Specify the SOQL query at the command line with the --query flag or read the query from a file with the --file flag.
1170
-
1171
- If your query returns more than 10,000 records, specify the --bulk flag. The command then runs the query using Bulk
1172
- API 2.0, which has higher limits than the default API used by the command.
1173
-
1174
- When using --bulk, the command waits 3 minutes by default for the query to complete. Use the --wait parameter to
1175
- specify a different number of minutes to wait, or set --wait to 0 to immediately return control to the terminal. If
1176
- you set --wait to 0, or you use the --async flag, or the command simply times out, the command displays an ID. Pass
1177
- this ID to the the "data query resume" command using the --bulk-query-id flag to get the results; pass the ID to the
1178
- "data resume" command to get the job status.
1179
-
1180
- ALIASES
1181
- $ sf force:data:soql:query
1182
-
1183
- EXAMPLES
1184
- Specify a SOQL query at the command line; the command uses your default org:
1185
-
1186
- $ sf force:data:soql:query --query "SELECT Id, Name, Account.Name FROM Contact"
1187
-
1188
- Read the SOQL query from a file called "query.txt"; the command uses the org with alias "my-scratch":
1189
-
1190
- $ sf force:data:soql:query --file query.txt --target-org my-scratch
1191
-
1192
- Use Tooling API to run a query on the ApexTrigger Tooling API object:
1193
-
1194
- $ sf force:data:soql:query --query "SELECT Name FROM ApexTrigger" --use-tooling-api
1195
-
1196
- Use Bulk API 2.0 to run a query that returns many rows, and return control to the terminal immediately:
1197
-
1198
- $ sf force:data:soql:query --query "SELECT Id FROM Contact" --bulk --wait 0
1199
- ```
1200
-
1201
- ## `sf force:data:tree:export`
1202
-
1203
- Export data from an org into one or more JSON files.
1204
-
1205
- ```
1206
- USAGE
1207
- $ sf force:data:tree:export -o <value> -q <value> [--json] [--api-version <value>] [-p] [-x <value>] [-d <value>]
1208
-
1209
- FLAGS
1210
- -d, --output-dir=<value> Directory in which to generate the JSON files; default is current directory.
1211
- -o, --target-org=<value> (required) Org alias or username to use for the target org.
1212
- -p, --plan Generate multiple sObject tree files and a plan definition file for aggregated import.
1213
- -q, --query=<value> (required) SOQL query, or filepath of a file that contains the query, to retrieve records.
1214
- -x, --prefix=<value> Prefix of generated files.
1215
- --api-version=<value> Override the api version used for api requests made by this command
1216
-
1217
- GLOBAL FLAGS
1218
- --json Format output as json.
1219
-
1220
- DESCRIPTION
1221
- Export data from an org into one or more JSON files.
1222
-
1223
- Specify a SOQL query, either directly at the command line or read from a file, to retrieve the data you want to
1224
- export. The exported data is written to JSON files in sObject tree format, which is a collection of nested,
1225
- parent-child records with a single root record. Use these JSON files to import data into an org with the "sf data
1226
- import tree" command.
1227
-
1228
- If your SOQL query references multiple objects, the command generates a single JSON file by default. You can specify
1229
- the --plan flag to generate separate JSON files for each object and a plan definition file that aggregates them. You
1230
- then specify just this plan definition file when you import the data into an org.
1231
-
1232
- The SOQL query can return a maximum of 2,000 records. For more information, see the REST API Developer Guide.
1233
- (https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobject_tree.htm).
1234
-
1235
- ALIASES
1236
- $ sf force:data:tree:export
1237
-
1238
- EXAMPLES
1239
- Export records retrieved with the specified SOQL query into a single JSON file in the current directory; the command
1240
- uses your default org:
1241
-
1242
- $ sf force:data:tree:export --query "SELECT Id, Name, (SELECT Name, Address__c FROM Properties**r) FROM \
1243
- Broker__c"
1244
-
1245
- Export data using a SOQL query in the "query.txt" file and generate JSON files for each object and a plan that
1246
- aggregates them:
1247
-
1248
- $ sf force:data:tree:export --query query.txt --plan
1249
-
1250
- Prepend "export-demo" before each generated file and generate the files in the "export-out" directory; run the
1251
- command on the org with alias "my-scratch":
1252
-
1253
- $ sf force:data:tree:export --query query.txt --plan --prefix export-demo --output-dir export-out --target-org \
1254
- my-scratch
1255
- ```
1256
-
1257
- ## `sf force:data:tree:import`
1258
-
1259
- Import data from one or more JSON files into an org.
1260
-
1261
- ```
1262
- USAGE
1263
- $ sf force:data:tree:import -o <value> [--json] [--api-version <value>] [-f <value> | -p <value>] [--config-help]
1264
-
1265
- FLAGS
1266
- -f, --files=<value>... Comma-separated and in-order JSON files that contain the records, in sObject tree format,
1267
- that you want to insert.
1268
- -o, --target-org=<value> (required) Org alias or username to use for the target org.
1269
- -p, --plan=<value> Plan definition file to insert multiple data files.
1270
- --api-version=<value> Override the api version used for api requests made by this command
1271
- --config-help Display schema information for the --plan configuration file to stdout; if you specify this
1272
- flag, all other flags except --json are ignored.
1273
-
1274
- GLOBAL FLAGS
1275
- --json Format output as json.
1276
-
1277
- DESCRIPTION
1278
- Import data from one or more JSON files into an org.
1279
-
1280
- The JSON files that contain the data are in sObject tree format, which is a collection of nested, parent-child records
1281
- with a single root record. Use the "sf data export tree" command to generate these JSON files.
1282
-
1283
- If you used the --plan flag when exporting the data to generate a plan definition file, use the --plan flag to
1284
- reference the file when you import. If you're not using a plan, use the --files flag to list the files. If you specify
1285
- multiple JSON files that depend on each other in a parent-child relationship, be sure you list them in the correct
1286
- order.
1287
-
1288
- The sObject Tree API supports requests that contain up to 200 records. For more information, see the REST API
1289
- Developer Guide.
1290
- (https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobject_tree.htm)
1291
-
1292
- ALIASES
1293
- $ sf force:data:tree:import
1294
-
1295
- EXAMPLES
1296
- Import the records contained in two JSON files into the org with alias "my-scratch":
1297
-
1298
- $ sf force:data:tree:import --files Contact.json,Account.json --target-org my-scratch
1299
-
1300
- Import records using a plan definition file into your default org:
1301
-
1302
- $ sf force:data:tree:import --plan Account-Contact-plan.json
1303
- ```
871
+ _See code: [src/commands/force/data/bulk/upsert.ts](https://github.com/salesforcecli/plugin-data/blob/2.5.16/src/commands/force/data/bulk/upsert.ts)_
1304
872
 
1305
873
  <!-- commandsstop -->
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "2.5.14",
2
+ "version": "2.5.16",
3
3
  "commands": {
4
4
  "data:query": {
5
5
  "id": "data:query",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@salesforce/plugin-data",
3
- "version": "2.5.14",
3
+ "version": "2.5.16",
4
4
  "description": "Plugin for salesforce data commands",
5
5
  "author": "Salesforce",
6
6
  "main": "lib/index.js",
@@ -106,10 +106,10 @@
106
106
  },
107
107
  "dependencies": {
108
108
  "@oclif/core": "^2.15.0",
109
- "@salesforce/core": "^5.2.10",
109
+ "@salesforce/core": "^5.3.1",
110
110
  "@salesforce/kit": "^3.0.9",
111
111
  "@salesforce/sf-plugins-core": "^3.1.23",
112
- "@salesforce/ts-types": "^2.0.6",
112
+ "@salesforce/ts-types": "^2.0.8",
113
113
  "chalk": "^4.1.0",
114
114
  "csv-parse": "^4.16.3",
115
115
  "csv-stringify": "^6.4.0",
@@ -122,17 +122,17 @@
122
122
  "@salesforce/dev-config": "^4.0.1",
123
123
  "@salesforce/dev-scripts": "^5.10.0",
124
124
  "@salesforce/plugin-command-reference": "^3.0.33",
125
- "@salesforce/plugin-settings": "^1.4.29",
125
+ "@salesforce/plugin-settings": "^1.4.33",
126
126
  "@salesforce/prettier-config": "^0.0.3",
127
127
  "@salesforce/ts-sinon": "^1.4.14",
128
128
  "@swc/core": "1.3.31",
129
129
  "@types/chai-as-promised": "^7.1.6",
130
- "@types/shelljs": "^0.8.10",
130
+ "@types/shelljs": "^0.8.13",
131
131
  "@typescript-eslint/eslint-plugin": "^5.62.0",
132
132
  "@typescript-eslint/parser": "^5.62.0",
133
- "chai": "^4.3.8",
133
+ "chai": "^4.3.10",
134
134
  "chai-as-promised": "^7.1.1",
135
- "eslint": "^8.49.0",
135
+ "eslint": "^8.50.0",
136
136
  "eslint-config-prettier": "^8.9.0",
137
137
  "eslint-config-salesforce": "^2.0.2",
138
138
  "eslint-config-salesforce-license": "^0.2.0",
@@ -140,11 +140,11 @@
140
140
  "eslint-plugin-header": "^3.1.1",
141
141
  "eslint-plugin-import": "^2.28.0",
142
142
  "eslint-plugin-jsdoc": "^44.2.7",
143
- "eslint-plugin-sf-plugin": "^1.16.5",
143
+ "eslint-plugin-sf-plugin": "^1.16.9",
144
144
  "husky": "^7.0.4",
145
145
  "mocha": "^9.1.3",
146
146
  "nyc": "^15.1.0",
147
- "oclif": "^3.15.0",
147
+ "oclif": "^3.17.2",
148
148
  "prettier": "^2.8.8",
149
149
  "pretty-quick": "^3.1.0",
150
150
  "shelljs": "~0.8.4",
@@ -260,7 +260,7 @@
260
260
  }
261
261
  },
262
262
  "sfdx": {
263
- "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-data/2.5.14.crt",
264
- "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-data/2.5.14.sig"
263
+ "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-data/2.5.16.crt",
264
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-data/2.5.16.sig"
265
265
  }
266
266
  }