@heroku-cli/plugin-data
v2.0.0
Published
A Heroku CLI Plugin for managing Heroku Data
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:connectorsheroku data:connectors:createheroku data:connectors:destroy CONNECTORheroku data:connectors:info CONNECTORheroku data:connectors:listheroku data:connectors:pause CONNECTORheroku data:connectors:resume CONNECTORheroku data:connectors:update CONNECTORheroku data:connectors:wait CONNECTORheroku data:enhanced-certificates:disable ADDONheroku data:enhanced-certificates:enable ADDONheroku data:enhanced-certificates:status ADDONheroku data:labs:disable FEATUREheroku data:labs:enable FEATUREheroku data:labs:list ADDON
heroku data:connectors
List all Data Connectors for a particular app or addon
USAGE
$ heroku data:connectors [--addon <value>] [-a <value>] [--json | --table] [-r <value>]
FLAGS
-a, --app=<value> app to run command against
-r, --remote=<value> git remote of app to use
--addon=<value> 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
List all Data Connectors for a particular app or addon
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 --tableSee code: src/commands/data/connectors/index.ts
heroku data:connectors:create
create a new Data Connector
USAGE
$ heroku data:connectors:create --source <value> --store <value> -t <value>... [-a <value>] [--exclude-column <value>...]
[--name <value>]
FLAGS
-a, --app=<value> app to run command against
-t, --table=<value>... (required) Tables to include
--exclude-column=<value>... Columns to exclude
--name=<value> Name of the connector
--source=<value> (required) The name of the database add-on whose change data you want to store
--store=<value> (required) The name of the database add-on that will store the change data
DESCRIPTION
create a new Data Connector
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.passwordSee code: src/commands/data/connectors/create.ts
heroku data:connectors:destroy CONNECTOR
Destroy a Data Connector
USAGE
$ heroku data:connectors:destroy CONNECTOR [--confirm <value>]
ARGUMENTS
CONNECTOR name of the connector
FLAGS
--confirm=<value> confirms destroying the connector if passed in
DESCRIPTION
Destroy a Data Connector
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-1234See code: src/commands/data/connectors/destroy.ts
heroku data:connectors:info CONNECTOR
Get information about a Data Connector
USAGE
$ heroku data:connectors:info CONNECTOR [--json]
ARGUMENTS
CONNECTOR name of the connector
FLAGS
--json Return the results as JSON
DESCRIPTION
Get information about a Data Connector
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 --jsonSee code: src/commands/data/connectors/info.ts
heroku data:connectors:list
List all Data Connectors for a particular app or addon
USAGE
$ heroku data:connectors:list [--addon <value>] [-a <value>] [--json | --table] [-r <value>]
FLAGS
-a, --app=<value> app to run command against
-r, --remote=<value> git remote of app to use
--addon=<value> 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
List all Data Connectors for a particular app or addon
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 --tableheroku data:connectors:pause CONNECTOR
Pause change event creation on a Data Connector
USAGE
$ heroku data:connectors:pause CONNECTOR
ARGUMENTS
CONNECTOR name of the connector
DESCRIPTION
Pause change event creation on a Data Connector
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors
EXAMPLES
$ heroku data:connectors:pause gentle-connector-1234See 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
ARGUMENTS
CONNECTOR name of the connector
DESCRIPTION
Resume change event creation on a Data Connector
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors
EXAMPLES
$ heroku data:connectors:resume gentle-connector-1234See 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 [--setting <value>...] [--add-table <value>...] [--remove-table <value>...]
[--exclude-column <value>...] [--remove-excluded-column <value>...]
ARGUMENTS
CONNECTOR name of the connector
FLAGS
--add-table=<value>... Tables to add
--exclude-column=<value>... Columns to exclude
--remove-excluded-column=<value>... Columns to no longer exclude
--remove-table=<value>... Tables to remove
--setting=<value>...
DESCRIPTION
Update the settings, tables, and columns to exclude for a Data Connector
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors#update-configuration
EXAMPLES
$ 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.keySee 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
ARGUMENTS
CONNECTOR name of the connector
DESCRIPTION
Wait for your Data Connector to be provisioned
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors
EXAMPLES
$ heroku data:connectors:wait gentle-connector-1234See 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 [-a <value>]
ARGUMENTS
ADDON name of the addon
FLAGS
-a, --app=<value> app to run command against
DESCRIPTION
Disable enhanced certificates on an Addon
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-enhanced-certificatesSee 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 [-a <value>]
ARGUMENTS
ADDON name of the addon
FLAGS
-a, --app=<value> app to run command against
DESCRIPTION
Enable enhanced certificates on an Addon
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-enhanced-certificates
EXAMPLES
$ heroku data:enhanced-certificates:enable happy-postgres-1234 -a example-appSee 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 [-a <value>] [--json]
ARGUMENTS
ADDON name of the addon
FLAGS
-a, --app=<value> app to run command against
--json Return the results as JSON
DESCRIPTION
Get the status of Enhanced Certificates
Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-enhanced-certificatesSee 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 --addon <value> [-a <value>]
ARGUMENTS
FEATURE name of the feature
FLAGS
-a, --app=<value> app to run command against
--addon=<value> (required) The addon you want to disable features on
DESCRIPTION
Disable experimental features on an addon
EXAMPLES
$ heroku data:labs:disable wal-compression --addon=happy-postgres-1234 -a example-appSee code: src/commands/data/labs/disable.ts
heroku data:labs:enable FEATURE
Enable experimental features on an addon
USAGE
$ heroku data:labs:enable FEATURE --addon <value> [-a <value>]
ARGUMENTS
FEATURE name of the feature
FLAGS
-a, --app=<value> app to run command against
--addon=<value> (required) The addon you want to enable features on
DESCRIPTION
Enable experimental features on an addon
EXAMPLES
$ heroku data:labs:enable wal-compression --addon=happy-postgres-1234 -a example-appSee 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 [-a <value>]
ARGUMENTS
ADDON name of the addon
FLAGS
-a, --app=<value> app to run command against
DESCRIPTION
List available experimental features on an addon and their statuses
EXAMPLES
$ heroku data:labs:list happy-postgres-1234See code: src/commands/data/labs/list.ts
