@salesforce/plugin-schema 2.3.26 → 2.3.28
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 +54 -39
- package/oclif.manifest.json +1 -1
- package/package.json +11 -11
package/README.md
CHANGED
|
@@ -70,74 +70,89 @@ sfdx plugins
|
|
|
70
70
|
|
|
71
71
|
<!-- commands -->
|
|
72
72
|
|
|
73
|
-
- [`sfdx
|
|
74
|
-
- [`sfdx
|
|
73
|
+
- [`sfdx sobject:describe`](#sfdx-sobjectdescribe)
|
|
74
|
+
- [`sfdx sobject:list`](#sfdx-sobjectlist)
|
|
75
75
|
|
|
76
|
-
## `sfdx
|
|
76
|
+
## `sfdx sobject:describe`
|
|
77
77
|
|
|
78
|
-
|
|
78
|
+
Display the metadata for a standard or custom object or a Tooling API object.
|
|
79
79
|
|
|
80
80
|
```
|
|
81
81
|
USAGE
|
|
82
|
-
$ sfdx
|
|
83
|
-
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
|
|
82
|
+
$ sfdx sobject:describe -o <value> -s <value> [--json] [--api-version <value>] [-t]
|
|
84
83
|
|
|
85
84
|
FLAGS
|
|
86
|
-
-
|
|
87
|
-
|
|
88
|
-
-t, --
|
|
89
|
-
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
--json format output as json
|
|
94
|
-
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
|
|
95
|
-
this command invocation
|
|
85
|
+
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
86
|
+
-s, --sobject=<value> (required) API name of the object to describe.
|
|
87
|
+
-t, --use-tooling-api Use Tooling API to display metadata for Tooling API objects.
|
|
88
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
89
|
+
|
|
90
|
+
GLOBAL FLAGS
|
|
91
|
+
--json Format output as json.
|
|
96
92
|
|
|
97
93
|
DESCRIPTION
|
|
98
|
-
|
|
94
|
+
Display the metadata for a standard or custom object or a Tooling API object.
|
|
95
|
+
|
|
96
|
+
The metadata is displayed in JSON format. See this topic for a description of each property: https://developer.salesfo
|
|
97
|
+
rce.com/docs/atlas.en-us.api.meta/api/sforce_api_calls_describesobjects_describesobjectresult.htm.
|
|
98
|
+
|
|
99
|
+
This command displays metadata for Salesforce objects by default. Use the --use-tooling-api flag to view metadata for
|
|
100
|
+
a Tooling API object.
|
|
101
|
+
|
|
102
|
+
ALIASES
|
|
103
|
+
$ sfdx force:schema:sobject:describe
|
|
99
104
|
|
|
100
105
|
EXAMPLES
|
|
101
|
-
|
|
106
|
+
Display the metadata of the "Account" standard object in your default org:
|
|
107
|
+
|
|
108
|
+
$ sfdx sobject:describe --sobject Account
|
|
109
|
+
|
|
110
|
+
Display the metadata of the "MyObject__c" custom object in the org with alias "my-scratch-org":
|
|
102
111
|
|
|
103
|
-
|
|
112
|
+
$ sfdx sobject:describe --sobject MyObject__c --target-org my-scratch-org
|
|
104
113
|
|
|
105
|
-
|
|
114
|
+
Display the metadata of the ApexCodeCoverage Tooling API object in your default org:
|
|
115
|
+
|
|
116
|
+
$ sfdx sobject:describe --sobject ApexCodeCoverage --use-tooling-api
|
|
106
117
|
```
|
|
107
118
|
|
|
108
|
-
_See code: [src/commands/
|
|
119
|
+
_See code: [src/commands/sobject/describe.ts](https://github.com/salesforcecli/plugin-schema/blob/2.3.28/src/commands/sobject/describe.ts)_
|
|
109
120
|
|
|
110
|
-
## `sfdx
|
|
121
|
+
## `sfdx sobject:list`
|
|
111
122
|
|
|
112
|
-
|
|
123
|
+
List all Salesforce objects of a specified category.
|
|
113
124
|
|
|
114
125
|
```
|
|
115
126
|
USAGE
|
|
116
|
-
$ sfdx
|
|
117
|
-
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
|
|
127
|
+
$ sfdx sobject:list -o <value> [--json] [--api-version <value>] [-s <value>]
|
|
118
128
|
|
|
119
129
|
FLAGS
|
|
120
|
-
-
|
|
121
|
-
|
|
122
|
-
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
--json format output as json
|
|
127
|
-
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
|
|
128
|
-
this command invocation
|
|
130
|
+
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
131
|
+
-s, --sobject=<value> [default: ALL] Category of objects to list.
|
|
132
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
133
|
+
|
|
134
|
+
GLOBAL FLAGS
|
|
135
|
+
--json Format output as json.
|
|
129
136
|
|
|
130
137
|
DESCRIPTION
|
|
131
|
-
|
|
138
|
+
List all Salesforce objects of a specified category.
|
|
139
|
+
|
|
140
|
+
You can list the standard objects, custom objects, or all. The lists include only Salesforce objects, not Tooling API
|
|
141
|
+
objects.
|
|
142
|
+
|
|
143
|
+
ALIASES
|
|
144
|
+
$ sfdx force:schema:sobject:list
|
|
132
145
|
|
|
133
146
|
EXAMPLES
|
|
134
|
-
|
|
147
|
+
List all objects in your default org:
|
|
148
|
+
|
|
149
|
+
$ sfdx sobject:list --sobject all
|
|
135
150
|
|
|
136
|
-
|
|
151
|
+
List only custom objects in the org with alias "my-scratch-org":
|
|
137
152
|
|
|
138
|
-
|
|
153
|
+
$ sfdx sobject:list --sobject custom --target-org my-scratch-org
|
|
139
154
|
```
|
|
140
155
|
|
|
141
|
-
_See code: [src/commands/
|
|
156
|
+
_See code: [src/commands/sobject/list.ts](https://github.com/salesforcecli/plugin-schema/blob/2.3.28/src/commands/sobject/list.ts)_
|
|
142
157
|
|
|
143
158
|
<!-- commandsstop -->
|
package/oclif.manifest.json
CHANGED
package/package.json
CHANGED
|
@@ -1,30 +1,30 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@salesforce/plugin-schema",
|
|
3
3
|
"description": "Commands to interact with salesforce sobject schemas",
|
|
4
|
-
"version": "2.3.
|
|
4
|
+
"version": "2.3.28",
|
|
5
5
|
"author": "Salesforce",
|
|
6
6
|
"main": "lib/index.js",
|
|
7
7
|
"bugs": "https://github.com/forcedotcom/cli/issues",
|
|
8
8
|
"dependencies": {
|
|
9
9
|
"@oclif/core": "^2.15.0",
|
|
10
|
-
"@salesforce/core": "^5.2.
|
|
11
|
-
"@salesforce/sf-plugins-core": "^3.1.
|
|
10
|
+
"@salesforce/core": "^5.2.10",
|
|
11
|
+
"@salesforce/sf-plugins-core": "^3.1.23",
|
|
12
12
|
"tslib": "^2"
|
|
13
13
|
},
|
|
14
14
|
"devDependencies": {
|
|
15
15
|
"@oclif/plugin-command-snapshot": "^4.0.14",
|
|
16
16
|
"@oclif/plugin-help": "^5.2.19",
|
|
17
|
-
"@salesforce/cli-plugins-testkit": "^4.3.
|
|
17
|
+
"@salesforce/cli-plugins-testkit": "^4.3.6",
|
|
18
18
|
"@salesforce/dev-config": "^4.0.1",
|
|
19
19
|
"@salesforce/dev-scripts": "^5.10.0",
|
|
20
|
-
"@salesforce/plugin-command-reference": "^3.0.
|
|
20
|
+
"@salesforce/plugin-command-reference": "^3.0.33",
|
|
21
21
|
"@salesforce/prettier-config": "^0.0.3",
|
|
22
22
|
"@salesforce/ts-sinon": "1.4.15",
|
|
23
23
|
"@swc/core": "^1.3.32",
|
|
24
24
|
"@typescript-eslint/eslint-plugin": "^5.62.0",
|
|
25
25
|
"@typescript-eslint/parser": "^5.62.0",
|
|
26
26
|
"chai": "^4.3.8",
|
|
27
|
-
"eslint": "^8.
|
|
27
|
+
"eslint": "^8.50.0",
|
|
28
28
|
"eslint-config-prettier": "^8.10.0",
|
|
29
29
|
"eslint-config-salesforce": "^2.0.2",
|
|
30
30
|
"eslint-config-salesforce-license": "^0.2.0",
|
|
@@ -32,18 +32,18 @@
|
|
|
32
32
|
"eslint-plugin-header": "^3.1.1",
|
|
33
33
|
"eslint-plugin-import": "2.28.1",
|
|
34
34
|
"eslint-plugin-jsdoc": "^43.0.5",
|
|
35
|
-
"eslint-plugin-sf-plugin": "^1.16.
|
|
35
|
+
"eslint-plugin-sf-plugin": "^1.16.6",
|
|
36
36
|
"husky": "^7.0.4",
|
|
37
37
|
"mocha": "^9.1.3",
|
|
38
38
|
"nyc": "^15.1.0",
|
|
39
|
-
"oclif": "^3.
|
|
39
|
+
"oclif": "^3.16.0",
|
|
40
40
|
"prettier": "^2.8.8",
|
|
41
41
|
"pretty-quick": "^3.1.0",
|
|
42
42
|
"shx": "0.3.4",
|
|
43
43
|
"sinon": "10.0.0",
|
|
44
44
|
"ts-node": "^10.0.0",
|
|
45
45
|
"typescript": "^4.9.5",
|
|
46
|
-
"wireit": "^0.
|
|
46
|
+
"wireit": "^0.14.0"
|
|
47
47
|
},
|
|
48
48
|
"config": {},
|
|
49
49
|
"engines": {
|
|
@@ -213,7 +213,7 @@
|
|
|
213
213
|
}
|
|
214
214
|
},
|
|
215
215
|
"sfdx": {
|
|
216
|
-
"publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-schema/2.3.
|
|
217
|
-
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-schema/2.3.
|
|
216
|
+
"publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-schema/2.3.28.crt",
|
|
217
|
+
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-schema/2.3.28.sig"
|
|
218
218
|
}
|
|
219
219
|
}
|