@salesforce/plugin-limits 2.3.34 → 2.3.36

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.
Files changed (3) hide show
  1. package/README.md +56 -44
  2. package/oclif.manifest.json +1 -1
  3. package/package.json +13 -13
package/README.md CHANGED
@@ -70,77 +70,89 @@ sfdx plugins
70
70
 
71
71
  <!-- commands -->
72
72
 
73
- - [`sfdx force:limits:api:display [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcelimitsapidisplay--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
74
- - [`sfdx force:limits:recordcounts:display [-s <array>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcelimitsrecordcountsdisplay--s-array--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
73
+ - [`sfdx limits:api:display`](#sfdx-limitsapidisplay)
74
+ - [`sfdx limits:recordcounts:display`](#sfdx-limitsrecordcountsdisplay)
75
75
 
76
- ## `sfdx force:limits:api:display [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
76
+ ## `sfdx limits:api:display`
77
77
 
78
- display current org’s limits
78
+ Display information about limits in your org.
79
79
 
80
80
  ```
81
81
  USAGE
82
- $ sfdx force:limits:api:display [-u <string>] [--apiversion <string>] [--json] [--loglevel
83
- trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
82
+ $ sfdx limits:api:display -o <value> [--json] [--api-version <value>]
84
83
 
85
- OPTIONS
86
- -u, --targetusername=targetusername username or alias for the target
87
- org; overrides default target org
84
+ FLAGS
85
+ -o, --target-org=<value> (required) Username or alias of the target org.
86
+ --api-version=<value> Override the api version used for api requests made by this command
88
87
 
89
- --apiversion=apiversion override the api version used for
90
- api requests made by this command
91
-
92
- --json format output as json
93
-
94
- --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
95
- this command invocation
88
+ GLOBAL FLAGS
89
+ --json Format output as json.
96
90
 
97
91
  DESCRIPTION
98
- When you execute this command in a project, it provides limit information for your default scratch org.
92
+ Display information about limits in your org.
99
93
 
100
- EXAMPLES
94
+ For each limit, this command returns the maximum allocation and the remaining allocation based on usage. See this
95
+ topic for a description of each limit:
96
+ https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_limits.htm.
97
+
98
+ ALIASES
101
99
  $ sfdx force:limits:api:display
102
- $ sfdx force:limits:api:display -u me@my.org
103
- ```
100
+ $ sfdx org:list:limits
104
101
 
105
- _See code: [src/commands/force/limits/api/display.ts](https://github.com/salesforcecli/plugin-limits/blob/v2.0.0/src/commands/force/limits/api/display.ts)_
102
+ EXAMPLES
103
+ Display limits in your default org:
106
104
 
107
- ## `sfdx force:limits:recordcounts:display [-s <array>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
105
+ $ sfdx limits:api:display
108
106
 
109
- display record counts for the specified standard and custom objects
107
+ Display limits in the org with alias "my-scratch-org":
110
108
 
109
+ $ sfdx limits:api:display --target-org my-scratch-org
111
110
  ```
112
- USAGE
113
- $ sfdx force:limits:recordcounts:display [-s <array>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
114
- trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
115
111
 
116
- OPTIONS
117
- -s, --sobjecttype=sobjecttype comma-separated list of API names of
118
- standard or custom objects for which
119
- to display record counts
112
+ _See code: [src/commands/limits/api/display.ts](https://github.com/salesforcecli/plugin-limits/blob/2.3.36/src/commands/limits/api/display.ts)_
113
+
114
+ ## `sfdx limits:recordcounts:display`
120
115
 
121
- -u, --targetusername=targetusername username or alias for the target
122
- org; overrides default target org
116
+ Display record counts for the specified standard or custom objects.
123
117
 
124
- --apiversion=apiversion override the api version used for
125
- api requests made by this command
118
+ ```
119
+ USAGE
120
+ $ sfdx limits:recordcounts:display -o <value> [--json] [-s <value>] [--api-version <value>]
126
121
 
127
- --json format output as json
122
+ FLAGS
123
+ -o, --target-org=<value> (required) Username or alias of the target org.
124
+ -s, --sobject=<value>... [default: ] API name of the standard or custom object for which to display record counts.
125
+ --api-version=<value> Override the api version used for api requests made by this command
128
126
 
129
- --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
130
- this command invocation
127
+ GLOBAL FLAGS
128
+ --json Format output as json.
131
129
 
132
130
  DESCRIPTION
131
+ Display record counts for the specified standard or custom objects.
132
+
133
133
  Use this command to get an approximate count of the records in standard or custom objects in your org. These record
134
- counts are the same as the counts listed in the Storage Usage page in Setup. The record counts are approximate because
135
- they're calculated asynchronously and your org's storage usage isn't updated immediately. To display all available
136
- record counts, run the command without the '--sobjecttype' parameter.
134
+ counts are the same as the counts listed in the Storage Usage page in the Setup UI. The record counts are approximate
135
+ because they're calculated asynchronously and your org's storage usage isn't updated immediately. To display all
136
+ available record counts, run the command without the --sobject flag.
137
137
 
138
- EXAMPLES
138
+ ALIASES
139
139
  $ sfdx force:limits:recordcounts:display
140
- $ sfdx force:limits:recordcounts:display -s Account,Contact,Lead,Opportunity
141
- $ sfdx force:limits:recordcounts:display -s Account,Contact -u me@my.org
140
+ $ sfdx org:list:sobject:record-counts
141
+
142
+ EXAMPLES
143
+ Display all available record counts in your default org:
144
+
145
+ $ sfdx limits:recordcounts:display
146
+
147
+ Display record counts for the Account, Contact, Lead, and Opportunity objects in your default org:
148
+
149
+ $ sfdx limits:recordcounts:display --sobject Account --sobject Contact --sobject Lead --sobject Opportunity
150
+
151
+ Display record counts for the Account and Lead objects for the org with alias "my-scratch-org":
152
+
153
+ $ sfdx limits:recordcounts:display --sobject Account --sobject Lead --target-org my-scratch-org
142
154
  ```
143
155
 
144
- _See code: [src/commands/force/limits/recordcounts/display.ts](https://github.com/salesforcecli/plugin-limits/blob/v2.0.0/src/commands/force/limits/recordcounts/display.ts)_
156
+ _See code: [src/commands/limits/recordcounts/display.ts](https://github.com/salesforcecli/plugin-limits/blob/2.3.36/src/commands/limits/recordcounts/display.ts)_
145
157
 
146
158
  <!-- commandsstop -->
package/oclif.manifest.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "2.3.34",
2
+ "version": "2.3.36",
3
3
  "commands": {
4
4
  "limits:api:display": {
5
5
  "id": "limits:api:display",
package/package.json CHANGED
@@ -1,32 +1,32 @@
1
1
  {
2
2
  "name": "@salesforce/plugin-limits",
3
3
  "description": "commands to display api limits to your org",
4
- "version": "2.3.34",
4
+ "version": "2.3.36",
5
5
  "author": "Salesforce",
6
6
  "bugs": "https://github.com/forcedotcom/cli/issues",
7
7
  "main": "lib/index.js",
8
8
  "dependencies": {
9
9
  "@oclif/core": "^2.15.0",
10
- "@salesforce/core": "^5.2.0",
10
+ "@salesforce/core": "^5.2.10",
11
11
  "@salesforce/kit": "^3.0.11",
12
12
  "@salesforce/sf-plugins-core": "^3.1.22",
13
13
  "@salesforce/ts-types": "^2.0.6",
14
14
  "tslib": "^2"
15
15
  },
16
16
  "devDependencies": {
17
- "@oclif/plugin-command-snapshot": "^4.0.13",
18
- "@oclif/test": "^2.5.3",
19
- "@salesforce/cli-plugins-testkit": "^4.3.3",
17
+ "@oclif/plugin-command-snapshot": "^4.0.14",
18
+ "@oclif/test": "^2.5.5",
19
+ "@salesforce/cli-plugins-testkit": "^4.3.6",
20
20
  "@salesforce/dev-config": "^4.0.1",
21
21
  "@salesforce/dev-scripts": "^5.10.0",
22
- "@salesforce/plugin-command-reference": "^3.0.28",
22
+ "@salesforce/plugin-command-reference": "^3.0.34",
23
23
  "@salesforce/prettier-config": "^0.0.3",
24
- "@salesforce/ts-sinon": "^1.4.12",
24
+ "@salesforce/ts-sinon": "^1.4.15",
25
25
  "@swc/core": "^1.3.32",
26
26
  "@typescript-eslint/eslint-plugin": "^5.62.0",
27
27
  "@typescript-eslint/parser": "^5.62.0",
28
28
  "chai": "^4.3.8",
29
- "eslint": "^8.46.0",
29
+ "eslint": "^8.49.0",
30
30
  "eslint-config-prettier": "^8.10.0",
31
31
  "eslint-config-salesforce": "^2.0.2",
32
32
  "eslint-config-salesforce-license": "^0.2.0",
@@ -34,11 +34,11 @@
34
34
  "eslint-plugin-header": "^3.1.1",
35
35
  "eslint-plugin-import": "2.28.1",
36
36
  "eslint-plugin-jsdoc": "^43.0.5",
37
- "eslint-plugin-sf-plugin": "^1.16.3",
37
+ "eslint-plugin-sf-plugin": "^1.16.6",
38
38
  "husky": "^7.0.4",
39
39
  "mocha": "^9.1.3",
40
40
  "nyc": "^15.1.0",
41
- "oclif": "^3.14.0",
41
+ "oclif": "^3.16.0",
42
42
  "prettier": "^2.8.8",
43
43
  "pretty-quick": "^3.1.0",
44
44
  "shx": "0.3.4",
@@ -46,7 +46,7 @@
46
46
  "swc": "^1.0.11",
47
47
  "ts-node": "^10.4.0",
48
48
  "typescript": "^4.9.5",
49
- "wireit": "^0.13.0"
49
+ "wireit": "^0.14.0"
50
50
  },
51
51
  "config": {},
52
52
  "engines": {
@@ -219,7 +219,7 @@
219
219
  }
220
220
  },
221
221
  "sfdx": {
222
- "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-limits/2.3.34.crt",
223
- "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-limits/2.3.34.sig"
222
+ "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-limits/2.3.36.crt",
223
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-limits/2.3.36.sig"
224
224
  }
225
225
  }