@heroku-cli/plugin-data 2.0.0 → 3.0.1-beta.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/README.md +76 -31
- package/dist/commands/data/connectors/create.d.ts +15 -0
- package/{lib → dist}/commands/data/connectors/create.js +23 -25
- package/dist/commands/data/connectors/destroy.d.ts +12 -0
- package/dist/commands/data/connectors/destroy.js +39 -0
- package/dist/commands/data/connectors/index.d.ts +14 -0
- package/{lib → dist}/commands/data/connectors/index.js +23 -24
- package/dist/commands/data/connectors/info.d.ts +12 -0
- package/{lib → dist}/commands/data/connectors/info.js +22 -23
- package/{lib → dist}/commands/data/connectors/pause.d.ts +2 -2
- package/dist/commands/data/connectors/pause.js +27 -0
- package/{lib → dist}/commands/data/connectors/resume.d.ts +2 -2
- package/dist/commands/data/connectors/resume.js +27 -0
- package/dist/commands/data/connectors/update.d.ts +17 -0
- package/{lib → dist}/commands/data/connectors/update.js +19 -21
- package/{lib → dist}/commands/data/connectors/wait.d.ts +2 -2
- package/{lib → dist}/commands/data/connectors/wait.js +11 -10
- package/dist/commands/data/enhanced-certificates/disable.d.ts +11 -0
- package/dist/commands/data/enhanced-certificates/disable.js +31 -0
- package/dist/commands/data/enhanced-certificates/enable.d.ts +12 -0
- package/dist/commands/data/enhanced-certificates/enable.js +34 -0
- package/dist/commands/data/enhanced-certificates/status.d.ts +12 -0
- package/dist/commands/data/enhanced-certificates/status.js +30 -0
- package/dist/commands/data/labs/disable.d.ts +13 -0
- package/dist/commands/data/labs/disable.js +44 -0
- package/dist/commands/data/labs/enable.d.ts +13 -0
- package/dist/commands/data/labs/enable.js +44 -0
- package/{lib → dist}/commands/data/labs/list.d.ts +3 -3
- package/{lib → dist}/commands/data/labs/list.js +18 -19
- package/dist/index.d.ts +1 -0
- package/dist/index.js +1 -0
- package/dist/lib/base.js +25 -0
- package/oclif.manifest.json +149 -48
- package/package.json +33 -30
- package/lib/commands/data/connectors/create.d.ts +0 -15
- package/lib/commands/data/connectors/destroy.d.ts +0 -12
- package/lib/commands/data/connectors/destroy.js +0 -41
- package/lib/commands/data/connectors/index.d.ts +0 -14
- package/lib/commands/data/connectors/info.d.ts +0 -12
- package/lib/commands/data/connectors/pause.js +0 -28
- package/lib/commands/data/connectors/resume.js +0 -28
- package/lib/commands/data/connectors/update.d.ts +0 -17
- package/lib/commands/data/enhanced-certificates/disable.d.ts +0 -11
- package/lib/commands/data/enhanced-certificates/disable.js +0 -31
- package/lib/commands/data/enhanced-certificates/enable.d.ts +0 -12
- package/lib/commands/data/enhanced-certificates/enable.js +0 -34
- package/lib/commands/data/enhanced-certificates/status.d.ts +0 -12
- package/lib/commands/data/enhanced-certificates/status.js +0 -31
- package/lib/commands/data/labs/disable.d.ts +0 -13
- package/lib/commands/data/labs/disable.js +0 -44
- package/lib/commands/data/labs/enable.d.ts +0 -13
- package/lib/commands/data/labs/enable.js +0 -44
- package/lib/fetcher.d.ts +0 -3
- package/lib/fetcher.js +0 -16
- package/lib/index.d.ts +0 -2
- package/lib/index.js +0 -3
- package/lib/lib/base.js +0 -28
- package/lib/tsconfig.tsbuildinfo +0 -1
- /package/{lib → dist}/lib/base.d.ts +0 -0
package/README.md
CHANGED
|
@@ -58,7 +58,7 @@ List all Data Connectors for a particular app or addon
|
|
|
58
58
|
|
|
59
59
|
```
|
|
60
60
|
USAGE
|
|
61
|
-
$ heroku data:connectors [--addon <value>] [-a <value>] [--json | --table] [-r <value>]
|
|
61
|
+
$ heroku data:connectors [--prompt] [--addon <value>] [-a <value>] [--json | --table] [-r <value>]
|
|
62
62
|
|
|
63
63
|
FLAGS
|
|
64
64
|
-a, --app=<value> app to run command against
|
|
@@ -67,6 +67,9 @@ FLAGS
|
|
|
67
67
|
--json Return the results as JSON
|
|
68
68
|
--table Return the results as a table
|
|
69
69
|
|
|
70
|
+
GLOBAL FLAGS
|
|
71
|
+
--prompt interactively prompt for command arguments and flags
|
|
72
|
+
|
|
70
73
|
DESCRIPTION
|
|
71
74
|
List all Data Connectors for a particular app or addon
|
|
72
75
|
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors
|
|
@@ -82,7 +85,7 @@ EXAMPLES
|
|
|
82
85
|
$ heroku data:connectors --addon=your-postgres-addon --table
|
|
83
86
|
```
|
|
84
87
|
|
|
85
|
-
_See code: [src/commands/data/connectors/index.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/
|
|
88
|
+
_See code: [src/commands/data/connectors/index.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v3.0.1-beta.0/src/commands/data/connectors/index.ts)_
|
|
86
89
|
|
|
87
90
|
## `heroku data:connectors:create`
|
|
88
91
|
|
|
@@ -90,8 +93,8 @@ create a new Data Connector
|
|
|
90
93
|
|
|
91
94
|
```
|
|
92
95
|
USAGE
|
|
93
|
-
$ heroku data:connectors:create --source <value> --store <value> -t <value>... [-a <value>] [--exclude-column
|
|
94
|
-
[--name <value>]
|
|
96
|
+
$ heroku data:connectors:create --source <value> --store <value> -t <value>... [--prompt] [-a <value>] [--exclude-column
|
|
97
|
+
<value>...] [--name <value>]
|
|
95
98
|
|
|
96
99
|
FLAGS
|
|
97
100
|
-a, --app=<value> app to run command against
|
|
@@ -101,6 +104,9 @@ FLAGS
|
|
|
101
104
|
--source=<value> (required) The name of the database add-on whose change data you want to store
|
|
102
105
|
--store=<value> (required) The name of the database add-on that will store the change data
|
|
103
106
|
|
|
107
|
+
GLOBAL FLAGS
|
|
108
|
+
--prompt interactively prompt for command arguments and flags
|
|
109
|
+
|
|
104
110
|
DESCRIPTION
|
|
105
111
|
create a new Data Connector
|
|
106
112
|
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors
|
|
@@ -111,7 +117,7 @@ EXAMPLES
|
|
|
111
117
|
$ heroku data:connectors:create --store kafka-lovely-12345 --source postgresql-neato-98765 --table public.users --exclude-column public.users.password
|
|
112
118
|
```
|
|
113
119
|
|
|
114
|
-
_See code: [src/commands/data/connectors/create.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/
|
|
120
|
+
_See code: [src/commands/data/connectors/create.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v3.0.1-beta.0/src/commands/data/connectors/create.ts)_
|
|
115
121
|
|
|
116
122
|
## `heroku data:connectors:destroy CONNECTOR`
|
|
117
123
|
|
|
@@ -119,7 +125,7 @@ Destroy a Data Connector
|
|
|
119
125
|
|
|
120
126
|
```
|
|
121
127
|
USAGE
|
|
122
|
-
$ heroku data:connectors:destroy CONNECTOR [--confirm <value>]
|
|
128
|
+
$ heroku data:connectors:destroy CONNECTOR [--prompt] [--confirm <value>]
|
|
123
129
|
|
|
124
130
|
ARGUMENTS
|
|
125
131
|
CONNECTOR name of the connector
|
|
@@ -127,6 +133,9 @@ ARGUMENTS
|
|
|
127
133
|
FLAGS
|
|
128
134
|
--confirm=<value> confirms destroying the connector if passed in
|
|
129
135
|
|
|
136
|
+
GLOBAL FLAGS
|
|
137
|
+
--prompt interactively prompt for command arguments and flags
|
|
138
|
+
|
|
130
139
|
DESCRIPTION
|
|
131
140
|
Destroy a Data Connector
|
|
132
141
|
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors
|
|
@@ -137,7 +146,7 @@ EXAMPLES
|
|
|
137
146
|
$ heroku data:connectors:destroy gentle-connector-1234 --confirm gentle-connector-1234
|
|
138
147
|
```
|
|
139
148
|
|
|
140
|
-
_See code: [src/commands/data/connectors/destroy.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/
|
|
149
|
+
_See code: [src/commands/data/connectors/destroy.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v3.0.1-beta.0/src/commands/data/connectors/destroy.ts)_
|
|
141
150
|
|
|
142
151
|
## `heroku data:connectors:info CONNECTOR`
|
|
143
152
|
|
|
@@ -145,7 +154,7 @@ Get information about a Data Connector
|
|
|
145
154
|
|
|
146
155
|
```
|
|
147
156
|
USAGE
|
|
148
|
-
$ heroku data:connectors:info CONNECTOR [--json]
|
|
157
|
+
$ heroku data:connectors:info CONNECTOR [--prompt] [--json]
|
|
149
158
|
|
|
150
159
|
ARGUMENTS
|
|
151
160
|
CONNECTOR name of the connector
|
|
@@ -153,6 +162,9 @@ ARGUMENTS
|
|
|
153
162
|
FLAGS
|
|
154
163
|
--json Return the results as JSON
|
|
155
164
|
|
|
165
|
+
GLOBAL FLAGS
|
|
166
|
+
--prompt interactively prompt for command arguments and flags
|
|
167
|
+
|
|
156
168
|
DESCRIPTION
|
|
157
169
|
Get information about a Data Connector
|
|
158
170
|
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors
|
|
@@ -163,7 +175,7 @@ EXAMPLES
|
|
|
163
175
|
$ heroku data:connectors:info gentle-connector-1234 --json
|
|
164
176
|
```
|
|
165
177
|
|
|
166
|
-
_See code: [src/commands/data/connectors/info.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/
|
|
178
|
+
_See code: [src/commands/data/connectors/info.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v3.0.1-beta.0/src/commands/data/connectors/info.ts)_
|
|
167
179
|
|
|
168
180
|
## `heroku data:connectors:list`
|
|
169
181
|
|
|
@@ -171,7 +183,7 @@ List all Data Connectors for a particular app or addon
|
|
|
171
183
|
|
|
172
184
|
```
|
|
173
185
|
USAGE
|
|
174
|
-
$ heroku data:connectors:list [--addon <value>] [-a <value>] [--json | --table] [-r <value>]
|
|
186
|
+
$ heroku data:connectors:list [--prompt] [--addon <value>] [-a <value>] [--json | --table] [-r <value>]
|
|
175
187
|
|
|
176
188
|
FLAGS
|
|
177
189
|
-a, --app=<value> app to run command against
|
|
@@ -180,6 +192,9 @@ FLAGS
|
|
|
180
192
|
--json Return the results as JSON
|
|
181
193
|
--table Return the results as a table
|
|
182
194
|
|
|
195
|
+
GLOBAL FLAGS
|
|
196
|
+
--prompt interactively prompt for command arguments and flags
|
|
197
|
+
|
|
183
198
|
DESCRIPTION
|
|
184
199
|
List all Data Connectors for a particular app or addon
|
|
185
200
|
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors
|
|
@@ -201,11 +216,14 @@ Pause change event creation on a Data Connector
|
|
|
201
216
|
|
|
202
217
|
```
|
|
203
218
|
USAGE
|
|
204
|
-
$ heroku data:connectors:pause CONNECTOR
|
|
219
|
+
$ heroku data:connectors:pause CONNECTOR [--prompt]
|
|
205
220
|
|
|
206
221
|
ARGUMENTS
|
|
207
222
|
CONNECTOR name of the connector
|
|
208
223
|
|
|
224
|
+
GLOBAL FLAGS
|
|
225
|
+
--prompt interactively prompt for command arguments and flags
|
|
226
|
+
|
|
209
227
|
DESCRIPTION
|
|
210
228
|
Pause change event creation on a Data Connector
|
|
211
229
|
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors
|
|
@@ -214,7 +232,7 @@ EXAMPLES
|
|
|
214
232
|
$ heroku data:connectors:pause gentle-connector-1234
|
|
215
233
|
```
|
|
216
234
|
|
|
217
|
-
_See code: [src/commands/data/connectors/pause.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/
|
|
235
|
+
_See code: [src/commands/data/connectors/pause.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v3.0.1-beta.0/src/commands/data/connectors/pause.ts)_
|
|
218
236
|
|
|
219
237
|
## `heroku data:connectors:resume CONNECTOR`
|
|
220
238
|
|
|
@@ -222,11 +240,14 @@ Resume change event creation on a Data Connector
|
|
|
222
240
|
|
|
223
241
|
```
|
|
224
242
|
USAGE
|
|
225
|
-
$ heroku data:connectors:resume CONNECTOR
|
|
243
|
+
$ heroku data:connectors:resume CONNECTOR [--prompt]
|
|
226
244
|
|
|
227
245
|
ARGUMENTS
|
|
228
246
|
CONNECTOR name of the connector
|
|
229
247
|
|
|
248
|
+
GLOBAL FLAGS
|
|
249
|
+
--prompt interactively prompt for command arguments and flags
|
|
250
|
+
|
|
230
251
|
DESCRIPTION
|
|
231
252
|
Resume change event creation on a Data Connector
|
|
232
253
|
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors
|
|
@@ -235,7 +256,7 @@ EXAMPLES
|
|
|
235
256
|
$ heroku data:connectors:resume gentle-connector-1234
|
|
236
257
|
```
|
|
237
258
|
|
|
238
|
-
_See code: [src/commands/data/connectors/resume.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/
|
|
259
|
+
_See code: [src/commands/data/connectors/resume.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v3.0.1-beta.0/src/commands/data/connectors/resume.ts)_
|
|
239
260
|
|
|
240
261
|
## `heroku data:connectors:update CONNECTOR`
|
|
241
262
|
|
|
@@ -243,8 +264,8 @@ Update the settings, tables, and columns to exclude for a Data Connector
|
|
|
243
264
|
|
|
244
265
|
```
|
|
245
266
|
USAGE
|
|
246
|
-
$ heroku data:connectors:update CONNECTOR [--setting <value>...] [--add-table <value>...] [--remove-table
|
|
247
|
-
[--exclude-column <value>...] [--remove-excluded-column <value>...]
|
|
267
|
+
$ heroku data:connectors:update CONNECTOR [--prompt] [--setting <value>...] [--add-table <value>...] [--remove-table
|
|
268
|
+
<value>...] [--exclude-column <value>...] [--remove-excluded-column <value>...]
|
|
248
269
|
|
|
249
270
|
ARGUMENTS
|
|
250
271
|
CONNECTOR name of the connector
|
|
@@ -256,6 +277,9 @@ FLAGS
|
|
|
256
277
|
--remove-table=<value>... Tables to remove
|
|
257
278
|
--setting=<value>...
|
|
258
279
|
|
|
280
|
+
GLOBAL FLAGS
|
|
281
|
+
--prompt interactively prompt for command arguments and flags
|
|
282
|
+
|
|
259
283
|
DESCRIPTION
|
|
260
284
|
Update the settings, tables, and columns to exclude for a Data Connector
|
|
261
285
|
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors#update-configuration
|
|
@@ -264,7 +288,7 @@ EXAMPLES
|
|
|
264
288
|
$ 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
|
|
265
289
|
```
|
|
266
290
|
|
|
267
|
-
_See code: [src/commands/data/connectors/update.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/
|
|
291
|
+
_See code: [src/commands/data/connectors/update.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v3.0.1-beta.0/src/commands/data/connectors/update.ts)_
|
|
268
292
|
|
|
269
293
|
## `heroku data:connectors:wait CONNECTOR`
|
|
270
294
|
|
|
@@ -272,11 +296,14 @@ Wait for your Data Connector to be provisioned
|
|
|
272
296
|
|
|
273
297
|
```
|
|
274
298
|
USAGE
|
|
275
|
-
$ heroku data:connectors:wait CONNECTOR
|
|
299
|
+
$ heroku data:connectors:wait CONNECTOR [--prompt]
|
|
276
300
|
|
|
277
301
|
ARGUMENTS
|
|
278
302
|
CONNECTOR name of the connector
|
|
279
303
|
|
|
304
|
+
GLOBAL FLAGS
|
|
305
|
+
--prompt interactively prompt for command arguments and flags
|
|
306
|
+
|
|
280
307
|
DESCRIPTION
|
|
281
308
|
Wait for your Data Connector to be provisioned
|
|
282
309
|
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors
|
|
@@ -285,7 +312,7 @@ EXAMPLES
|
|
|
285
312
|
$ heroku data:connectors:wait gentle-connector-1234
|
|
286
313
|
```
|
|
287
314
|
|
|
288
|
-
_See code: [src/commands/data/connectors/wait.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/
|
|
315
|
+
_See code: [src/commands/data/connectors/wait.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v3.0.1-beta.0/src/commands/data/connectors/wait.ts)_
|
|
289
316
|
|
|
290
317
|
## `heroku data:enhanced-certificates:disable ADDON`
|
|
291
318
|
|
|
@@ -293,7 +320,7 @@ Disable enhanced certificates on an Addon
|
|
|
293
320
|
|
|
294
321
|
```
|
|
295
322
|
USAGE
|
|
296
|
-
$ heroku data:enhanced-certificates:disable ADDON [-a <value>]
|
|
323
|
+
$ heroku data:enhanced-certificates:disable ADDON [--prompt] [-a <value>]
|
|
297
324
|
|
|
298
325
|
ARGUMENTS
|
|
299
326
|
ADDON name of the addon
|
|
@@ -301,12 +328,15 @@ ARGUMENTS
|
|
|
301
328
|
FLAGS
|
|
302
329
|
-a, --app=<value> app to run command against
|
|
303
330
|
|
|
331
|
+
GLOBAL FLAGS
|
|
332
|
+
--prompt interactively prompt for command arguments and flags
|
|
333
|
+
|
|
304
334
|
DESCRIPTION
|
|
305
335
|
Disable enhanced certificates on an Addon
|
|
306
336
|
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-enhanced-certificates
|
|
307
337
|
```
|
|
308
338
|
|
|
309
|
-
_See code: [src/commands/data/enhanced-certificates/disable.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/
|
|
339
|
+
_See code: [src/commands/data/enhanced-certificates/disable.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v3.0.1-beta.0/src/commands/data/enhanced-certificates/disable.ts)_
|
|
310
340
|
|
|
311
341
|
## `heroku data:enhanced-certificates:enable ADDON`
|
|
312
342
|
|
|
@@ -314,7 +344,7 @@ Enable enhanced certificates on an Addon
|
|
|
314
344
|
|
|
315
345
|
```
|
|
316
346
|
USAGE
|
|
317
|
-
$ heroku data:enhanced-certificates:enable ADDON [-a <value>]
|
|
347
|
+
$ heroku data:enhanced-certificates:enable ADDON [--prompt] [-a <value>]
|
|
318
348
|
|
|
319
349
|
ARGUMENTS
|
|
320
350
|
ADDON name of the addon
|
|
@@ -322,6 +352,9 @@ ARGUMENTS
|
|
|
322
352
|
FLAGS
|
|
323
353
|
-a, --app=<value> app to run command against
|
|
324
354
|
|
|
355
|
+
GLOBAL FLAGS
|
|
356
|
+
--prompt interactively prompt for command arguments and flags
|
|
357
|
+
|
|
325
358
|
DESCRIPTION
|
|
326
359
|
Enable enhanced certificates on an Addon
|
|
327
360
|
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-enhanced-certificates
|
|
@@ -330,7 +363,7 @@ EXAMPLES
|
|
|
330
363
|
$ heroku data:enhanced-certificates:enable happy-postgres-1234 -a example-app
|
|
331
364
|
```
|
|
332
365
|
|
|
333
|
-
_See code: [src/commands/data/enhanced-certificates/enable.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/
|
|
366
|
+
_See code: [src/commands/data/enhanced-certificates/enable.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v3.0.1-beta.0/src/commands/data/enhanced-certificates/enable.ts)_
|
|
334
367
|
|
|
335
368
|
## `heroku data:enhanced-certificates:status ADDON`
|
|
336
369
|
|
|
@@ -338,7 +371,7 @@ Get the status of Enhanced Certificates
|
|
|
338
371
|
|
|
339
372
|
```
|
|
340
373
|
USAGE
|
|
341
|
-
$ heroku data:enhanced-certificates:status ADDON [-a <value>] [--json]
|
|
374
|
+
$ heroku data:enhanced-certificates:status ADDON [--prompt] [-a <value>] [--json]
|
|
342
375
|
|
|
343
376
|
ARGUMENTS
|
|
344
377
|
ADDON name of the addon
|
|
@@ -347,12 +380,15 @@ FLAGS
|
|
|
347
380
|
-a, --app=<value> app to run command against
|
|
348
381
|
--json Return the results as JSON
|
|
349
382
|
|
|
383
|
+
GLOBAL FLAGS
|
|
384
|
+
--prompt interactively prompt for command arguments and flags
|
|
385
|
+
|
|
350
386
|
DESCRIPTION
|
|
351
387
|
Get the status of Enhanced Certificates
|
|
352
388
|
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-enhanced-certificates
|
|
353
389
|
```
|
|
354
390
|
|
|
355
|
-
_See code: [src/commands/data/enhanced-certificates/status.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/
|
|
391
|
+
_See code: [src/commands/data/enhanced-certificates/status.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v3.0.1-beta.0/src/commands/data/enhanced-certificates/status.ts)_
|
|
356
392
|
|
|
357
393
|
## `heroku data:labs:disable FEATURE`
|
|
358
394
|
|
|
@@ -360,7 +396,7 @@ Disable experimental features on an addon
|
|
|
360
396
|
|
|
361
397
|
```
|
|
362
398
|
USAGE
|
|
363
|
-
$ heroku data:labs:disable FEATURE --addon <value> [-a <value>]
|
|
399
|
+
$ heroku data:labs:disable FEATURE --addon <value> [--prompt] [-a <value>]
|
|
364
400
|
|
|
365
401
|
ARGUMENTS
|
|
366
402
|
FEATURE name of the feature
|
|
@@ -369,6 +405,9 @@ FLAGS
|
|
|
369
405
|
-a, --app=<value> app to run command against
|
|
370
406
|
--addon=<value> (required) The addon you want to disable features on
|
|
371
407
|
|
|
408
|
+
GLOBAL FLAGS
|
|
409
|
+
--prompt interactively prompt for command arguments and flags
|
|
410
|
+
|
|
372
411
|
DESCRIPTION
|
|
373
412
|
Disable experimental features on an addon
|
|
374
413
|
|
|
@@ -376,7 +415,7 @@ EXAMPLES
|
|
|
376
415
|
$ heroku data:labs:disable wal-compression --addon=happy-postgres-1234 -a example-app
|
|
377
416
|
```
|
|
378
417
|
|
|
379
|
-
_See code: [src/commands/data/labs/disable.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/
|
|
418
|
+
_See code: [src/commands/data/labs/disable.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v3.0.1-beta.0/src/commands/data/labs/disable.ts)_
|
|
380
419
|
|
|
381
420
|
## `heroku data:labs:enable FEATURE`
|
|
382
421
|
|
|
@@ -384,7 +423,7 @@ Enable experimental features on an addon
|
|
|
384
423
|
|
|
385
424
|
```
|
|
386
425
|
USAGE
|
|
387
|
-
$ heroku data:labs:enable FEATURE --addon <value> [-a <value>]
|
|
426
|
+
$ heroku data:labs:enable FEATURE --addon <value> [--prompt] [-a <value>]
|
|
388
427
|
|
|
389
428
|
ARGUMENTS
|
|
390
429
|
FEATURE name of the feature
|
|
@@ -393,6 +432,9 @@ FLAGS
|
|
|
393
432
|
-a, --app=<value> app to run command against
|
|
394
433
|
--addon=<value> (required) The addon you want to enable features on
|
|
395
434
|
|
|
435
|
+
GLOBAL FLAGS
|
|
436
|
+
--prompt interactively prompt for command arguments and flags
|
|
437
|
+
|
|
396
438
|
DESCRIPTION
|
|
397
439
|
Enable experimental features on an addon
|
|
398
440
|
|
|
@@ -400,7 +442,7 @@ EXAMPLES
|
|
|
400
442
|
$ heroku data:labs:enable wal-compression --addon=happy-postgres-1234 -a example-app
|
|
401
443
|
```
|
|
402
444
|
|
|
403
|
-
_See code: [src/commands/data/labs/enable.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/
|
|
445
|
+
_See code: [src/commands/data/labs/enable.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v3.0.1-beta.0/src/commands/data/labs/enable.ts)_
|
|
404
446
|
|
|
405
447
|
## `heroku data:labs:list ADDON`
|
|
406
448
|
|
|
@@ -408,7 +450,7 @@ List available experimental features on an addon and their statuses
|
|
|
408
450
|
|
|
409
451
|
```
|
|
410
452
|
USAGE
|
|
411
|
-
$ heroku data:labs:list ADDON [-a <value>]
|
|
453
|
+
$ heroku data:labs:list ADDON [--prompt] [-a <value>]
|
|
412
454
|
|
|
413
455
|
ARGUMENTS
|
|
414
456
|
ADDON name of the addon
|
|
@@ -416,6 +458,9 @@ ARGUMENTS
|
|
|
416
458
|
FLAGS
|
|
417
459
|
-a, --app=<value> app to run command against
|
|
418
460
|
|
|
461
|
+
GLOBAL FLAGS
|
|
462
|
+
--prompt interactively prompt for command arguments and flags
|
|
463
|
+
|
|
419
464
|
DESCRIPTION
|
|
420
465
|
List available experimental features on an addon and their statuses
|
|
421
466
|
|
|
@@ -423,5 +468,5 @@ EXAMPLES
|
|
|
423
468
|
$ heroku data:labs:list happy-postgres-1234
|
|
424
469
|
```
|
|
425
470
|
|
|
426
|
-
_See code: [src/commands/data/labs/list.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/
|
|
471
|
+
_See code: [src/commands/data/labs/list.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v3.0.1-beta.0/src/commands/data/labs/list.ts)_
|
|
427
472
|
<!-- commandsstop -->
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import BaseCommand from '../../../lib/base.js';
|
|
2
|
+
export default class ConnectorsCreate extends BaseCommand {
|
|
3
|
+
static description: string;
|
|
4
|
+
static examples: string[];
|
|
5
|
+
static flags: {
|
|
6
|
+
app: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
|
|
7
|
+
'exclude-column': import("@oclif/core/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
8
|
+
name: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
9
|
+
'platform-version': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
10
|
+
source: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
|
|
11
|
+
store: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
|
|
12
|
+
table: import("@oclif/core/interfaces").OptionFlag<string[], import("@oclif/core/interfaces").CustomOptions>;
|
|
13
|
+
};
|
|
14
|
+
run(): Promise<void>;
|
|
15
|
+
}
|
|
@@ -1,40 +1,39 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
class ConnectorsCreate extends base_1.default {
|
|
1
|
+
import { flags } from '@heroku-cli/command';
|
|
2
|
+
import * as color from '@heroku/heroku-cli-util/color';
|
|
3
|
+
import { styledObject } from '@heroku/heroku-cli-util/hux';
|
|
4
|
+
import { AddonResolver } from '@heroku/heroku-cli-util/utils/addons';
|
|
5
|
+
import { ux } from '@oclif/core/ux';
|
|
6
|
+
import BaseCommand from '../../../lib/base.js';
|
|
7
|
+
export default class ConnectorsCreate extends BaseCommand {
|
|
9
8
|
static description = 'create a new Data Connector\nRead more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors';
|
|
10
9
|
static examples = [
|
|
11
10
|
'$ heroku data:connectors:create --store kafka-lovely-12345 --source postgresql-neato-98765 --table public.posts --table public.comments',
|
|
12
11
|
'$ heroku data:connectors:create --store kafka-lovely-12345 --source postgresql-neato-98765 --table public.users --exclude-column public.users.password',
|
|
13
12
|
];
|
|
14
13
|
static flags = {
|
|
15
|
-
app:
|
|
16
|
-
'exclude-column':
|
|
14
|
+
app: flags.app(),
|
|
15
|
+
'exclude-column': flags.string({
|
|
17
16
|
description: 'Columns to exclude',
|
|
18
17
|
multiple: true,
|
|
19
18
|
}),
|
|
20
|
-
name:
|
|
19
|
+
name: flags.string({
|
|
21
20
|
description: 'Name of the connector',
|
|
22
21
|
required: false,
|
|
23
22
|
}),
|
|
24
|
-
'platform-version':
|
|
23
|
+
'platform-version': flags.string({
|
|
25
24
|
char: 'p',
|
|
26
25
|
hidden: true,
|
|
27
26
|
required: false,
|
|
28
27
|
}),
|
|
29
|
-
source:
|
|
28
|
+
source: flags.string({
|
|
30
29
|
description: 'The name of the database add-on whose change data you want to store',
|
|
31
30
|
required: true,
|
|
32
31
|
}),
|
|
33
|
-
store:
|
|
32
|
+
store: flags.string({
|
|
34
33
|
description: 'The name of the database add-on that will store the change data',
|
|
35
34
|
required: true,
|
|
36
35
|
}),
|
|
37
|
-
table:
|
|
36
|
+
table: flags.string({
|
|
38
37
|
char: 't',
|
|
39
38
|
description: 'Tables to include',
|
|
40
39
|
multiple: true,
|
|
@@ -47,9 +46,10 @@ class ConnectorsCreate extends base_1.default {
|
|
|
47
46
|
const excluded = flags['exclude-column'] || [];
|
|
48
47
|
const platformVersion = flags['platform-version'] || '';
|
|
49
48
|
const name = flags.name || '';
|
|
50
|
-
const
|
|
51
|
-
const
|
|
52
|
-
|
|
49
|
+
const addonResolver = new AddonResolver(this.heroku);
|
|
50
|
+
const kafka = await addonResolver.resolve(flags.store, flags.app);
|
|
51
|
+
const postgres = await addonResolver.resolve(flags.source, flags.app);
|
|
52
|
+
ux.action.start('Provisioning Data Connector');
|
|
53
53
|
const { body: res } = await this.shogun.post(`/data/cdc/v0/kafka_tenants/${kafka.id}`, {
|
|
54
54
|
...this.shogun.defaults,
|
|
55
55
|
body: {
|
|
@@ -60,15 +60,13 @@ class ConnectorsCreate extends base_1.default {
|
|
|
60
60
|
tables,
|
|
61
61
|
},
|
|
62
62
|
});
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
63
|
+
ux.action.stop();
|
|
64
|
+
ux.stdout();
|
|
65
|
+
styledObject({
|
|
66
66
|
Name: res.name,
|
|
67
67
|
Status: res.status,
|
|
68
68
|
});
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
+ ' to check the creation process.');
|
|
69
|
+
ux.stdout();
|
|
70
|
+
ux.stdout(`Use ${color.command('heroku data:connectors:wait ' + res.name)} to check the creation process.`);
|
|
72
71
|
}
|
|
73
72
|
}
|
|
74
|
-
exports.default = ConnectorsCreate;
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import BaseCommand from '../../../lib/base.js';
|
|
2
|
+
export default class ConnectorsDestroy extends BaseCommand {
|
|
3
|
+
static args: {
|
|
4
|
+
connector: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
|
|
5
|
+
};
|
|
6
|
+
static description: string;
|
|
7
|
+
static examples: string[];
|
|
8
|
+
static flags: {
|
|
9
|
+
confirm: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
10
|
+
};
|
|
11
|
+
run(): Promise<void>;
|
|
12
|
+
}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import { flags } from '@heroku-cli/command';
|
|
2
|
+
import { Args } from '@oclif/core';
|
|
3
|
+
import { ux } from '@oclif/core/ux';
|
|
4
|
+
import BaseCommand, { confirmConnector } from '../../../lib/base.js';
|
|
5
|
+
export default class ConnectorsDestroy extends BaseCommand {
|
|
6
|
+
static args = {
|
|
7
|
+
connector: Args.string({ description: 'name of the connector', required: true }),
|
|
8
|
+
};
|
|
9
|
+
static description = 'Destroy a Data Connector\nRead more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors';
|
|
10
|
+
static examples = [
|
|
11
|
+
'$ heroku data:connectors:destroy gentle-connector-1234',
|
|
12
|
+
'$ heroku data:connectors:destroy gentle-connector-1234 --confirm gentle-connector-1234',
|
|
13
|
+
];
|
|
14
|
+
static flags = {
|
|
15
|
+
confirm: flags.string({
|
|
16
|
+
description: 'confirms destroying the connector if passed in',
|
|
17
|
+
required: false,
|
|
18
|
+
}),
|
|
19
|
+
};
|
|
20
|
+
async run() {
|
|
21
|
+
const { args, flags } = await this.parse(ConnectorsDestroy);
|
|
22
|
+
const { connector } = args;
|
|
23
|
+
const confirm = flags.confirm || '';
|
|
24
|
+
await confirmConnector(connector, confirm);
|
|
25
|
+
ux.action.start('Destroying Data Connector');
|
|
26
|
+
try {
|
|
27
|
+
await this.shogun.delete(`/data/cdc/v0/connectors/${connector}`, this.shogun.defaults);
|
|
28
|
+
ux.stdout(`Data Connector ${connector} deleted successfully.`);
|
|
29
|
+
ux.stdout('Note: We do not delete your Kafka topics automatically, because they could still contain messages which you haven\'t consumed. Please delete the topics manually. See heroku kafka:topics:destroy --help');
|
|
30
|
+
}
|
|
31
|
+
catch (error) {
|
|
32
|
+
ux.warn('There was an issue deleting your Data Connector.');
|
|
33
|
+
throw error;
|
|
34
|
+
}
|
|
35
|
+
finally {
|
|
36
|
+
ux.action.stop();
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import BaseCommand from '../../../lib/base.js';
|
|
2
|
+
export default class ConnectorsList extends BaseCommand {
|
|
3
|
+
static aliases: string[];
|
|
4
|
+
static description: string;
|
|
5
|
+
static examples: string[];
|
|
6
|
+
static flags: {
|
|
7
|
+
addon: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
8
|
+
app: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
|
|
9
|
+
json: import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
10
|
+
remote: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
11
|
+
table: import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
12
|
+
};
|
|
13
|
+
run(): Promise<void>;
|
|
14
|
+
}
|
|
@@ -1,10 +1,9 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
class ConnectorsList extends base_1.default {
|
|
1
|
+
import { flags } from '@heroku-cli/command';
|
|
2
|
+
import { styledHeader, styledJSON, styledObject, table } from '@heroku/heroku-cli-util/hux';
|
|
3
|
+
import { AddonResolver } from '@heroku/heroku-cli-util/utils/addons';
|
|
4
|
+
import { ux } from '@oclif/core/ux';
|
|
5
|
+
import BaseCommand from '../../../lib/base.js';
|
|
6
|
+
export default class ConnectorsList extends BaseCommand {
|
|
8
7
|
static aliases = [
|
|
9
8
|
'data:connectors:list',
|
|
10
9
|
];
|
|
@@ -15,16 +14,16 @@ class ConnectorsList extends base_1.default {
|
|
|
15
14
|
'heroku data:connectors --addon=your-postgres-addon --table',
|
|
16
15
|
];
|
|
17
16
|
static flags = {
|
|
18
|
-
addon:
|
|
17
|
+
addon: flags.string({
|
|
19
18
|
description: 'The ID or name for the addon your connector is attached to',
|
|
20
19
|
}),
|
|
21
|
-
app:
|
|
22
|
-
json:
|
|
20
|
+
app: flags.app(),
|
|
21
|
+
json: flags.boolean({
|
|
23
22
|
description: 'Return the results as JSON',
|
|
24
23
|
exclusive: ['table'],
|
|
25
24
|
}),
|
|
26
|
-
remote:
|
|
27
|
-
table:
|
|
25
|
+
remote: flags.remote(),
|
|
26
|
+
table: flags.boolean({
|
|
28
27
|
description: 'Return the results as a table',
|
|
29
28
|
exclusive: ['json'],
|
|
30
29
|
}),
|
|
@@ -33,29 +32,30 @@ class ConnectorsList extends base_1.default {
|
|
|
33
32
|
const { flags } = await this.parse(ConnectorsList);
|
|
34
33
|
let connectorInfo;
|
|
35
34
|
if (flags.addon) {
|
|
36
|
-
const
|
|
35
|
+
const addonResolver = new AddonResolver(this.heroku);
|
|
36
|
+
const addon = await addonResolver.resolve(flags.addon, flags.app);
|
|
37
37
|
const { body: response } = await this.shogun.get(`/data/cdc/v0/addons/${addon.id}`, this.shogun.defaults);
|
|
38
38
|
connectorInfo = response;
|
|
39
39
|
}
|
|
40
40
|
else if (flags.app) {
|
|
41
41
|
// make sure we have app id even if they passed app name
|
|
42
42
|
const { body: app } = await this.heroku.get(`/apps/${flags.app}`);
|
|
43
|
-
const response = await this.shogun.get(`/data/cdc/v0/apps/${app.id}`, this.shogun.defaults);
|
|
44
|
-
connectorInfo = response
|
|
43
|
+
const { body: response } = await this.shogun.get(`/data/cdc/v0/apps/${app.id}`, this.shogun.defaults);
|
|
44
|
+
connectorInfo = response;
|
|
45
45
|
}
|
|
46
46
|
else {
|
|
47
|
-
|
|
47
|
+
ux.error('You must pass either the --app or --addon flag');
|
|
48
48
|
}
|
|
49
49
|
if (flags.json) {
|
|
50
50
|
for (const v of connectorInfo) {
|
|
51
|
-
|
|
52
|
-
|
|
51
|
+
styledJSON(v);
|
|
52
|
+
ux.stdout();
|
|
53
53
|
}
|
|
54
54
|
return;
|
|
55
55
|
}
|
|
56
|
-
|
|
56
|
+
styledHeader(`Data Connector info for ${flags.app || flags.addon}`);
|
|
57
57
|
if (flags.table) {
|
|
58
|
-
|
|
58
|
+
table(connectorInfo, {
|
|
59
59
|
name: { header: 'Connector Name' },
|
|
60
60
|
kafka_addon: {
|
|
61
61
|
header: 'Kafka Add-On',
|
|
@@ -71,17 +71,16 @@ class ConnectorsList extends base_1.default {
|
|
|
71
71
|
}
|
|
72
72
|
else {
|
|
73
73
|
for (const c of connectorInfo) {
|
|
74
|
-
|
|
74
|
+
styledObject({
|
|
75
75
|
'Connector Name': c.name,
|
|
76
76
|
'Kafka Add-On': c.kafka_addon.name,
|
|
77
77
|
'Postgres Add-On': c.postgres_addon.name,
|
|
78
78
|
Tables: c.tables,
|
|
79
79
|
'Excluded Columns': c.excluded_columns,
|
|
80
80
|
});
|
|
81
|
-
|
|
81
|
+
ux.stdout();
|
|
82
82
|
}
|
|
83
83
|
}
|
|
84
|
-
|
|
84
|
+
ux.stdout();
|
|
85
85
|
}
|
|
86
86
|
}
|
|
87
|
-
exports.default = ConnectorsList;
|