@heroku-cli/plugin-data
v1.3.3
Published
A Heroku CLI Plugin for managing Heroku Data
Downloads
417
Maintainers
Keywords
Readme
Heroku CLI Data Plugin
A Heroku CLI Plugin for managing Heroku Data Addons and Features
- Connectors
- Enhanced Certificates
You can read more about Heroku Data Connectors on Dev Center.
You can read more about Heroku Data Enhanced Certificates on the Dev Center.
Usage
$ heroku plugins:install data
$ heroku COMMAND
running command...
$ heroku (-v|--version|version)
@heroku-cli/plugin-data-connectors/0.2.2 darwin-x64 node-v12.10.0
$ heroku --help [COMMAND]
USAGE
$ heroku COMMAND
...
Commands
heroku data:connectors
heroku data:connectors:create
heroku data:connectors:destroy [CONNECTOR]
heroku data:connectors:info [CONNECTOR]
heroku data:connectors:pause [CONNECTOR]
heroku data:connectors:resume [CONNECTOR]
heroku data:connectors:update [CONNECTOR]
heroku data:connectors:wait [CONNECTOR]
heroku data:enhanced-certificates:disable [ADDON]
heroku data:enhanced-certificates:enable [ADDON]
heroku data:enhanced-certificates:status [ADDON]
heroku data:labs:disable [FEATURE]
heroku data:labs:enable [FEATURE]
heroku data:labs:list [ADDON]
heroku data:connectors
List all Data Connectors for a particular app or addon
USAGE
$ heroku data:connectors
OPTIONS
-a, --app=app app to run command against
-r, --remote=remote git remote of app to use
--addon=addon The ID or name for the addon your connector is attached to
--json Return the results as JSON
--table Return the results as a table
DESCRIPTION
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors
ALIASES
$ heroku data:connectors:list
EXAMPLES
heroku data:connectors -a your-app
heroku data:connectors --app=your-app --json
heroku data:connectors --addon=your-postgres-addon --table
See code: src/commands/data/connectors/index.ts
heroku data:connectors:create
create a new Data Connector
USAGE
$ heroku data:connectors:create
OPTIONS
-a, --app=app app to run command against
-t, --table=table (required) Tables to include
--exclude-column=exclude-column Columns to exclude
--name=name Name of the connector
--source=source (required) The name of the database add-on whose change data you want to store
--store=store (required) The name of the database add-on that will store the change data
DESCRIPTION
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors
EXAMPLES
$ heroku data:connectors:create --store kafka-lovely-12345 --source postgresql-neato-98765 --table public.posts
--table public.comments
$ heroku data:connectors:create --store kafka-lovely-12345 --source postgresql-neato-98765 --table public.users
--exclude-column public.users.password
See code: src/commands/data/connectors/create.ts
heroku data:connectors:destroy [CONNECTOR]
Destroy a Data Connector
USAGE
$ heroku data:connectors:destroy [CONNECTOR]
OPTIONS
--confirm=confirm confirms destroying the connector if passed in
DESCRIPTION
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors
EXAMPLES
$ heroku data:connectors:destroy gentle-connector-1234
$ heroku data:connectors:destroy gentle-connector-1234 --confirm gentle-connector-1234
See code: src/commands/data/connectors/destroy.ts
heroku data:connectors:info [CONNECTOR]
Get information about a Data Connector
USAGE
$ heroku data:connectors:info [CONNECTOR]
OPTIONS
--json Return the results as JSON
DESCRIPTION
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors
EXAMPLES
$ heroku data:connectors:info gentle-connector-1234
$ heroku data:connectors:info gentle-connector-1234 --json
See code: src/commands/data/connectors/info.ts
heroku data:connectors:pause [CONNECTOR]
Pause change event creation on a Data Connector
USAGE
$ heroku data:connectors:pause [CONNECTOR]
DESCRIPTION
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors
EXAMPLE
$ heroku data:connectors:pause gentle-connector-1234
See code: src/commands/data/connectors/pause.ts
heroku data:connectors:resume [CONNECTOR]
Resume change event creation on a Data Connector
USAGE
$ heroku data:connectors:resume [CONNECTOR]
DESCRIPTION
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors
EXAMPLE
$ heroku data:connectors:resume gentle-connector-1234
See code: src/commands/data/connectors/resume.ts
heroku data:connectors:update [CONNECTOR]
Update the settings, tables, and columns to exclude for a Data Connector
USAGE
$ heroku data:connectors:update [CONNECTOR]
OPTIONS
--add-table=add-table Tables to add
--exclude-column=exclude-column Columns to exclude
--remove-excluded-column=remove-excluded-column Columns to no longer exclude
--remove-table=remove-table Tables to remove
--setting=setting
DESCRIPTION
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors#update-configuration
EXAMPLE
$ 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
See code: src/commands/data/connectors/update.ts
heroku data:connectors:wait [CONNECTOR]
Wait for your Data Connector to be provisioned
USAGE
$ heroku data:connectors:wait [CONNECTOR]
DESCRIPTION
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors
EXAMPLE
$ heroku data:connectors:wait gentle-connector-1234
See code: src/commands/data/connectors/wait.ts
heroku data:enhanced-certificates:disable [ADDON]
Disable enhanced certificates on an Addon
USAGE
$ heroku data:enhanced-certificates:disable [ADDON]
OPTIONS
-a, --app=app app to run command against
DESCRIPTION
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-enhanced-certificates
See code: src/commands/data/enhanced-certificates/disable.ts
heroku data:enhanced-certificates:enable [ADDON]
Enable enhanced certificates on an Addon
USAGE
$ heroku data:enhanced-certificates:enable [ADDON]
OPTIONS
-a, --app=app app to run command against
DESCRIPTION
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-enhanced-certificates
EXAMPLE
$ heroku data:enhanced-certificates:enable happy-postgres-1234 -a example-app
See code: src/commands/data/enhanced-certificates/enable.ts
heroku data:enhanced-certificates:status [ADDON]
Get the status of Enhanced Certificates
USAGE
$ heroku data:enhanced-certificates:status [ADDON]
OPTIONS
-a, --app=app app to run command against
--json Return the results as JSON
DESCRIPTION
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-enhanced-certificates
See code: src/commands/data/enhanced-certificates/status.ts
heroku data:labs:disable [FEATURE]
Disable experimental features on an addon
USAGE
$ heroku data:labs:disable [FEATURE]
OPTIONS
-a, --app=app app to run command against
--addon=addon (required) The addon you want to disable features on
EXAMPLE
$ heroku data:labs:disable wal-compression --addon=happy-postgres-1234 -a example-app
See code: src/commands/data/labs/disable.ts
heroku data:labs:enable [FEATURE]
Enable experimental features on an addon
USAGE
$ heroku data:labs:enable [FEATURE]
OPTIONS
-a, --app=app app to run command against
--addon=addon (required) The addon you want to enable features on
EXAMPLE
$ heroku data:labs:enable wal-compression --addon=happy-postgres-1234 -a example-app
See code: src/commands/data/labs/enable.ts
heroku data:labs:list [ADDON]
List available experimental features on an addon and their statuses
USAGE
$ heroku data:labs:list [ADDON]
OPTIONS
-a, --app=app app to run command against
EXAMPLE
$ heroku data:labs:list happy-postgres-1234
See code: src/commands/data/labs/list.ts