@heroku-cli/plugin-data 1.3.3 → 2.0.0
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/LICENSE +1 -1
- package/README.md +197 -107
- package/lib/commands/data/connectors/create.d.ts +8 -9
- package/lib/commands/data/connectors/create.js +52 -49
- package/lib/commands/data/connectors/destroy.d.ts +5 -6
- package/lib/commands/data/connectors/destroy.js +22 -24
- package/lib/commands/data/connectors/index.d.ts +6 -7
- package/lib/commands/data/connectors/index.js +38 -38
- package/lib/commands/data/connectors/info.d.ts +4 -4
- package/lib/commands/data/connectors/info.js +31 -32
- package/lib/commands/data/connectors/pause.d.ts +3 -3
- package/lib/commands/data/connectors/pause.js +16 -15
- package/lib/commands/data/connectors/resume.d.ts +3 -3
- package/lib/commands/data/connectors/resume.js +16 -15
- package/lib/commands/data/connectors/update.d.ts +9 -9
- package/lib/commands/data/connectors/update.js +60 -57
- package/lib/commands/data/connectors/wait.d.ts +3 -3
- package/lib/commands/data/connectors/wait.js +13 -13
- package/lib/commands/data/enhanced-certificates/disable.d.ts +4 -5
- package/lib/commands/data/enhanced-certificates/disable.js +16 -11
- package/lib/commands/data/enhanced-certificates/enable.d.ts +4 -5
- package/lib/commands/data/enhanced-certificates/enable.js +19 -14
- package/lib/commands/data/enhanced-certificates/status.d.ts +5 -6
- package/lib/commands/data/enhanced-certificates/status.js +14 -12
- package/lib/commands/data/labs/disable.d.ts +5 -6
- package/lib/commands/data/labs/disable.js +28 -20
- package/lib/commands/data/labs/enable.d.ts +5 -6
- package/lib/commands/data/labs/enable.js +28 -20
- package/lib/commands/data/labs/list.d.ts +14 -6
- package/lib/commands/data/labs/list.js +18 -16
- package/lib/fetcher.d.ts +1 -1
- package/lib/fetcher.js +5 -10
- package/lib/lib/base.d.ts +5 -5
- package/lib/lib/base.js +10 -7
- package/lib/tsconfig.tsbuildinfo +1 -0
- package/oclif.manifest.json +646 -1
- package/package.json +29 -30
- package/yarn.lock +0 -3292
package/LICENSE
CHANGED
package/README.md
CHANGED
|
@@ -38,18 +38,19 @@ USAGE
|
|
|
38
38
|
<!-- commands -->
|
|
39
39
|
* [`heroku data:connectors`](#heroku-dataconnectors)
|
|
40
40
|
* [`heroku data:connectors:create`](#heroku-dataconnectorscreate)
|
|
41
|
-
* [`heroku data:connectors:destroy
|
|
42
|
-
* [`heroku data:connectors:info
|
|
43
|
-
* [`heroku data:connectors:
|
|
44
|
-
* [`heroku data:connectors:
|
|
45
|
-
* [`heroku data:connectors:
|
|
46
|
-
* [`heroku data:connectors:
|
|
47
|
-
* [`heroku data:
|
|
48
|
-
* [`heroku data:enhanced-certificates:
|
|
49
|
-
* [`heroku data:enhanced-certificates:
|
|
50
|
-
* [`heroku data:
|
|
51
|
-
* [`heroku data:labs:
|
|
52
|
-
* [`heroku data:labs:
|
|
41
|
+
* [`heroku data:connectors:destroy CONNECTOR`](#heroku-dataconnectorsdestroy-connector)
|
|
42
|
+
* [`heroku data:connectors:info CONNECTOR`](#heroku-dataconnectorsinfo-connector)
|
|
43
|
+
* [`heroku data:connectors:list`](#heroku-dataconnectorslist)
|
|
44
|
+
* [`heroku data:connectors:pause CONNECTOR`](#heroku-dataconnectorspause-connector)
|
|
45
|
+
* [`heroku data:connectors:resume CONNECTOR`](#heroku-dataconnectorsresume-connector)
|
|
46
|
+
* [`heroku data:connectors:update CONNECTOR`](#heroku-dataconnectorsupdate-connector)
|
|
47
|
+
* [`heroku data:connectors:wait CONNECTOR`](#heroku-dataconnectorswait-connector)
|
|
48
|
+
* [`heroku data:enhanced-certificates:disable ADDON`](#heroku-dataenhanced-certificatesdisable-addon)
|
|
49
|
+
* [`heroku data:enhanced-certificates:enable ADDON`](#heroku-dataenhanced-certificatesenable-addon)
|
|
50
|
+
* [`heroku data:enhanced-certificates:status ADDON`](#heroku-dataenhanced-certificatesstatus-addon)
|
|
51
|
+
* [`heroku data:labs:disable FEATURE`](#heroku-datalabsdisable-feature)
|
|
52
|
+
* [`heroku data:labs:enable FEATURE`](#heroku-datalabsenable-feature)
|
|
53
|
+
* [`heroku data:labs:list ADDON`](#heroku-datalabslist-addon)
|
|
53
54
|
|
|
54
55
|
## `heroku data:connectors`
|
|
55
56
|
|
|
@@ -57,28 +58,31 @@ List all Data Connectors for a particular app or addon
|
|
|
57
58
|
|
|
58
59
|
```
|
|
59
60
|
USAGE
|
|
60
|
-
$ heroku data:connectors
|
|
61
|
+
$ heroku data:connectors [--addon <value>] [-a <value>] [--json | --table] [-r <value>]
|
|
61
62
|
|
|
62
|
-
|
|
63
|
-
-a, --app
|
|
64
|
-
-r, --remote
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
63
|
+
FLAGS
|
|
64
|
+
-a, --app=<value> app to run command against
|
|
65
|
+
-r, --remote=<value> git remote of app to use
|
|
66
|
+
--addon=<value> The ID or name for the addon your connector is attached to
|
|
67
|
+
--json Return the results as JSON
|
|
68
|
+
--table Return the results as a table
|
|
68
69
|
|
|
69
70
|
DESCRIPTION
|
|
71
|
+
List all Data Connectors for a particular app or addon
|
|
70
72
|
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors
|
|
71
73
|
|
|
72
74
|
ALIASES
|
|
73
75
|
$ heroku data:connectors:list
|
|
74
76
|
|
|
75
77
|
EXAMPLES
|
|
76
|
-
heroku data:connectors -a your-app
|
|
77
|
-
|
|
78
|
-
heroku data:connectors --
|
|
78
|
+
$ heroku data:connectors -a your-app
|
|
79
|
+
|
|
80
|
+
$ heroku data:connectors --app=your-app --json
|
|
81
|
+
|
|
82
|
+
$ heroku data:connectors --addon=your-postgres-addon --table
|
|
79
83
|
```
|
|
80
84
|
|
|
81
|
-
_See code: [src/commands/data/connectors/index.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/
|
|
85
|
+
_See code: [src/commands/data/connectors/index.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v2.0.0/src/commands/data/connectors/index.ts)_
|
|
82
86
|
|
|
83
87
|
## `heroku data:connectors:create`
|
|
84
88
|
|
|
@@ -86,252 +90,338 @@ create a new Data Connector
|
|
|
86
90
|
|
|
87
91
|
```
|
|
88
92
|
USAGE
|
|
89
|
-
$ heroku data:connectors:create
|
|
93
|
+
$ heroku data:connectors:create --source <value> --store <value> -t <value>... [-a <value>] [--exclude-column <value>...]
|
|
94
|
+
[--name <value>]
|
|
90
95
|
|
|
91
|
-
|
|
92
|
-
-a, --app
|
|
93
|
-
-t, --table
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
96
|
+
FLAGS
|
|
97
|
+
-a, --app=<value> app to run command against
|
|
98
|
+
-t, --table=<value>... (required) Tables to include
|
|
99
|
+
--exclude-column=<value>... Columns to exclude
|
|
100
|
+
--name=<value> Name of the connector
|
|
101
|
+
--source=<value> (required) The name of the database add-on whose change data you want to store
|
|
102
|
+
--store=<value> (required) The name of the database add-on that will store the change data
|
|
98
103
|
|
|
99
104
|
DESCRIPTION
|
|
105
|
+
create a new Data Connector
|
|
100
106
|
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors
|
|
101
107
|
|
|
102
108
|
EXAMPLES
|
|
103
|
-
$ heroku data:connectors:create --store kafka-lovely-12345 --source postgresql-neato-98765 --table public.posts
|
|
104
|
-
|
|
105
|
-
$ heroku data:connectors:create --store kafka-lovely-12345 --source postgresql-neato-98765 --table public.users
|
|
106
|
-
--exclude-column public.users.password
|
|
109
|
+
$ heroku data:connectors:create --store kafka-lovely-12345 --source postgresql-neato-98765 --table public.posts --table public.comments
|
|
110
|
+
|
|
111
|
+
$ heroku data:connectors:create --store kafka-lovely-12345 --source postgresql-neato-98765 --table public.users --exclude-column public.users.password
|
|
107
112
|
```
|
|
108
113
|
|
|
109
|
-
_See code: [src/commands/data/connectors/create.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/
|
|
114
|
+
_See code: [src/commands/data/connectors/create.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v2.0.0/src/commands/data/connectors/create.ts)_
|
|
110
115
|
|
|
111
|
-
## `heroku data:connectors:destroy
|
|
116
|
+
## `heroku data:connectors:destroy CONNECTOR`
|
|
112
117
|
|
|
113
118
|
Destroy a Data Connector
|
|
114
119
|
|
|
115
120
|
```
|
|
116
121
|
USAGE
|
|
117
|
-
$ heroku data:connectors:destroy [
|
|
122
|
+
$ heroku data:connectors:destroy CONNECTOR [--confirm <value>]
|
|
123
|
+
|
|
124
|
+
ARGUMENTS
|
|
125
|
+
CONNECTOR name of the connector
|
|
118
126
|
|
|
119
|
-
|
|
120
|
-
--confirm
|
|
127
|
+
FLAGS
|
|
128
|
+
--confirm=<value> confirms destroying the connector if passed in
|
|
121
129
|
|
|
122
130
|
DESCRIPTION
|
|
131
|
+
Destroy a Data Connector
|
|
123
132
|
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors
|
|
124
133
|
|
|
125
134
|
EXAMPLES
|
|
126
135
|
$ heroku data:connectors:destroy gentle-connector-1234
|
|
136
|
+
|
|
127
137
|
$ heroku data:connectors:destroy gentle-connector-1234 --confirm gentle-connector-1234
|
|
128
138
|
```
|
|
129
139
|
|
|
130
|
-
_See code: [src/commands/data/connectors/destroy.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/
|
|
140
|
+
_See code: [src/commands/data/connectors/destroy.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v2.0.0/src/commands/data/connectors/destroy.ts)_
|
|
131
141
|
|
|
132
|
-
## `heroku data:connectors:info
|
|
142
|
+
## `heroku data:connectors:info CONNECTOR`
|
|
133
143
|
|
|
134
144
|
Get information about a Data Connector
|
|
135
145
|
|
|
136
146
|
```
|
|
137
147
|
USAGE
|
|
138
|
-
$ heroku data:connectors:info [
|
|
148
|
+
$ heroku data:connectors:info CONNECTOR [--json]
|
|
149
|
+
|
|
150
|
+
ARGUMENTS
|
|
151
|
+
CONNECTOR name of the connector
|
|
139
152
|
|
|
140
|
-
|
|
153
|
+
FLAGS
|
|
141
154
|
--json Return the results as JSON
|
|
142
155
|
|
|
143
156
|
DESCRIPTION
|
|
157
|
+
Get information about a Data Connector
|
|
144
158
|
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors
|
|
145
159
|
|
|
146
160
|
EXAMPLES
|
|
147
161
|
$ heroku data:connectors:info gentle-connector-1234
|
|
162
|
+
|
|
148
163
|
$ heroku data:connectors:info gentle-connector-1234 --json
|
|
149
164
|
```
|
|
150
165
|
|
|
151
|
-
_See code: [src/commands/data/connectors/info.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/
|
|
166
|
+
_See code: [src/commands/data/connectors/info.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v2.0.0/src/commands/data/connectors/info.ts)_
|
|
167
|
+
|
|
168
|
+
## `heroku data:connectors:list`
|
|
169
|
+
|
|
170
|
+
List all Data Connectors for a particular app or addon
|
|
171
|
+
|
|
172
|
+
```
|
|
173
|
+
USAGE
|
|
174
|
+
$ heroku data:connectors:list [--addon <value>] [-a <value>] [--json | --table] [-r <value>]
|
|
175
|
+
|
|
176
|
+
FLAGS
|
|
177
|
+
-a, --app=<value> app to run command against
|
|
178
|
+
-r, --remote=<value> git remote of app to use
|
|
179
|
+
--addon=<value> The ID or name for the addon your connector is attached to
|
|
180
|
+
--json Return the results as JSON
|
|
181
|
+
--table Return the results as a table
|
|
182
|
+
|
|
183
|
+
DESCRIPTION
|
|
184
|
+
List all Data Connectors for a particular app or addon
|
|
185
|
+
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors
|
|
186
|
+
|
|
187
|
+
ALIASES
|
|
188
|
+
$ heroku data:connectors:list
|
|
189
|
+
|
|
190
|
+
EXAMPLES
|
|
191
|
+
$ heroku data:connectors -a your-app
|
|
192
|
+
|
|
193
|
+
$ heroku data:connectors --app=your-app --json
|
|
194
|
+
|
|
195
|
+
$ heroku data:connectors --addon=your-postgres-addon --table
|
|
196
|
+
```
|
|
152
197
|
|
|
153
|
-
## `heroku data:connectors:pause
|
|
198
|
+
## `heroku data:connectors:pause CONNECTOR`
|
|
154
199
|
|
|
155
200
|
Pause change event creation on a Data Connector
|
|
156
201
|
|
|
157
202
|
```
|
|
158
203
|
USAGE
|
|
159
|
-
$ heroku data:connectors:pause
|
|
204
|
+
$ heroku data:connectors:pause CONNECTOR
|
|
205
|
+
|
|
206
|
+
ARGUMENTS
|
|
207
|
+
CONNECTOR name of the connector
|
|
160
208
|
|
|
161
209
|
DESCRIPTION
|
|
210
|
+
Pause change event creation on a Data Connector
|
|
162
211
|
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors
|
|
163
212
|
|
|
164
|
-
|
|
213
|
+
EXAMPLES
|
|
165
214
|
$ heroku data:connectors:pause gentle-connector-1234
|
|
166
215
|
```
|
|
167
216
|
|
|
168
|
-
_See code: [src/commands/data/connectors/pause.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/
|
|
217
|
+
_See code: [src/commands/data/connectors/pause.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v2.0.0/src/commands/data/connectors/pause.ts)_
|
|
169
218
|
|
|
170
|
-
## `heroku data:connectors:resume
|
|
219
|
+
## `heroku data:connectors:resume CONNECTOR`
|
|
171
220
|
|
|
172
221
|
Resume change event creation on a Data Connector
|
|
173
222
|
|
|
174
223
|
```
|
|
175
224
|
USAGE
|
|
176
|
-
$ heroku data:connectors:resume
|
|
225
|
+
$ heroku data:connectors:resume CONNECTOR
|
|
226
|
+
|
|
227
|
+
ARGUMENTS
|
|
228
|
+
CONNECTOR name of the connector
|
|
177
229
|
|
|
178
230
|
DESCRIPTION
|
|
231
|
+
Resume change event creation on a Data Connector
|
|
179
232
|
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors
|
|
180
233
|
|
|
181
|
-
|
|
234
|
+
EXAMPLES
|
|
182
235
|
$ heroku data:connectors:resume gentle-connector-1234
|
|
183
236
|
```
|
|
184
237
|
|
|
185
|
-
_See code: [src/commands/data/connectors/resume.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/
|
|
238
|
+
_See code: [src/commands/data/connectors/resume.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v2.0.0/src/commands/data/connectors/resume.ts)_
|
|
186
239
|
|
|
187
|
-
## `heroku data:connectors:update
|
|
240
|
+
## `heroku data:connectors:update CONNECTOR`
|
|
188
241
|
|
|
189
242
|
Update the settings, tables, and columns to exclude for a Data Connector
|
|
190
243
|
|
|
191
244
|
```
|
|
192
245
|
USAGE
|
|
193
|
-
$ heroku data:connectors:update [
|
|
246
|
+
$ heroku data:connectors:update CONNECTOR [--setting <value>...] [--add-table <value>...] [--remove-table <value>...]
|
|
247
|
+
[--exclude-column <value>...] [--remove-excluded-column <value>...]
|
|
248
|
+
|
|
249
|
+
ARGUMENTS
|
|
250
|
+
CONNECTOR name of the connector
|
|
194
251
|
|
|
195
|
-
|
|
196
|
-
--add-table
|
|
197
|
-
--exclude-column
|
|
198
|
-
--remove-excluded-column
|
|
199
|
-
--remove-table
|
|
200
|
-
--setting
|
|
252
|
+
FLAGS
|
|
253
|
+
--add-table=<value>... Tables to add
|
|
254
|
+
--exclude-column=<value>... Columns to exclude
|
|
255
|
+
--remove-excluded-column=<value>... Columns to no longer exclude
|
|
256
|
+
--remove-table=<value>... Tables to remove
|
|
257
|
+
--setting=<value>...
|
|
201
258
|
|
|
202
259
|
DESCRIPTION
|
|
260
|
+
Update the settings, tables, and columns to exclude for a Data Connector
|
|
203
261
|
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors#update-configuration
|
|
204
262
|
|
|
205
|
-
|
|
206
|
-
$ heroku data:connectors:update gentle-connector-1234 --setting key=value --setting otherKey=otherValue --add-table
|
|
207
|
-
public.posts --add-table public.people --remove-table public.messages --exclude-column public.posts.key
|
|
208
|
-
--remove-excluded-column public.parcels.key
|
|
263
|
+
EXAMPLES
|
|
264
|
+
$ heroku data:connectors:update gentle-connector-1234 --setting key=value --setting otherKey=otherValue --add-table public.posts --add-table public.people --remove-table public.messages --exclude-column public.posts.key --remove-excluded-column public.parcels.key
|
|
209
265
|
```
|
|
210
266
|
|
|
211
|
-
_See code: [src/commands/data/connectors/update.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/
|
|
267
|
+
_See code: [src/commands/data/connectors/update.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v2.0.0/src/commands/data/connectors/update.ts)_
|
|
212
268
|
|
|
213
|
-
## `heroku data:connectors:wait
|
|
269
|
+
## `heroku data:connectors:wait CONNECTOR`
|
|
214
270
|
|
|
215
271
|
Wait for your Data Connector to be provisioned
|
|
216
272
|
|
|
217
273
|
```
|
|
218
274
|
USAGE
|
|
219
|
-
$ heroku data:connectors:wait
|
|
275
|
+
$ heroku data:connectors:wait CONNECTOR
|
|
276
|
+
|
|
277
|
+
ARGUMENTS
|
|
278
|
+
CONNECTOR name of the connector
|
|
220
279
|
|
|
221
280
|
DESCRIPTION
|
|
281
|
+
Wait for your Data Connector to be provisioned
|
|
222
282
|
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors
|
|
223
283
|
|
|
224
|
-
|
|
284
|
+
EXAMPLES
|
|
225
285
|
$ heroku data:connectors:wait gentle-connector-1234
|
|
226
286
|
```
|
|
227
287
|
|
|
228
|
-
_See code: [src/commands/data/connectors/wait.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/
|
|
288
|
+
_See code: [src/commands/data/connectors/wait.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v2.0.0/src/commands/data/connectors/wait.ts)_
|
|
229
289
|
|
|
230
|
-
## `heroku data:enhanced-certificates:disable
|
|
290
|
+
## `heroku data:enhanced-certificates:disable ADDON`
|
|
231
291
|
|
|
232
292
|
Disable enhanced certificates on an Addon
|
|
233
293
|
|
|
234
294
|
```
|
|
235
295
|
USAGE
|
|
236
|
-
$ heroku data:enhanced-certificates:disable [
|
|
296
|
+
$ heroku data:enhanced-certificates:disable ADDON [-a <value>]
|
|
297
|
+
|
|
298
|
+
ARGUMENTS
|
|
299
|
+
ADDON name of the addon
|
|
237
300
|
|
|
238
|
-
|
|
239
|
-
-a, --app
|
|
301
|
+
FLAGS
|
|
302
|
+
-a, --app=<value> app to run command against
|
|
240
303
|
|
|
241
304
|
DESCRIPTION
|
|
305
|
+
Disable enhanced certificates on an Addon
|
|
242
306
|
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-enhanced-certificates
|
|
243
307
|
```
|
|
244
308
|
|
|
245
|
-
_See code: [src/commands/data/enhanced-certificates/disable.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/
|
|
309
|
+
_See code: [src/commands/data/enhanced-certificates/disable.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v2.0.0/src/commands/data/enhanced-certificates/disable.ts)_
|
|
246
310
|
|
|
247
|
-
## `heroku data:enhanced-certificates:enable
|
|
311
|
+
## `heroku data:enhanced-certificates:enable ADDON`
|
|
248
312
|
|
|
249
313
|
Enable enhanced certificates on an Addon
|
|
250
314
|
|
|
251
315
|
```
|
|
252
316
|
USAGE
|
|
253
|
-
$ heroku data:enhanced-certificates:enable [
|
|
317
|
+
$ heroku data:enhanced-certificates:enable ADDON [-a <value>]
|
|
254
318
|
|
|
255
|
-
|
|
256
|
-
|
|
319
|
+
ARGUMENTS
|
|
320
|
+
ADDON name of the addon
|
|
321
|
+
|
|
322
|
+
FLAGS
|
|
323
|
+
-a, --app=<value> app to run command against
|
|
257
324
|
|
|
258
325
|
DESCRIPTION
|
|
326
|
+
Enable enhanced certificates on an Addon
|
|
259
327
|
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-enhanced-certificates
|
|
260
328
|
|
|
261
|
-
|
|
329
|
+
EXAMPLES
|
|
262
330
|
$ heroku data:enhanced-certificates:enable happy-postgres-1234 -a example-app
|
|
263
331
|
```
|
|
264
332
|
|
|
265
|
-
_See code: [src/commands/data/enhanced-certificates/enable.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/
|
|
333
|
+
_See code: [src/commands/data/enhanced-certificates/enable.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v2.0.0/src/commands/data/enhanced-certificates/enable.ts)_
|
|
266
334
|
|
|
267
|
-
## `heroku data:enhanced-certificates:status
|
|
335
|
+
## `heroku data:enhanced-certificates:status ADDON`
|
|
268
336
|
|
|
269
337
|
Get the status of Enhanced Certificates
|
|
270
338
|
|
|
271
339
|
```
|
|
272
340
|
USAGE
|
|
273
|
-
$ heroku data:enhanced-certificates:status [
|
|
341
|
+
$ heroku data:enhanced-certificates:status ADDON [-a <value>] [--json]
|
|
342
|
+
|
|
343
|
+
ARGUMENTS
|
|
344
|
+
ADDON name of the addon
|
|
274
345
|
|
|
275
|
-
|
|
276
|
-
-a, --app
|
|
277
|
-
|
|
346
|
+
FLAGS
|
|
347
|
+
-a, --app=<value> app to run command against
|
|
348
|
+
--json Return the results as JSON
|
|
278
349
|
|
|
279
350
|
DESCRIPTION
|
|
351
|
+
Get the status of Enhanced Certificates
|
|
280
352
|
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-enhanced-certificates
|
|
281
353
|
```
|
|
282
354
|
|
|
283
|
-
_See code: [src/commands/data/enhanced-certificates/status.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/
|
|
355
|
+
_See code: [src/commands/data/enhanced-certificates/status.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v2.0.0/src/commands/data/enhanced-certificates/status.ts)_
|
|
284
356
|
|
|
285
|
-
## `heroku data:labs:disable
|
|
357
|
+
## `heroku data:labs:disable FEATURE`
|
|
286
358
|
|
|
287
359
|
Disable experimental features on an addon
|
|
288
360
|
|
|
289
361
|
```
|
|
290
362
|
USAGE
|
|
291
|
-
$ heroku data:labs:disable [
|
|
363
|
+
$ heroku data:labs:disable FEATURE --addon <value> [-a <value>]
|
|
292
364
|
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
--addon=addon (required) The addon you want to disable features on
|
|
365
|
+
ARGUMENTS
|
|
366
|
+
FEATURE name of the feature
|
|
296
367
|
|
|
297
|
-
|
|
368
|
+
FLAGS
|
|
369
|
+
-a, --app=<value> app to run command against
|
|
370
|
+
--addon=<value> (required) The addon you want to disable features on
|
|
371
|
+
|
|
372
|
+
DESCRIPTION
|
|
373
|
+
Disable experimental features on an addon
|
|
374
|
+
|
|
375
|
+
EXAMPLES
|
|
298
376
|
$ heroku data:labs:disable wal-compression --addon=happy-postgres-1234 -a example-app
|
|
299
377
|
```
|
|
300
378
|
|
|
301
|
-
_See code: [src/commands/data/labs/disable.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/
|
|
379
|
+
_See code: [src/commands/data/labs/disable.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v2.0.0/src/commands/data/labs/disable.ts)_
|
|
302
380
|
|
|
303
|
-
## `heroku data:labs:enable
|
|
381
|
+
## `heroku data:labs:enable FEATURE`
|
|
304
382
|
|
|
305
383
|
Enable experimental features on an addon
|
|
306
384
|
|
|
307
385
|
```
|
|
308
386
|
USAGE
|
|
309
|
-
$ heroku data:labs:enable [
|
|
387
|
+
$ heroku data:labs:enable FEATURE --addon <value> [-a <value>]
|
|
388
|
+
|
|
389
|
+
ARGUMENTS
|
|
390
|
+
FEATURE name of the feature
|
|
391
|
+
|
|
392
|
+
FLAGS
|
|
393
|
+
-a, --app=<value> app to run command against
|
|
394
|
+
--addon=<value> (required) The addon you want to enable features on
|
|
310
395
|
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
--addon=addon (required) The addon you want to enable features on
|
|
396
|
+
DESCRIPTION
|
|
397
|
+
Enable experimental features on an addon
|
|
314
398
|
|
|
315
|
-
|
|
399
|
+
EXAMPLES
|
|
316
400
|
$ heroku data:labs:enable wal-compression --addon=happy-postgres-1234 -a example-app
|
|
317
401
|
```
|
|
318
402
|
|
|
319
|
-
_See code: [src/commands/data/labs/enable.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/
|
|
403
|
+
_See code: [src/commands/data/labs/enable.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v2.0.0/src/commands/data/labs/enable.ts)_
|
|
320
404
|
|
|
321
|
-
## `heroku data:labs:list
|
|
405
|
+
## `heroku data:labs:list ADDON`
|
|
322
406
|
|
|
323
407
|
List available experimental features on an addon and their statuses
|
|
324
408
|
|
|
325
409
|
```
|
|
326
410
|
USAGE
|
|
327
|
-
$ heroku data:labs:list [
|
|
411
|
+
$ heroku data:labs:list ADDON [-a <value>]
|
|
412
|
+
|
|
413
|
+
ARGUMENTS
|
|
414
|
+
ADDON name of the addon
|
|
328
415
|
|
|
329
|
-
|
|
330
|
-
-a, --app
|
|
416
|
+
FLAGS
|
|
417
|
+
-a, --app=<value> app to run command against
|
|
331
418
|
|
|
332
|
-
|
|
419
|
+
DESCRIPTION
|
|
420
|
+
List available experimental features on an addon and their statuses
|
|
421
|
+
|
|
422
|
+
EXAMPLES
|
|
333
423
|
$ heroku data:labs:list happy-postgres-1234
|
|
334
424
|
```
|
|
335
425
|
|
|
336
|
-
_See code: [src/commands/data/labs/list.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/
|
|
426
|
+
_See code: [src/commands/data/labs/list.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v2.0.0/src/commands/data/labs/list.ts)_
|
|
337
427
|
<!-- commandsstop -->
|
|
@@ -1,16 +1,15 @@
|
|
|
1
|
-
import { flags } from '@heroku-cli/command';
|
|
2
1
|
import BaseCommand from '../../../lib/base';
|
|
3
2
|
export default class ConnectorsCreate extends BaseCommand {
|
|
4
3
|
static description: string;
|
|
4
|
+
static examples: string[];
|
|
5
5
|
static flags: {
|
|
6
|
-
app:
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
6
|
+
app: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
|
|
7
|
+
'exclude-column': import("@oclif/core/lib/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
|
|
8
|
+
name: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
|
|
9
|
+
'platform-version': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
|
|
10
|
+
source: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
|
|
11
|
+
store: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
|
|
12
|
+
table: import("@oclif/core/lib/interfaces").OptionFlag<string[], import("@oclif/core/lib/interfaces/parser").CustomOptions>;
|
|
13
13
|
};
|
|
14
|
-
static examples: string[];
|
|
15
14
|
run(): Promise<void>;
|
|
16
15
|
}
|
|
@@ -2,70 +2,73 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
const color_1 = require("@heroku-cli/color");
|
|
4
4
|
const command_1 = require("@heroku-cli/command");
|
|
5
|
-
const
|
|
5
|
+
const core_1 = require("@oclif/core");
|
|
6
6
|
const fetcher_1 = require("../../../fetcher");
|
|
7
7
|
const base_1 = require("../../../lib/base");
|
|
8
8
|
class ConnectorsCreate extends base_1.default {
|
|
9
|
+
static description = 'create a new Data Connector\nRead more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors';
|
|
10
|
+
static examples = [
|
|
11
|
+
'$ heroku data:connectors:create --store kafka-lovely-12345 --source postgresql-neato-98765 --table public.posts --table public.comments',
|
|
12
|
+
'$ heroku data:connectors:create --store kafka-lovely-12345 --source postgresql-neato-98765 --table public.users --exclude-column public.users.password',
|
|
13
|
+
];
|
|
14
|
+
static flags = {
|
|
15
|
+
app: command_1.flags.app(),
|
|
16
|
+
'exclude-column': command_1.flags.string({
|
|
17
|
+
description: 'Columns to exclude',
|
|
18
|
+
multiple: true,
|
|
19
|
+
}),
|
|
20
|
+
name: command_1.flags.string({
|
|
21
|
+
description: 'Name of the connector',
|
|
22
|
+
required: false,
|
|
23
|
+
}),
|
|
24
|
+
'platform-version': command_1.flags.string({
|
|
25
|
+
char: 'p',
|
|
26
|
+
hidden: true,
|
|
27
|
+
required: false,
|
|
28
|
+
}),
|
|
29
|
+
source: command_1.flags.string({
|
|
30
|
+
description: 'The name of the database add-on whose change data you want to store',
|
|
31
|
+
required: true,
|
|
32
|
+
}),
|
|
33
|
+
store: command_1.flags.string({
|
|
34
|
+
description: 'The name of the database add-on that will store the change data',
|
|
35
|
+
required: true,
|
|
36
|
+
}),
|
|
37
|
+
table: command_1.flags.string({
|
|
38
|
+
char: 't',
|
|
39
|
+
description: 'Tables to include',
|
|
40
|
+
multiple: true,
|
|
41
|
+
required: true,
|
|
42
|
+
}),
|
|
43
|
+
};
|
|
9
44
|
async run() {
|
|
10
|
-
const { flags } = this.parse(ConnectorsCreate);
|
|
45
|
+
const { flags } = await this.parse(ConnectorsCreate);
|
|
11
46
|
const tables = flags.table;
|
|
12
47
|
const excluded = flags['exclude-column'] || [];
|
|
13
48
|
const platformVersion = flags['platform-version'] || '';
|
|
14
49
|
const name = flags.name || '';
|
|
15
50
|
const kafka = await (0, fetcher_1.fetchAddon)(this.heroku, flags.store, flags.app);
|
|
16
51
|
const postgres = await (0, fetcher_1.fetchAddon)(this.heroku, flags.source, flags.app);
|
|
17
|
-
|
|
18
|
-
const { body: res } = await this.shogun.post(`/data/cdc/v0/kafka_tenants/${kafka.id}`,
|
|
19
|
-
|
|
20
|
-
|
|
52
|
+
core_1.ux.action.start('Provisioning Data Connector');
|
|
53
|
+
const { body: res } = await this.shogun.post(`/data/cdc/v0/kafka_tenants/${kafka.id}`, {
|
|
54
|
+
...this.shogun.defaults,
|
|
55
|
+
body: {
|
|
21
56
|
excluded_columns: excluded,
|
|
57
|
+
name,
|
|
22
58
|
platform_version: platformVersion,
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
59
|
+
postgres_addon_uuid: postgres.id,
|
|
60
|
+
tables,
|
|
61
|
+
},
|
|
62
|
+
});
|
|
63
|
+
core_1.ux.action.stop();
|
|
64
|
+
core_1.ux.log();
|
|
65
|
+
core_1.ux.styledObject({
|
|
28
66
|
Name: res.name,
|
|
29
67
|
Status: res.status,
|
|
30
68
|
});
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
' to check the creation process.');
|
|
69
|
+
core_1.ux.log();
|
|
70
|
+
core_1.ux.log('Run ' + color_1.default.cmd('heroku data:connectors:wait ' + res.name)
|
|
71
|
+
+ ' to check the creation process.');
|
|
34
72
|
}
|
|
35
73
|
}
|
|
36
74
|
exports.default = ConnectorsCreate;
|
|
37
|
-
ConnectorsCreate.description = 'create a new Data Connector\nRead more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors';
|
|
38
|
-
ConnectorsCreate.flags = {
|
|
39
|
-
app: command_1.flags.app(),
|
|
40
|
-
source: command_1.flags.string({
|
|
41
|
-
required: true,
|
|
42
|
-
description: 'The name of the database add-on whose change data you want to store',
|
|
43
|
-
}),
|
|
44
|
-
store: command_1.flags.string({
|
|
45
|
-
required: true,
|
|
46
|
-
description: 'The name of the database add-on that will store the change data',
|
|
47
|
-
}),
|
|
48
|
-
name: command_1.flags.string({
|
|
49
|
-
required: false,
|
|
50
|
-
description: 'Name of the connector',
|
|
51
|
-
}),
|
|
52
|
-
table: command_1.flags.string({
|
|
53
|
-
char: 't',
|
|
54
|
-
description: 'Tables to include',
|
|
55
|
-
multiple: true,
|
|
56
|
-
required: true,
|
|
57
|
-
}),
|
|
58
|
-
'exclude-column': command_1.flags.string({
|
|
59
|
-
description: 'Columns to exclude',
|
|
60
|
-
multiple: true,
|
|
61
|
-
}),
|
|
62
|
-
'platform-version': command_1.flags.string({
|
|
63
|
-
char: 'p',
|
|
64
|
-
required: false,
|
|
65
|
-
hidden: true,
|
|
66
|
-
}),
|
|
67
|
-
};
|
|
68
|
-
ConnectorsCreate.examples = [
|
|
69
|
-
'$ heroku data:connectors:create --store kafka-lovely-12345 --source postgresql-neato-98765 --table public.posts --table public.comments',
|
|
70
|
-
'$ heroku data:connectors:create --store kafka-lovely-12345 --source postgresql-neato-98765 --table public.users --exclude-column public.users.password',
|
|
71
|
-
];
|